Changeset - 56cd202b777e
Parent rev.
Child rev.
[Not reviewed]
default
0 2 0
Thomas De Schampheleire - 11 years ago 2015-03-17 20:47:00
thomas.de.schampheleire@gmail.com
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.
2 files changed with 29 insertions and 53 deletions:
docs/installation.rst
2
43
docs/setup.rst
27
10
0 comments (0 inline, 0 general)
docs/installation.rst
➞
Show inline comments
 
.. _installation:
 

			




	
	
	
		
 
==========================

			




	
	
	
		
 
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:

			




	
	
	
		
 

			




	
	
	
		
 
- :ref:`installation-source`: The Kallithea development repository is stable

			




	
	
	
		
 
  and can be used in production. In fact, the Kallithea maintainers do

			




	
	
	
		
 
  use it in production. The advantage of installation from source and regularly

			




	
	
	
		
 
  updating it is that you take advantage of the most recent improvements, which

			




	
	
	
		
 
  is particularly useful because Kallithea is evolving rapidly.

			




	
	
	
		
 

			




	
	
	
		
 
- :ref:`installation-virtualenv`: If you prefer to only use released versions

			




	
	
	
		
 
  of Kallithea, the recommended method is to install Kallithea in a virtual

			




	
	
		
 
@@ -104,62 +104,24 @@ For installation without virtualenv, 'ju

			




	
	
	
		
 

			




	
	
	
		
 
    pip install kallithea

			




	
	
	
		
 

			




	
	
	
		
 
Note that this method requires root privileges and will install packages

			




	
	
	
		
 
globally without using the system's package manager.

			




	
	
	
		
 

			




	
	
	
		
 
To install as a regular user in ``~/.local``, you can use::

			




	
	
	
		
 

			




	
	
	
		
 
    pip install --user kallithea

			




	
	
	
		
 

			




	
	
	
		
 
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)

			




	
	
	
		
 
-----------------------------------------------------

			




	
	
	
		
 

			




	
	
	
		
 
.. note::

			




	
	
	
		
 
   Firstly, it is recommended that you **always** perform a database and

			




	
	
	
		
 
   configuration backup before doing an upgrade.

			




	
	
	
		
 

			




	
	
	
		
 
   (These directions will use '{version}' to note that this is the version of

			




	
	
	
		
 
   Kallithea that these files were used with.  If backing up your Kallithea

			




	
	
	
		
 
   instance from version 0.1 to 0.2, the ``my.ini`` file could be

			




	
	
	
		
 
   backed up to ``my.ini.0-1``.)

			




	
	
	
		
 

			




	
	
		
 
@@ -236,16 +198,13 @@ Once that is complete, you may now start

			




	
	
	
		
 
 service kallithea start

			




	
	
	
		
 

			




	
	
	
		
 
Or::

			




	
	
	
		
 

			




	
	
	
		
 
 paster serve /srv/kallithea/my.ini

			




	
	
	
		
 

			




	
	
	
		
 
.. note::

			




	
	
	
		
 
   If you're using Celery, make sure you restart all instances of it after

			




	
	
	
		
 
   upgrade.

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
.. _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/

			




        

    


    
    

    

        

                

                    docs/setup.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -6,25 +6,25 @@ Setup

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Setting up Kallithea

			




	
	
	
		
 
--------------------

			




	
	
	
		
 

			




	
	
	
		
 
First, you will need to create a Kallithea configuration file. Run the

			




	
	
	
		
 
following command to do this::

			




	
	
	
		
 

			




	
	
	
		
 
    paster make-config Kallithea my.ini

			




	
	
	
		
 

			




	
	
	
		
 
- 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.

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Next, you need to create the databases used by Kallithea. It is recommended to

			




	
	
	
		
 
use PostgreSQL or SQLite (default). If you choose a database other than the

			




	
	
	
		
 
default ensure you properly adjust the database URL in your my.ini

			




	
	
	
		
 
configuration file to use this other database. Kallithea currently supports

			




	
	
	
		
 
PostgreSQL, SQLite and MySQL databases. Create the database by running

			




	
	
	
		
 
the following command::

			




	
	
	
		
 

			




	
	
	
		
 
    paster setup-db my.ini

			




	
	
	
		
 

			




	
	
		
 
@@ -487,33 +487,48 @@ Changing default encoding

			




	
	
	
		
 

			




	
	
	
		
 
By default, Kallithea uses UTF-8 encoding.

			




	
	
	
		
 
It is configurable as `default_encoding` in the .ini file.

			




	
	
	
		
 
This affects many parts in Kallithea including user names, filenames, and

			




	
	
	
		
 
encoding of commit messages. In addition Kallithea can detect if `chardet`

			




	
	
	
		
 
library is installed. If `chardet` is detected Kallithea will fallback to it

			




	
	
	
		
 
when there are encode/decode errors.

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
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>

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
.. note::

			




	
	
	
		
 
   Make sure you run this command from the same virtualenv, and with the same

			




	
	
	
		
 
   user that Kallithea runs.

			




	
	
	
		
 

			




	
	
	
		
 
HTTPS support

			




	
	
	
		
 
-------------

			




	
	
	
		
 

			




	
	
	
		
 
Kallithea will by default generate URLs based on the WSGI environment.

			




	
	
		
 
@@ -748,17 +763,19 @@ Or using proper virtualenv activation::

			




	
	
	
		
 
    from paste.deploy import loadapp

			




	
	
	
		
 
    application = loadapp('config:' + ini)

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Other configuration files

			




	
	
	
		
 
-------------------------

			




	
	
	
		
 

			




	
	
	
		
 
Some example init.d scripts can be found in init.d directory: https://kallithea-scm.org/repos/kallithea/files/tip/init.d/

			




	
	
	
		
 

			




	
	
	
		
 
.. _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

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







  


    




    








    
        Server instance: clio-11272
    
    
        This site is powered by
            Kallithea 0.7.0,
        which is
        © 2010–2025 by various authors & licensed under GPLv3.
            – Support