Show More
@@ -4,7 +4,7 b'' | |||||
4 | Installation on Unix/Linux |
|
4 | Installation on Unix/Linux | |
5 | ========================== |
|
5 | ========================== | |
6 |
|
6 | |||
7 | **Kallithea** is written entirely in Python and requires Python version |
|
7 | **Kallithea** is written entirely in Python_ and requires Python version | |
8 | 2.6 or higher. Python 3.x is currently not supported. |
|
8 | 2.6 or higher. Python 3.x is currently not supported. | |
9 |
|
9 | |||
10 | There are several ways to install Kallithea: |
|
10 | There are several ways to install Kallithea: | |
@@ -113,44 +113,6 b' To install as a regular user in ``~/.loc' | |||||
113 |
|
113 | |||
114 | You can now proceed to :ref:`setup`. |
|
114 | You can now proceed to :ref:`setup`. | |
115 |
|
115 | |||
116 | Celery (optional) |
|
|||
117 | ----------------- |
|
|||
118 |
|
||||
119 | In order to gain maximum performance |
|
|||
120 | there are some third-party you must install. When Kallithea is used |
|
|||
121 | together with celery you have to install some kind of message broker, |
|
|||
122 | recommended one is rabbitmq_ to make the async tasks work. |
|
|||
123 |
|
||||
124 | Of course Kallithea works in sync mode also and then you do not have to install |
|
|||
125 | any third party applications. However, using Celery_ will give you a large |
|
|||
126 | speed improvement when using many big repositories. If you plan to use |
|
|||
127 | Kallithea for say 7 to 10 repositories, Kallithea will perform perfectly well |
|
|||
128 | without celery running. |
|
|||
129 |
|
||||
130 | If you make the decision to run Kallithea with celery make sure you run |
|
|||
131 | celeryd using paster and message broker together with the application. |
|
|||
132 |
|
||||
133 | .. note:: |
|
|||
134 | Installing message broker and using celery is optional, Kallithea will |
|
|||
135 | work perfectly fine without them. |
|
|||
136 |
|
||||
137 |
|
||||
138 | **Message Broker** |
|
|||
139 |
|
||||
140 | - preferred is `RabbitMq <http://www.rabbitmq.com/>`_ |
|
|||
141 | - A possible alternative is `Redis <http://code.google.com/p/redis/>`_ |
|
|||
142 |
|
||||
143 | For installation instructions you can visit: |
|
|||
144 | http://ask.github.com/celery/getting-started/index.html. |
|
|||
145 | This is a very nice tutorial on how to start using celery_ with rabbitmq_ |
|
|||
146 |
|
||||
147 |
|
||||
148 | Next |
|
|||
149 | ---- |
|
|||
150 |
|
||||
151 | You can now proceed to :ref:`setup`. |
|
|||
152 |
|
||||
153 |
|
||||
154 | Upgrading Kallithea from Python Package Index (PyPI) |
|
116 | Upgrading Kallithea from Python Package Index (PyPI) | |
155 | ----------------------------------------------------- |
|
117 | ----------------------------------------------------- | |
156 |
|
118 | |||
@@ -245,7 +207,4 b' Or::' | |||||
245 |
|
207 | |||
246 |
|
208 | |||
247 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
|
209 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv | |
248 |
.. _ |
|
210 | .. _Python: http://www.python.org/ | |
249 | .. _mercurial: http://mercurial.selenic.com/ |
|
|||
250 | .. _celery: http://celeryproject.org/ |
|
|||
251 | .. _rabbitmq: http://www.rabbitmq.com/ |
|
@@ -15,7 +15,7 b' following command to do this::' | |||||
15 |
|
15 | |||
16 | - This will create the file `my.ini` in the current directory. This |
|
16 | - This will create the file `my.ini` in the current directory. This | |
17 | configuration file contains the various settings for Kallithea, e.g proxy |
|
17 | configuration file contains the various settings for Kallithea, e.g proxy | |
18 |
port, email settings, usage of static files, cache, |
|
18 | port, email settings, usage of static files, cache, Celery settings and | |
19 | logging. |
|
19 | logging. | |
20 |
|
20 | |||
21 |
|
21 | |||
@@ -496,15 +496,30 b' when there are encode/decode errors.' | |||||
496 | Celery configuration |
|
496 | Celery configuration | |
497 | -------------------- |
|
497 | -------------------- | |
498 |
|
498 | |||
499 | Celery is configured in the Kallithea ini configuration files. |
|
499 | Kallithea can use the distributed task queue system Celery_ to run tasks like | |
500 | Simply set use_celery=true in the ini file then add / change the configuration |
|
500 | cloning repositories or sending mails. | |
501 | variables inside the ini file. |
|
501 | ||
|
502 | Kallithea will in most setups work perfectly fine out of the box (without | |||
|
503 | Celery), executing all tasks in the web server process. Some tasks can however | |||
|
504 | take some time to run and it can be better to run such tasks asynchronously in | |||
|
505 | a separate process so the web server can focus on serving web requests. | |||
|
506 | ||||
|
507 | For installation and configuration of Celery, see the `Celery documentation`_. | |||
|
508 | Note that Celery requires a message broker service like RabbitMQ_ (recommended) | |||
|
509 | or Redis_. | |||
502 |
|
510 | |||
503 | Remember that the ini files use the format with '.' not with '_' like celery. |
|
511 | The use of Celery is configured in the Kallithea ini configuration file. | |
504 | So for example setting `BROKER_HOST` in celery means setting `broker.host` in |
|
512 | To enable it, simply set:: | |
505 | the config file. |
|
513 | ||
|
514 | use_celery = true | |||
506 |
|
515 | |||
507 | In order to start using celery run:: |
|
516 | and add or change the celery.* and broker.* configuration variables. | |
|
517 | ||||
|
518 | Remember that the ini files use the format with '.' and not with '_' like | |||
|
519 | Celery. So for example setting `BROKER_HOST` in Celery means setting | |||
|
520 | `broker.host` in the configuration file. | |||
|
521 | ||||
|
522 | To start the Celery process, run:: | |||
508 |
|
523 | |||
509 | paster celeryd <configfile.ini> |
|
524 | paster celeryd <configfile.ini> | |
510 |
|
525 | |||
@@ -757,8 +772,10 b' Some example init.d scripts can be found' | |||||
757 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
|
772 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv | |
758 | .. _python: http://www.python.org/ |
|
773 | .. _python: http://www.python.org/ | |
759 | .. _Mercurial: http://mercurial.selenic.com/ |
|
774 | .. _Mercurial: http://mercurial.selenic.com/ | |
760 |
.. _ |
|
775 | .. _Celery: http://celeryproject.org/ | |
761 | .. _rabbitmq: http://www.rabbitmq.com/ |
|
776 | .. _Celery documentation: http://docs.celeryproject.org/en/latest/getting-started/index.html | |
|
777 | .. _RabbitMQ: http://www.rabbitmq.com/ | |||
|
778 | .. _Redis: http://redis.io/ | |||
762 | .. _python-ldap: http://www.python-ldap.org/ |
|
779 | .. _python-ldap: http://www.python-ldap.org/ | |
763 | .. _mercurial-server: http://www.lshift.net/mercurial-server.html |
|
780 | .. _mercurial-server: http://www.lshift.net/mercurial-server.html | |
764 | .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories |
|
781 | .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories |
General Comments 0
You need to be logged in to leave comments.
Login now