Show More
@@ -0,0 +1,50 b'' | |||||
|
1 | .. _customization: | |||
|
2 | ||||
|
3 | ============= | |||
|
4 | Customization | |||
|
5 | ============= | |||
|
6 | ||||
|
7 | There are several ways to customize Kallithea to your needs depending on what | |||
|
8 | you want to achieve. | |||
|
9 | ||||
|
10 | ||||
|
11 | HTML/JavaScript/CSS customization | |||
|
12 | --------------------------------- | |||
|
13 | ||||
|
14 | To customize the look-and-feel of the web interface (for example to add a | |||
|
15 | company banner or some JavaScript widget or to tweak the CSS style definitions) | |||
|
16 | you can enter HTML code (possibly with JavaScript and/or CSS) directly via the | |||
|
17 | *Admin > Settings > Global > HTML/JavaScript customization | |||
|
18 | block*. | |||
|
19 | ||||
|
20 | ||||
|
21 | Behavioral customization: rcextensions | |||
|
22 | -------------------------------------- | |||
|
23 | ||||
|
24 | Some behavioral customization can be done in Python using ``rcextensions``, a | |||
|
25 | custom Python package that can extend Kallithea functionality. | |||
|
26 | ||||
|
27 | With ``rcextensions`` it's possible to add additional mappings for Whoosh | |||
|
28 | indexing and statistics, to add additional code into the push/pull/create/delete | |||
|
29 | repository hooks (for example to send signals to build bots such as Jenkins) and | |||
|
30 | even to monkey-patch certain parts of the Kallithea source code (for example | |||
|
31 | overwrite an entire function, change a global variable, ...). | |||
|
32 | ||||
|
33 | To generate a skeleton extensions package, run:: | |||
|
34 | ||||
|
35 | paster make-rcext my.ini | |||
|
36 | ||||
|
37 | This will create an ``rcextensions`` package next to the specified ``ini`` file. | |||
|
38 | See the ``__init__.py`` file inside the generated ``rcextensions`` package | |||
|
39 | for more details. | |||
|
40 | ||||
|
41 | ||||
|
42 | Behavioral customization: code changes | |||
|
43 | -------------------------------------- | |||
|
44 | ||||
|
45 | As Kallithea is open-source software, you can make any changes you like directly | |||
|
46 | in the source code. | |||
|
47 | ||||
|
48 | We encourage you to send generic improvements back to the | |||
|
49 | community so that Kallithea can become better. See :ref:`contributing` for more | |||
|
50 | details. |
@@ -44,6 +44,7 b' Kallithea Documentation' | |||||
44 | usage/backup |
|
44 | usage/backup | |
45 | usage/debugging |
|
45 | usage/debugging | |
46 | usage/troubleshooting |
|
46 | usage/troubleshooting | |
|
47 | usage/customization | |||
47 |
|
48 | |||
48 | **Development** |
|
49 | **Development** | |
49 |
|
50 |
@@ -67,24 +67,6 b' You are now ready to use Kallithea. To r' | |||||
67 | repositories. |
|
67 | repositories. | |
68 |
|
68 | |||
69 |
|
69 | |||
70 | Extensions |
|
|||
71 | ---------- |
|
|||
72 |
|
||||
73 | Optionally one can create an ``rcextensions`` package that extends Kallithea |
|
|||
74 | functionality. |
|
|||
75 | To generate a skeleton extensions package, run:: |
|
|||
76 |
|
||||
77 | paster make-rcext my.ini |
|
|||
78 |
|
||||
79 | This will create an ``rcextensions`` package next to the specified ``ini`` file. |
|
|||
80 | With ``rcextensions`` it's possible to add additional mapping for whoosh, |
|
|||
81 | stats and add additional code into the push/pull/create/delete repo hooks, |
|
|||
82 | for example for sending signals to build-bots such as Jenkins. |
|
|||
83 |
|
||||
84 | See the ``__init__.py`` file inside the generated ``rcextensions`` package |
|
|||
85 | for more details. |
|
|||
86 |
|
||||
87 |
|
||||
88 | Using Kallithea with SSH |
|
70 | Using Kallithea with SSH | |
89 | ------------------------ |
|
71 | ------------------------ | |
90 |
|
72 |
General Comments 0
You need to be logged in to leave comments.
Login now