[PATCH 1 of 3] docs: move all instructions on Celery to Setup

Thomas De Schampheleire patrickdepinguin at gmail.com
Tue Mar 17 15:54:38 EDT 2015


# HG changeset patch
# User Thomas De Schampheleire <thomas.de.schampheleire at gmail.com>
# Date 1426621620 -3600
#      Tue Mar 17 20:47:00 2015 +0100
# Node ID ec7899cb95c051cc5957c37e67c5ffeb56400591
# Parent  7c952ea3d7b3ce2192b285fc28ab2ccddee53402
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.

diff --git a/docs/installation.rst b/docs/installation.rst
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -4,7 +4,7 @@
 Installation on Unix/Linux
 ==========================
 
-**Kallithea** is written entirely in Python and requires Python version
+**Kallithea** is written entirely in Python_ and requires Python version
 2.6 or higher. Python 3.x is currently not supported.
 
 There are several ways to install Kallithea:
@@ -113,44 +113,6 @@
 
 You can now proceed to :ref:`setup`.
 
-Celery (optional)
------------------
-
-In order to gain maximum performance
-there are some third-party you must install. When Kallithea is used
-together with celery you have to install some kind of message broker,
-recommended one is rabbitmq_ to make the async tasks work.
-
-Of course Kallithea works in sync mode also and then you do not have to install
-any third party applications. However, using Celery_ will give you a large
-speed improvement when using many big repositories. If you plan to use
-Kallithea for say 7 to 10 repositories, Kallithea will perform perfectly well
-without celery running.
-
-If you make the decision to run Kallithea with celery make sure you run
-celeryd using paster and message broker together with the application.
-
-.. note::
-   Installing message broker and using celery is optional, Kallithea will
-   work perfectly fine without them.
-
-
-**Message Broker**
-
-- preferred is `RabbitMq <http://www.rabbitmq.com/>`_
-- A possible alternative is `Redis <http://code.google.com/p/redis/>`_
-
-For installation instructions you can visit:
-http://ask.github.com/celery/getting-started/index.html.
-This is a very nice tutorial on how to start using celery_ with rabbitmq_
-
-
-Next
-----
-
-You can now proceed to :ref:`setup`.
-
-
 Upgrading Kallithea from Python Package Index (PyPI)
 -----------------------------------------------------
 
@@ -245,7 +207,4 @@
 
 
 .. _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/
+.. _Python: http://www.python.org/
diff --git a/docs/setup.rst b/docs/setup.rst
--- a/docs/setup.rst
+++ b/docs/setup.rst
@@ -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,26 @@
 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.
+If you plan to use Kallithea for, say, 7 to 10 repositories, Kallithea will
+perform perfectly well out of the box. When using many big repositories,
+however, performance can be greatly improved by enabling Celery_, a distributed
+task queue.  When Kallithea is used together with Celery, you also have to
+install a message broker, 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.
+For installation instructions, see the `Celery documentation`_.
 
-In order to start using celery run::
+Celery is configured in the Kallithea ini configuration file.
+Simply set::
+
+ use_celery = true
+
+and add or change the cellery.* 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.
+
+In order to start using Celery run::
 
  paster celeryd <configfile.ini>
 
@@ -757,8 +768,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


More information about the kallithea-general mailing list