Files
@ df275f701d53
Branch filter:
Location: kallithea/docs/usage/customization.rst - annotation
df275f701d53
2.5 KiB
text/prs.fallenstein.rst
git: exit early if Git is found but too old (Issue #342)
The warning in the logs were too easy to miss.
It is still OK if git isn't found at all... for example if git_path
configuration doesn't point at something that looks like git.
The git_path configuration already had no default, so just make the code path
for that case more clean. (An easy next/alternative step could be to remove git
from BACKENDS if it isn't configured ...)
The system exit is similar to what is done in 0e33880b2897 ... even though
exiting from from a library might be a bit worse ...
The warning in the logs were too easy to miss.
It is still OK if git isn't found at all... for example if git_path
configuration doesn't point at something that looks like git.
The git_path configuration already had no default, so just make the code path
for that case more clean. (An easy next/alternative step could be to remove git
from BACKENDS if it isn't configured ...)
The system exit is similar to what is done in 0e33880b2897 ... even though
exiting from from a library might be a bit worse ...
60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 8152f9e6a778 8152f9e6a778 8152f9e6a778 8152f9e6a778 8152f9e6a778 3b54bcf6d128 3b54bcf6d128 3b54bcf6d128 3b54bcf6d128 3b54bcf6d128 8152f9e6a778 b66725ba01ed b66725ba01ed 8152f9e6a778 b66725ba01ed 8152f9e6a778 8152f9e6a778 8152f9e6a778 8152f9e6a778 8152f9e6a778 8152f9e6a778 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 60f9840c8df1 f9c8fec48185 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*.
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
.. _bootstrap 3: https://getbootstrap.com/docs/3.3/
.. _bootstrap variables: https://getbootstrap.com/docs/3.3/customize/#less-variables
.. _less: http://lesscss.org/
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.
|