diff options
Diffstat (limited to 'doc/source/install.rst')
| -rw-r--r-- | doc/source/install.rst | 54 |
1 files changed, 42 insertions, 12 deletions
diff --git a/doc/source/install.rst b/doc/source/install.rst index 0ffa9883..3243e932 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -1,7 +1,8 @@ Installing poezio ================= -.. important:: Python 3.4 or above is **required** +.. warning:: Python 3.4 or above is **required**. + To install it on a distribution that doesn't provide it, see :ref:`pyenv <pyenv-install>`. poezio in the GNU/Linux distributions ------------------------------------- @@ -10,13 +11,16 @@ As far as I know, Poezio is available in the following distributions, you just have to install it by using the package manager of the distribution, if you're using one of these. -- *Archlinux*: A poezio_ and poezio-git_ packages are in AUR (use your favourite - AUR wrapper to install them) -- *Gentoo*: `Sekh’s overlay`_ contains everything required to build poezio - (sleekxmpp, dnspython, and poezio) -- *Fedora*: The poezio package was out of date for a long time in Fedora, but - now thanks to Casper, there is an `up-to-date package`_ in the repos since F19. -- *Debian*: Use an other distro. (or make a package, we can provide help :) ) +- **Archlinux**: A poezio_ and poezio-git_ packages are in AUR (use your favourite + AUR wrapper to install them) +- **Gentoo**: `Sekh’s overlay`_ contains everything required to build stable + versions of poezio (sleekxmpp, dnspython, and poezio) +- **Fedora**: The stable poezio package was out of date for a long time in + Fedora, but now thanks to Casper, there is an `up-to-date package`_ in + the repos since F19. +- **Debian**: A set of `development builds`_ are available for poezio and its + dependencies; those are automatically generated (and most likely untested) + packages. We welcome anyone willing to make proper ones. (If another distribution provides a poezio package, please tell us and we will add it to the list) @@ -69,14 +73,14 @@ Poezio depends on two libraries: Additionally, it needs *python3-setuptools*, which is required for proper python packaging management. -.. note:: We provide a script ``update.sh`` that creates a virtualenv and +.. note:: We provide an ``update.sh`` script that creates a virtualenv and downloads all the required and optional dependencies inside it. we recommend using it with the git version of poezio, in order to keep everything up-to-date. If you don’t want to use the update script for whatever reason, install the following dependencies by hand; otherwise, skip to the -`installation part <poezio-install-label>`. +:ref:`installation part <poezio-install-label>`. """""""" @@ -87,7 +91,7 @@ Poezio depends on slixmpp, a non-thread fork of the SleekXMPP library. .. code-block:: bash - git clone git://git.louiz.org/slixmpp + git clone git://git.poez.io/slixmpp python3 setup.py install --user @@ -105,6 +109,18 @@ The aiodns is required in order to properly resolve XMPP domains (with SRV recor This will also install pycares, which aiodns uses. +"""""""" +Building +"""""""" + +If you don’t run the ``update.sh`` script, you need to manually build the C +module used by poezio: + +.. code-block:: bash + + make + + .. _poezio-install-label: Installation @@ -125,6 +141,18 @@ poezio without a system-wide install, do, in the :file:`poezio` directory: ./update.sh +.. note:: + + If you want to use a custom directory for the virtualenv used by poezio, + you can use the ``$POEZIO_VENV`` environment variable to set use + another path (the default is :file:`poezio-venv`). + + If your distribution does not have a ``pyvenv`` symlink to the latest + pyvenv available, you will need to set ``$POEZIO_VENV_COMMAND`` to it. + For example, if you have python 3.4, you will need to set it to + ``pyvenv-3.4`` instead. + + If you really want to install it, run as root (or sudo in ubuntu or whatever): .. code-block:: bash @@ -145,7 +173,7 @@ with: ./launch.sh -If you did, it should be in he ``$PATH`` as ``poezio``, so run: +If you did, it should be in the ``$PATH`` as ``poezio``, so run: .. code-block:: bash @@ -159,3 +187,5 @@ If you did, it should be in he ``$PATH`` as ``poezio``, so run: .. _poezio-git: https://aur.archlinux.org/packages/poezio-git/ .. _up-to-date package: https://apps.fedoraproject.org/packages/poezio .. _pypi: https://pypi.python.org/pypi/poezio +.. _development builds: http://dédié.jeproteste.info/poezio_debian/ + |