installation.rst
89 lines
| 2.3 KiB
| text/x-rst
|
RstLexer
/ docs / installation.rst
| r568 | .. _installation: | ||
| 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 | |||
| r671 | together with celery_ You have to install some kind of message broker, | ||
| r572 | recommended one is rabbitmq_ to make the async tasks work. | ||
| r568 | |||
| Of course RhodeCode works in sync mode also, then You don't have to install | |||
| r572 | any third party apps. Celery_ will give You large speed improvement when using | ||
| r671 | many big repositories. If You plan to use it for 5 or 10 small repositories, it | ||
| r568 | 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 <http://www.rabbitmq.com/>`_ | |||
| - possible other is `Redis <http://code.google.com/p/redis/>`_ | |||
| r572 | 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_ | |||
| r568 | |||
| Install from Cheese Shop | |||
| ------------------------ | |||
| Easiest way to install ``rhodecode`` is to run:: | |||
| r671 | easy_install rhodecode | ||
| r568 | |||
| Or:: | |||
| r572 | pip install rhodecode | ||
| r568 | |||
| If you prefer to install manually simply grab latest release from | |||
| http://pypi.python.org/pypi/rhodecode, decompres archive and run:: | |||
| r671 | python setup.py install | ||
| r568 | |||
| r572 | Step by step installation example | ||
| --------------------------------- | |||
| r568 | |||
| r671 | - Assuming You have installed virtualenv_ create one using. | ||
| The `--no-site-packages` will make sure non of Your system libs are linked | |||
| with this virtualenv_ | |||
| r572 | |||
| :: | |||
| virtualenv --no-site-packages /var/www/rhodecode-venv | |||
| - this will install new virtualenv_ into `/var/www/rhodecode-venv`. | |||
| - Activate the virtualenv_ by running | |||
| :: | |||
| source activate /var/www/rhodecode-venv/bin/activate | |||
| r568 | - Make a folder for rhodecode somewhere on the filesystem for example | ||
| r572 | |||
| :: | |||
| mkdir /var/www/rhodecode | |||
| - Run this command to install rhodecode | |||
| :: | |||
| easy_install rhodecode | |||
| - this will install rhodecode together with pylons | |||
| r568 | and all other required python libraries | ||
| r572 | |||
| You can now proceed to :ref:`setup` | |||
| r568 | |||
| r572 | .. _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/ |
