Files
@ cddff7f0dd08
Branch filter:
Location: kallithea/docs/usage/customization.rst - annotation
cddff7f0dd08
1.7 KiB
text/prs.fallenstein.rst
tests: use temporary copy of test.ini, possibly customized for TEST_DB
It was an undocumented feature that if setting the environment variable
TEST_DB, that would be used for tests instead of the default
kallithea/tests/test.ini sqlalchemy.url . That did however not work for Git
hooks and tests would fail.
Instead, create a copy of test.ini in the temp folder and use that for testing.
If TEST_DB is set, edit the file so the specified DB URL is used. This fixes
Git hook related tests if TEST_DB is used.
Since this also changes the path of %(here)s to the temporary location, just
use the default paths.
This also has the advantage that the data folders are now in the temp folder
as well. Therefore a broken data folder, from a past run, can no longer
influence a test.
It was an undocumented feature that if setting the environment variable
TEST_DB, that would be used for tests instead of the default
kallithea/tests/test.ini sqlalchemy.url . That did however not work for Git
hooks and tests would fail.
Instead, create a copy of test.ini in the temp folder and use that for testing.
If TEST_DB is set, edit the file so the specified DB URL is used. This fixes
Git hook related tests if TEST_DB is used.
Since this also changes the path of %(here)s to the temporary location, just
use the default paths.
This also has the advantage that the data folders are now in the temp folder
as well. Therefore a broken data folder, from a past run, can no longer
influence a test.
60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 2c3d30095d5e 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 | .. _customization:
=============
Customization
=============
There are several ways to customize Kallithea to your needs depending on what
you want to achieve.
HTML/JavaScript/CSS customization
---------------------------------
To customize the look-and-feel of the web interface (for example to add a
company banner or some JavaScript widget or to tweak the CSS style definitions)
you can enter HTML code (possibly with JavaScript and/or CSS) directly via the
*Admin > Settings > Global > HTML/JavaScript customization
block*.
Behavioral customization: rcextensions
--------------------------------------
Some behavioral customization can be done in Python using ``rcextensions``, a
custom Python package that can extend Kallithea functionality.
With ``rcextensions`` it's possible to add additional mappings for Whoosh
indexing and statistics, to add additional code into the push/pull/create/delete
repository hooks (for example to send signals to build bots such as Jenkins) and
even to monkey-patch certain parts of the Kallithea source code (for example
overwrite an entire function, change a global variable, ...).
To generate a skeleton extensions package, run::
gearbox make-rcext -c my.ini
This will create an ``rcextensions`` package next to the specified ``ini`` file.
See the ``__init__.py`` file inside the generated ``rcextensions`` package
for more details.
Behavioral customization: code changes
--------------------------------------
As Kallithea is open-source software, you can make any changes you like directly
in the source code.
We encourage you to send generic improvements back to the
community so that Kallithea can become better. See :ref:`contributing` for more
details.
|