.. _installation:

Installation

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

``RhodeCode`` is written entirely in Python. In order to gain maximum performance

there are some third-party you must install. When RhodeCode 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 RhodeCode 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 RhodeCode for say 7 to 10 small repositories, RhodeCode

will perform perfectly well without celery running.

If you make the decision to run RhodeCode with celery make sure you run celeryd using paster

and message broker together with the application.   

Installing RhodeCode from Cheese Shop

Rhodecode requires python version 2.5 or higher.

The easiest way to install ``rhodecode`` is to run::

    easy_install rhodecode

Or::

    pip install rhodecode

If you prefer to install RhodeCode manually simply grab latest release from

http://pypi.python.org/pypi/rhodecode, decompress the archive and run::

    python setup.py install

Step by step installation example

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

- Assuming you have installed virtualenv_ create a new virtual environment using virtualenv:: 

    virtualenv --no-site-packages /var/www/rhodecode-venv

Apache's example FCGI config

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

TODO !

Other configuration files

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

Some example init.d scripts can be found here, for debian and gentoo:

https://rhodeocode.org/rhodecode/files/tip/init.d

Troubleshooting

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

:Q: **Missing static files?**

:A: Make sure either to set the `static_files = true` in the .ini file or

   double check the root path for your http setup. It should point to 

   for example:

   /home/my-virtual-python/lib/python2.6/site-packages/rhodecode/public

|

:Q: **Can't install celery/rabbitmq**

:A: Don't worry RhodeCode works without them too. No extra setup is required.

|

:Q: **Long lasting push timeouts?**

:A: Make sure you set a longer timeouts in your proxy/fcgi settings, timeouts

|

:Q: **Large pushes timeouts?**

:A: Make sure you set a proper max_body_size for the http server.

|

:Q: **Apache doesn't pass basicAuth on pull/push?**

:A: Make sure you added `WSGIPassAuthorization true`.

For further questions search the `Issues tracker`_, or post a message in the `google group rhodecode`_

.. _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-ldap: http://www.python-ldap.org/

.. _mercurial-server: http://www.lshift.net/mercurial-server.html

.. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories

.. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues

.. _google group rhodecode: http://groups.google.com/group/rhodecode

.. _upgrade:

Upgrade

=======

Upgrading from Cheese Shop

.. note::

   Firstly, it is recommended that you **always** perform a database backup before doing an upgrade.

The easiest way to upgrade ``rhodecode`` is to run::

 easy_install -U rhodecode

Or::

 pip install --upgrade rhodecode

Then make sure you run the following command from the installation directory::

 paster make-config RhodeCode production.ini

This will display any changes made by the new version of RhodeCode to your

current configuration. It will try to perform an automerge. It's always better

to make a backup of your configuration file before hand and recheck the content after the automerge.

.. note::

   The next steps only apply to upgrading from non bugfix releases eg. from

   any minor or major releases. Bugfix releases (eg. 1.1.2->1.1.3) will