kallithea: docs/installation.rst annotate

annotate docs/installation.rst @ 6338:fa1d80d31b48

error: remove unused Pylons-specific img/style methods The img and style methods in the error controller are standard Pylons boilerplate. They are used from the Pylons default error document template. The purpose of these methods is to serve images and stylesheets from the Pylons module, rather than having to copy these files into a particular application installation. Since Kallithea uses a custom error template with our own styles and images, these methods are not actually used.

author	Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
date	Tue, 13 Sep 2016 17:55:12 +0200
parents	855ba1f07aeb
children	8845ece50d51

rev	line source
568 5f481e4e888b updated docs, added sphinx build Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	1 .. _installation:
5f481e4e888b updated docs, added sphinx build Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	2
4814 d95ea48af67b docs: rename docs/installation_win.rst to docs/installation_win_old.rst, preparing for new docs Mads Kiilerich <madski@unity3d.com> parents: 4522 diff changeset	3 ==========================
d95ea48af67b docs: rename docs/installation_win.rst to docs/installation_win_old.rst, preparing for new docs Mads Kiilerich <madski@unity3d.com> parents: 4522 diff changeset	4 Installation on Unix/Linux
d95ea48af67b docs: rename docs/installation_win.rst to docs/installation_win_old.rst, preparing for new docs Mads Kiilerich <madski@unity3d.com> parents: 4522 diff changeset	5 ==========================
568 5f481e4e888b updated docs, added sphinx build Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	6
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	7 The following describes three different ways of installing Kallithea:
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4814 diff changeset	8
5081 154becd92f40 docs: add installation overview section Mads Kiilerich <madski@unity3d.com> parents: 4989 diff changeset	9 - :ref:`installation-source`: The simplest way to keep the installation
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	10 up-to-date and track any local customizations is to run directly from
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	11 source in a Kallithea repository clone, preferably inside a virtualenv
5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	12 virtual Python environment.
568 5f481e4e888b updated docs, added sphinx build Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	13
4924 7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	14 - :ref:`installation-virtualenv`: If you prefer to only use released versions
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	15 of Kallithea, the recommended method is to install Kallithea in a virtual
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	16 Python environment using `virtualenv`. The advantages of this method over
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	17 direct installation is that Kallithea and its dependencies are completely
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	18 contained inside the virtualenv (which also means you can have multiple
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	19 installations side by side or remove it entirely by just removing the
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	20 virtualenv directory) and does not require root privileges.
4922 5e66d3ec9880 docs/installation: add section on installation from repository source Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4914 diff changeset	21
4924 7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	22 - :ref:`installation-without-virtualenv`: The alternative method of installing
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	23 a Kallithea release is using standard pip. The package will be installed in
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	24 the same location as all other Python packages you have ever installed. As a
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	25 result, removing it is not as straightforward as with a virtualenv, as you'd
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	26 have to remove its dependencies manually and make sure that they are not
4924 7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	27 needed by other packages.
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	28
6001 23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	29 Regardless of the installation method you may need to make sure you have
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	30 appropriate development packages installed, as installation of some of the
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	31 Kallithea dependencies requires a working C compiler and libffi library
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	32 headers. Depending on your configuration, you may also need to install
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	33 Git and development packages for the database of your choice.
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	34
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	35 For Debian and Ubuntu, the following command will ensure that a reasonable
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	36 set of dependencies is installed::
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	37
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	38 sudo apt-get install build-essential git python-pip python-virtualenv libffi-dev python-dev
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	39
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	40 For Fedora and RHEL-derivatives, the following command will ensure that a
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	41 reasonable set of dependencies is installed::
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	42
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	43 sudo yum install gcc git python-pip python-virtualenv libffi-devel python-devel
23057179017f docs: add information about extra dependencies we now need Andrew Shadura <andrew@shadura.me> parents: 5954 diff changeset	44
4924 7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	45 .. _installation-source:
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	46
5433 fbbe80e3322b docs: consistent spacing around headings Mads Kiilerich <madski@unity3d.com> parents: 5425 diff changeset	47
4924 7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	48 Installation from repository source
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	49 -----------------------------------
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	50
5425 5ae8e644aa88 docs: spelling, grammar, content and typography Søren Løvborg <sorenl@unity3d.com> parents: 5413 diff changeset	51 To install Kallithea in a virtualenv_ using the stable branch of the development
4989 8927a1ac8d41 docs: prepare for having a stable development branch Mads Kiilerich <madski@unity3d.com> parents: 4986 diff changeset	52 repository, follow the instructions below::
4922 5e66d3ec9880 docs/installation: add section on installation from repository source Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4914 diff changeset	53
4989 8927a1ac8d41 docs: prepare for having a stable development branch Mads Kiilerich <madski@unity3d.com> parents: 4986 diff changeset	54 hg clone https://kallithea-scm.org/repos/kallithea -u stable
4922 5e66d3ec9880 docs/installation: add section on installation from repository source Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4914 diff changeset	55 cd kallithea
5e66d3ec9880 docs/installation: add section on installation from repository source Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4914 diff changeset	56 virtualenv ../kallithea-venv
6002 855ba1f07aeb docs: use ., not source, as the user isn't guaranteed to have it Andrew Shadura <andrew@shadura.me> parents: 6001 diff changeset	57 . ../kallithea-venv/bin/activate
5519 8c234ae2c258 docs: add advice of upgrading pip and setuptools in new virtualenvs Mads Kiilerich <madski@unity3d.com> parents: 5502 diff changeset	58 pip install --upgrade pip setuptools
5755 250f8150c4bb docs: suggest using pip instead of setup.py develop Andrew Shadura <andrew@shadura.me> parents: 5520 diff changeset	59 pip install -e .
5502 ae9ab4c92d46 setup: explicitly use python2 in examples in the documentation Mads Kiilerich <madski@unity3d.com> parents: 5434 diff changeset	60 python2 setup.py compile_catalog # for translation of the UI
4922 5e66d3ec9880 docs/installation: add section on installation from repository source Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4914 diff changeset	61
5e66d3ec9880 docs/installation: add section on installation from repository source Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4914 diff changeset	62 You can now proceed to :ref:`setup`.
5e66d3ec9880 docs/installation: add section on installation from repository source Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4914 diff changeset	63
4924 7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	64 .. _installation-virtualenv:
568 5f481e4e888b updated docs, added sphinx build Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	65
5433 fbbe80e3322b docs: consistent spacing around headings Mads Kiilerich <madski@unity3d.com> parents: 5425 diff changeset	66
4924 7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	67 Installing a released version in a virtualenv
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	68 ---------------------------------------------
2358 69df04ee1e2b added detailed step-by-step installation instruction for windows Marcin Kuzminski <marcin@python-works.com> parents: 2351 diff changeset	69
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4814 diff changeset	70 It is highly recommended to use a separate virtualenv_ for installing Kallithea.
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4814 diff changeset	71 This way, all libraries required by Kallithea will be installed separately from your
4924 7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	72 main Python installation and other applications and things will be less
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	73 problematic when upgrading the system or Kallithea.
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	74 An additional benefit of virtualenv_ is that it doesn't require root privileges.
568 5f481e4e888b updated docs, added sphinx build Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	75
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4814 diff changeset	76 - Assuming you have installed virtualenv_, create a new virtual environment
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	77 for example, in `/srv/kallithea/venv`, using the virtualenv command::
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	78
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4814 diff changeset	79 virtualenv /srv/kallithea/venv
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	80
5519 8c234ae2c258 docs: add advice of upgrading pip and setuptools in new virtualenvs Mads Kiilerich <madski@unity3d.com> parents: 5502 diff changeset	81 - Activate the virtualenv_ in your current shell session and make sure the
8c234ae2c258 docs: add advice of upgrading pip and setuptools in new virtualenvs Mads Kiilerich <madski@unity3d.com> parents: 5502 diff changeset	82 basic requirements are up-to-date by running::
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	83
6002 855ba1f07aeb docs: use ., not source, as the user isn't guaranteed to have it Andrew Shadura <andrew@shadura.me> parents: 6001 diff changeset	84 . /srv/kallithea/venv/bin/activate
5519 8c234ae2c258 docs: add advice of upgrading pip and setuptools in new virtualenvs Mads Kiilerich <madski@unity3d.com> parents: 5502 diff changeset	85 pip install --upgrade pip setuptools
1092 8af52e1224ff merge docs in beta with those corrected by Jason Harris Marcin Kuzminski <marcin@python-works.com> parents: 1062 diff changeset	86
4924 7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	87 .. note:: You can't use UNIX ``sudo`` to source the ``virtualenv`` script; it
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	88 will "activate" a shell that terminates immediately. It is also perfectly
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	89 acceptable (and desirable) to create a virtualenv as a normal user.
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3169 diff changeset	90
5520 4e9f5ef98dc4 docs: mention that the optional dependencies psycopg2 and python-ldap also might be needed in the virtualenv Mads Kiilerich <madski@unity3d.com> parents: 5519 diff changeset	91 .. note:: Some dependencies are optional. If you need them, install them in
4e9f5ef98dc4 docs: mention that the optional dependencies psycopg2 and python-ldap also might be needed in the virtualenv Mads Kiilerich <madski@unity3d.com> parents: 5519 diff changeset	92 the virtualenv too::
4e9f5ef98dc4 docs: mention that the optional dependencies psycopg2 and python-ldap also might be needed in the virtualenv Mads Kiilerich <madski@unity3d.com> parents: 5519 diff changeset	93
4e9f5ef98dc4 docs: mention that the optional dependencies psycopg2 and python-ldap also might be needed in the virtualenv Mads Kiilerich <madski@unity3d.com> parents: 5519 diff changeset	94 pip install psycopg2
4e9f5ef98dc4 docs: mention that the optional dependencies psycopg2 and python-ldap also might be needed in the virtualenv Mads Kiilerich <madski@unity3d.com> parents: 5519 diff changeset	95 pip install python-ldap
4e9f5ef98dc4 docs: mention that the optional dependencies psycopg2 and python-ldap also might be needed in the virtualenv Mads Kiilerich <madski@unity3d.com> parents: 5519 diff changeset	96
4e9f5ef98dc4 docs: mention that the optional dependencies psycopg2 and python-ldap also might be needed in the virtualenv Mads Kiilerich <madski@unity3d.com> parents: 5519 diff changeset	97 This might require installation of development packages using your
4e9f5ef98dc4 docs: mention that the optional dependencies psycopg2 and python-ldap also might be needed in the virtualenv Mads Kiilerich <madski@unity3d.com> parents: 5519 diff changeset	98 distribution's package manager.
4e9f5ef98dc4 docs: mention that the optional dependencies psycopg2 and python-ldap also might be needed in the virtualenv Mads Kiilerich <madski@unity3d.com> parents: 5519 diff changeset	99
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 3700 diff changeset	100 - Make a folder for Kallithea data files, and configuration somewhere on the
1309 61a6a7bf2cbd small docs updates Marcin Kuzminski <marcin@python-works.com> parents: 1123 diff changeset	101 filesystem. For example::
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	102
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4814 diff changeset	103 mkdir /srv/kallithea
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3169 diff changeset	104
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	105 - Go into the created directory and run this command to install Kallithea::
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	106
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 3700 diff changeset	107 pip install kallithea
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3169 diff changeset	108
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4814 diff changeset	109 Alternatively, download a .tar.gz from http://pypi.python.org/pypi/Kallithea,
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4814 diff changeset	110 extract it and run::
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4814 diff changeset	111
5755 250f8150c4bb docs: suggest using pip instead of setup.py develop Andrew Shadura <andrew@shadura.me> parents: 5520 diff changeset	112 pip install .
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4814 diff changeset	113
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	114 - This will install Kallithea together with pylons_ and all other required
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4814 diff changeset	115 python libraries into the activated virtualenv.
03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4814 diff changeset	116
4924 7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	117 You can now proceed to :ref:`setup`.
572 a60cd29ba7e2 more docs update Marcin Kuzminski <marcin@python-works.com> parents: 568 diff changeset	118
4924 7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	119 .. _installation-without-virtualenv:
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	120
5433 fbbe80e3322b docs: consistent spacing around headings Mads Kiilerich <madski@unity3d.com> parents: 5425 diff changeset	121
4924 7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	122 Installing a released version without virtualenv
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	123 ------------------------------------------------
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	124
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	125 For installation without virtualenv, 'just' use::
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	126
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	127 pip install kallithea
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	128
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	129 Note that this method requires root privileges and will install packages
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	130 globally without using the system's package manager.
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	131
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	132 To install as a regular user in ``~/.local``, you can use::
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	133
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	134 pip install --user kallithea
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	135
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	136 You can now proceed to :ref:`setup`.
7c952ea3d7b3 docs/installation: clarify and reorder alternative installation methods Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> parents: 4922 diff changeset	137
5433 fbbe80e3322b docs: consistent spacing around headings Mads Kiilerich <madski@unity3d.com> parents: 5425 diff changeset	138
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3169 diff changeset	139 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4925 diff changeset	140 .. _pylons: http://www.pylonsproject.org/

Mercurial > kallithea

annotate docs/installation.rst @ 6338:fa1d80d31b48