diff docs/setup.rst @ 4925:56cd202b777e

docs: move all instructions on Celery to Setup Instead of having some info on Celery in both Installation and Setup, move everything to Setup and do some rewrite. Additionally, update some outdated URLs and remove unused link targets.
author Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
date Tue, 17 Mar 2015 20:47:00 +0100
parents 6892b0515af9
children 4e6dfdb3fa01
line wrap: on
line diff
--- a/docs/setup.rst	Sun Mar 15 22:08:54 2015 +0100
+++ b/docs/setup.rst	Tue Mar 17 20:47:00 2015 +0100
@@ -15,7 +15,7 @@
 
 - This will create the file `my.ini` in the current directory. This
   configuration file contains the various settings for Kallithea, e.g proxy
-  port, email settings, usage of static files, cache, celery settings and
+  port, email settings, usage of static files, cache, Celery settings and
   logging.
 
 
@@ -496,15 +496,30 @@
 Celery configuration
 --------------------
 
-Celery is configured in the Kallithea ini configuration files.
-Simply set use_celery=true in the ini file then add / change the configuration
-variables inside the ini file.
+Kallithea can use the distributed task queue system Celery_ to run tasks like
+cloning repositories or sending mails.
+
+Kallithea will in most setups work perfectly fine out of the box (without
+Celery), executing all tasks in the web server process. Some tasks can however
+take some time to run and it can be better to run such tasks asynchronously in
+a separate process so the web server can focus on serving web requests.
+
+For installation and configuration of Celery, see the `Celery documentation`_.
+Note that Celery requires a message broker service like RabbitMQ_ (recommended)
+or Redis_.
 
-Remember that the ini files use the format with '.' not with '_' like celery.
-So for example setting `BROKER_HOST` in celery means setting `broker.host` in
-the config file.
+The use of Celery is configured in the Kallithea ini configuration file.
+To enable it, simply set::
+
+ use_celery = true
 
-In order to start using celery run::
+and add or change the celery.* and broker.* configuration variables.
+
+Remember that the ini files use the format with '.' and not with '_' like
+Celery. So for example setting `BROKER_HOST` in Celery means setting
+`broker.host` in the configuration file.
+
+To start the Celery process, run::
 
  paster celeryd <configfile.ini>
 
@@ -757,8 +772,10 @@
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _Mercurial: http://mercurial.selenic.com/
-.. _celery: http://celeryproject.org/
-.. _rabbitmq: http://www.rabbitmq.com/
+.. _Celery: http://celeryproject.org/
+.. _Celery documentation: http://docs.celeryproject.org/en/latest/getting-started/index.html
+.. _RabbitMQ: http://www.rabbitmq.com/
+.. _Redis: http://redis.io/
 .. _python-ldap: http://www.python-ldap.org/
 .. _mercurial-server: http://www.lshift.net/mercurial-server.html
 .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories