Files @ b9853a3cc254
Branch filter:

Location: kallithea/docs/usage/customization.rst - annotation

b9853a3cc254 1.7 KiB text/prs.fallenstein.rst Show Source Show as Raw Download as Raw
domruf
celery: simplify internal configuration and app creation

We used celery.app.app_or_default() which creates a "global fallback app
instance" which relies on the CELERY_LOADER environment variable to load the
configuration. That worked but was messy.

Instead, do something more like described in
http://docs.celeryproject.org/en/3.1/userguide/application.html where the app
is a celery.Celery() instance and configuration is loaded explicitly by its
config_from_object method. Using config_from_object we don't need explicit
invocation of import_default_modules and can take pass PylonsSettingsProxy
directly, leaving PylonsLoader unused and removed.

Modified by Mads Kiilerich.
.. _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.