Files @ 89a548ea164b
Branch filter:

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

89a548ea164b 1.7 KiB text/prs.fallenstein.rst Show Source Show as Raw Download as Raw
Mads Kiilerich
utils: when building a Mercurial ui object with configuration, don't use 'None' for NULL values

If Ui had an entry with
ui_section='extensions', ui_key='largefiles', ui_value=NULL
it would be passed to Mercurial as if the .ini file had
[extensions]
largefiles = None
and it would fail to load the largefiles extension because it couldn't find
'./None/'.

Note: get_current_revision might currently mask this problem. It will not get
the Ui from the database and will thus read a normal .ini file from the system
and (if configured) read the largefiles extension from the default location.
That will make the largefiles extension available for later largefiles imports
even if they specify the bogus path.

As f8a714c2c5a1 noted in a FIXME: ui_value should perhaps not be nullable.

For now, just handle NULL in extension configuration.
.. _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::

    paster make-rcext 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.