diff --git a/docs/installation.rst b/docs/installation.rst --- a/docs/installation.rst +++ b/docs/installation.rst @@ -4,16 +4,12 @@ Installation on Unix/Linux ========================== -**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: +The following describes three different ways of installing 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-source`: The simplest way to keep the installation + up-to-date and track any local customizations is to run directly from + source in a Kallithea repository clone, preferably inside a virtualenv + virtual Python environment. - :ref:`installation-virtualenv`: If you prefer to only use released versions of Kallithea, the recommended method is to install Kallithea in a virtual @@ -32,10 +28,11 @@ There are several ways to install Kallit .. _installation-source: + Installation from repository source ----------------------------------- -To install Kallithea in a virtualenv using the stable branch of the development +To install Kallithea in a virtualenv_ using the stable branch of the development repository, follow the instructions below:: hg clone https://kallithea-scm.org/repos/kallithea -u stable @@ -52,6 +49,7 @@ server. .. _installation-virtualenv: + Installing a released version in a virtualenv --------------------------------------------- @@ -95,6 +93,7 @@ You can now proceed to :ref:`setup`. .. _installation-without-virtualenv: + Installing a released version without virtualenv ------------------------------------------------ @@ -111,8 +110,9 @@ To install as a regular user in ``~/.loc You can now proceed to :ref:`setup`. + Upgrading Kallithea from Python Package Index (PyPI) ------------------------------------------------------ +---------------------------------------------------- .. note:: It is strongly recommended that you **always** perform a database and @@ -123,19 +123,16 @@ Upgrading Kallithea from Python Package instance from version 0.1 to 0.2, the ``my.ini`` file could be backed up to ``my.ini.0-1``. - If using a SQLite database, stop the Kallithea process/daemon/service, and then make a copy of the database file:: service kallithea stop cp kallithea.db kallithea.db.{version} - Back up your configuration file:: cp my.ini my.ini.{version} - Ensure that you are using the Python virtual environment that you originally installed Kallithea in by running:: @@ -146,12 +143,10 @@ Kallithea isn't listed, activate the cor source /srv/kallithea/venv/bin/activate - Once you have verified the environment you can upgrade Kallithea with:: pip install --upgrade kallithea - Then run the following command from the installation directory:: paster make-config Kallithea my.ini @@ -164,12 +159,10 @@ that you recheck the content after the a Please always make sure your .ini files are up to date. Errors can often be caused by missing parameters added in new versions. - It is also recommended that you rebuild the whoosh index after upgrading since the new whoosh version could introduce some incompatible index changes. Please read the changelog to see if there were any changes to whoosh. - The final step is to upgrade the database. To do this simply run:: paster upgrade-db my.ini @@ -178,7 +171,6 @@ This will upgrade the schema and update and will always recheck the settings of the application, if there are no new options that need to be set. - .. note:: The DB schema upgrade library has some limitations and can sometimes fail if you try to upgrade from older major releases. In such a case simply run upgrades sequentially, e.g., @@ -205,5 +197,4 @@ Or:: .. _virtualenv: http://pypi.python.org/pypi/virtualenv -.. _Python: http://www.python.org/ .. _pylons: http://www.pylonsproject.org/