kallithea Changeset - 60f9840c8df1

Changeset - 60f9840c8df1

Parent rev.

Child rev.

[Not reviewed]

default

0 2 1

Thomas De Schampheleire - 10 years ago 2016-03-14 22:13:19
thomas.de.schampheleire@gmail.com

docs: document Kallithea customization options

Create basic documentation for the various customization options in
Kallithea. Move the rcextensions section to this new page and reword.

3 files changed with 51 insertions and 18 deletions:

docs/index.rst

docs/setup.rst

docs/usage/customization.rst

0 comments (0 inline, 0 general)

docs/index.rst

➞

Show inline comments

@@ @@ -35,24 +35,25 @@ Kallithea Documentation @@
    usage/statistics
 **Administrator's guide**
 .. toctree::
    :maxdepth: 1
    usage/email
    usage/performance
    usage/backup
    usage/debugging
    usage/troubleshooting
    usage/customization
 **Development**
 .. toctree::
    :maxdepth: 1
    contributing
    changelog
 **API**
 .. toctree::

docs/setup.rst

➞

Show inline comments

@@ @@ -58,42 +58,24 @@ You are now ready to use Kallithea. To r @@
 - This command runs the Kallithea server. The web app should be available at
   http://127.0.0.1:5000. The IP address and port is configurable via the
   configuration file created in the previous step.
 - Log in to Kallithea using the admin account created when running ``setup-db``.
 - The default permissions on each repository is read, and the owner is admin.
   Remember to update these if needed.
 - In the admin panel you can toggle LDAP, anonymous, and permissions
   settings, as well as edit more advanced options on users and
   repositories.
 Extensions
 ----------
 Optionally one can create an ``rcextensions`` package that extends Kallithea
 functionality.
 To generate a skeleton extensions package, run::
     paster make-rcext my.ini
 This will create an ``rcextensions`` package next to the specified ``ini`` file.
 With ``rcextensions`` it's possible to add additional mapping for whoosh,
 stats and add additional code into the push/pull/create/delete repo hooks,
 for example for sending signals to build-bots such as Jenkins.
 See the ``__init__.py`` file inside the generated ``rcextensions`` package
 for more details.
 Using Kallithea with SSH
 ------------------------
 Kallithea currently only hosts repositories using http and https. (The addition
 of ssh hosting is a planned future feature.) However you can easily use ssh in
 parallel with Kallithea. (Repository access via ssh is a standard "out of
 the box" feature of Mercurial_ and you can use this to access any of the
 repositories that Kallithea is hosting. See PublishingRepositories_)
 Kallithea repository structures are kept in directories with the same name
 as the project. When using repository groups, each group is a subdirectory.
 This allows you to easily use ssh for accessing repositories.

docs/usage/customization.rst

➞

Show inline comments

@@ new file 100644 @@
 .. _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.

0 comments (0 inline, 0 general)