diff --git a/docs/installation.rst b/docs/installation.rst --- a/docs/installation.rst +++ b/docs/installation.rst @@ -5,31 +5,20 @@ Installation ``RhodeCode`` is written entirely in Python, but in order to use it's full potential there are some third-party requirements. When RhodeCode is used -together with celery_ You have to install some kind of message broker, +together with celery You have to install some kind of message broker, recommended one is rabbitmq_ to make the async tasks work. Of course RhodeCode works in sync mode also, then You don't have to install any third party apps. Celery_ will give You large speed improvement when using -many big repositories. If You plan to use it for 5 or 10 small repositories, it +many big repositories. If You plan to use it for 7 or 10 small repositories, it will work just fine without celery running. -After You decide to Run it with celery make sure You run celeryd and -message broker together with the application. - -Requirements for Celery ------------------------ - -**Message Broker** - -- preferred is `RabbitMq `_ -- possible other is `Redis `_ - -For installation instructions You can visit: -http://ask.github.com/celery/getting-started/index.html -It's very nice tutorial how to start celery_ with rabbitmq_ +After You decide to Run it with celery make sure You run celeryd using paster +and message broker together with the application. Install from Cheese Shop ------------------------ +Rhodecode requires python 2.x greater than version 2.5 Easiest way to install ``rhodecode`` is to run:: @@ -42,7 +31,7 @@ Or:: If you prefer to install manually simply grab latest release from http://pypi.python.org/pypi/rhodecode, decompres archive and run:: - python setup.py install + python setup.py install Step by step installation example @@ -62,7 +51,7 @@ Step by step installation example :: - source /var/www/rhodecode-venv/bin/activate + source activate /var/www/rhodecode-venv/bin/activate - Make a folder for rhodecode somewhere on the filesystem for example @@ -80,8 +69,28 @@ Step by step installation example - this will install rhodecode together with pylons and all other required python libraries +Requirements for Celery (optional) +---------------------------------- + +.. note:: + Installing message broker and using celery is optional, RhodeCode will + work without them perfectly fine. + + +**Message Broker** + +- preferred is `RabbitMq `_ +- possible other is `Redis `_ + +For installation instructions You can visit: +http://ask.github.com/celery/getting-started/index.html +It's very nice tutorial how to start celery_ with rabbitmq_ + You can now proceed to :ref:`setup` +----------------------------------- + + .. _virtualenv: http://pypi.python.org/pypi/virtualenv .. _python: http://www.python.org/