kallithea Changeset - 23057179017f

Changeset - 23057179017f

Parent rev.

Child rev.

[Not reviewed]

default

0 1 0

Andrew Shadura - 9 years ago 2016-07-12 23:31:02
andrew@shadura.me

docs: add information about extra dependencies we now need

We have always needed some development packages, but never said
that explicitly. Now that bcrypt also requires libffi-dev, we
should mention that.

1 file changed with 16 insertions and 0 deletions:

docs/installation.rst

0 comments (0 inline, 0 general)

docs/installation.rst

➞

Show inline comments

@@ @@ -5,48 +5,64 @@ Installation on Unix/Linux @@
 ==========================
 The following describes three different ways of installing Kallithea:
 - :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
   Python environment using `virtualenv`. The advantages of this method over
   direct installation is that Kallithea and its dependencies are completely
   contained inside the virtualenv (which also means you can have multiple
   installations side by side or remove it entirely by just removing the
   virtualenv directory) and does not require root privileges.
 - :ref:`installation-without-virtualenv`: The alternative method of installing
   a Kallithea release is using standard pip. The package will be installed in
   the same location as all other Python packages you have ever installed. As a
   result, removing it is not as straightforward as with a virtualenv, as you'd
   have to remove its dependencies manually and make sure that they are not
   needed by other packages.
 Regardless of the installation method you may need to make sure you have
 appropriate development packages installed, as installation of some of the
 Kallithea dependencies requires a working C compiler and libffi library
 headers. Depending on your configuration, you may also need to install
 Git and development packages for the database of your choice.
 For Debian and Ubuntu, the following command will ensure that a reasonable
 set of dependencies is installed::
     sudo apt-get install build-essential git python-pip python-virtualenv libffi-dev python-dev
 For Fedora and RHEL-derivatives, the following command will ensure that a
 reasonable set of dependencies is installed::
     sudo yum install gcc git python-pip python-virtualenv libffi-devel python-devel
 .. _installation-source:
 Installation from repository source
 -----------------------------------
 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
         cd kallithea
         virtualenv ../kallithea-venv
         source ../kallithea-venv/bin/activate
         pip install --upgrade pip setuptools
         pip install -e .
         python2 setup.py compile_catalog   # for translation of the UI
 You can now proceed to :ref:`setup`.
 .. _installation-virtualenv:
 Installing a released version in a virtualenv
 ---------------------------------------------

0 comments (0 inline, 0 general)