##// END OF EJS Templates
docs: give "File system location" overview...
docs: give "File system location" overview Also make some other adjustments for consistency.

File last commit:

r7751:3b54bcf6 default
r8384:c354d1a7 default
Show More
customization.rst
71 lines | 2.5 KiB | text/x-rst | RstLexer

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.

Style sheet customization with Less

Kallithea uses Bootstrap 3 and Less for its style definitions. If you want to make some customizations, we recommend to do so by creating a theme.less file. When you create a file named theme.less in directory kallithea/front-end/ inside the Kallithea installation, you can use this file to override the default style. For example, you can use this to override @kallithea-theme-main-color, @kallithea-logo-url or other Bootstrap variables.

After creating the theme.less file, you need to regenerate the CSS files, by running:

kallithea-cli front-end-build --no-install-deps

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:

kallithea-cli extensions-create -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.