summaryrefslogtreecommitdiff
path: root/doc/source/install.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/install.rst')
-rw-r--r--doc/source/install.rst39
1 files changed, 27 insertions, 12 deletions
diff --git a/doc/source/install.rst b/doc/source/install.rst
index 3146958c..31dc332d 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -3,7 +3,7 @@
Installing poezio
=================
-.. warning:: Python 3.5 or above is **required**.
+.. warning:: Python 3.7 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
@@ -15,16 +15,18 @@ using one of these.
- **Archlinux**: poezio_ and poezio-git_ packages are in the AUR
(use your favourite AUR wrapper to install them)
-- **Gentoo**: It’s uncertain, but the bgo-overlay_ appears to contain poezio
- and slixmpp packages.
-- **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.
+- **Gentoo**: `net-im/poezio`_
+- **Fedora**: There is an `up-to-date package`_ in the repos since F19.
+- **CentOS**: Poezio is available in EPEL repositories since CentOS 8.
+- **Flatpak**: A stable package is provided on flathub_.
- **Debian**: A stable package is provided since buster_ thanks to debacle.
- **Nix** (and **NixOS**): The last stable version of poezio is availalble in
the unstable branch of `nixpkgs`. Use ``nix-env -f "<nixpkgs>" -iA poezio``
to install poezio for the current user.
- **OpenBSD**: a poezio port_ is available
+- **Guix**: Poezio can be obtained with Guix on any GNU/Linux distribution.
+ To install poezio in default user-profile: ``guix install poezio``.
+ To try poezio without installation: ``guix environment --pure --ad-hoc poezio``.
(If another distribution provides a poezio package, please tell us and we will
add it to the list)
@@ -54,14 +56,14 @@ support. Therefore, you might want to use the git version.
.. code-block:: bash
- git clone git://git.poez.io/poezio
+ git clone https://lab.louiz.org/poezio/poezio
cd poezio
"""""""
General
"""""""
-Poezio is a python3.5 (and above)-only application, so you will first need that.
+Poezio is a python3.7 (and above)-only application, so you will first need that.
Packages required for building poezio and deps:
@@ -70,6 +72,18 @@ Packages required for building poezio and deps:
- libidn and libidn-dev, only if you want to use cython_ (see below)
- python3-devel (or equivalent)
- python3-setuptools
+- python3-pip
+- python3-venv
+- libffi-dev (for pycares, needed by slixmpp)
+- pyasn1 and pyasn1-modules (needed by slixmpp)
+
+On Debian, you can install the dependencies as follows:
+
+.. code-block:: bash
+
+ apt install python3-dev make gcc python3-setuptools python3-pip python3-venv libffi-dev
+ pip3 install --user pyasn1 pyasn1-modules
+
Then you can run ``make`` to build it the poezio C extension module.
If you downloaded the standalone stable package, you are finished here and can skip
@@ -102,7 +116,7 @@ Poezio depends on slixmpp, a non-threaded fork of the SleekXMPP library.
.. code-block:: bash
- git clone git://git.poez.io/slixmpp
+ git clone https://lab.louiz.org/poezio/slixmpp
python3 setup.py install --user
@@ -115,7 +129,7 @@ The aiodns library is required in order to properly resolve XMPP domains (with S
.. code-block:: bash
- pip install --user aiodns
+ pip3 install --user aiodns
This will also install pycares, which aiodns uses.
@@ -230,8 +244,7 @@ that should be created beforehand:
If you don’t trust images distributed on the docker hub, you can rebuild the
image from the Dockerfile at the root of the git repository.
-.. _stable sources: https://dev.louiz.org/project/poezio/download
-.. _slixmpp: https://dev.louiz.org/projects/slixmpp
+.. _slixmpp: https://lab.louiz.org/poezio/slixmpp
.. _aiodns: https://github.com/saghul/aiodns
.. _poezio: https://aur.archlinux.org/packages/poezio/
.. _poezio-git: https://aur.archlinux.org/packages/poezio-git/
@@ -242,3 +255,5 @@ image from the Dockerfile at the root of the git repository.
.. _port: http://ports.su/net/poezio
.. _poezio/poezio: https://hub.docker.com/r/poezio/poezio/
.. _buster: https://packages.debian.org/buster/poezio
+.. _net-im/poezio: https://packages.gentoo.org/packages/net-im/poezio
+.. _flathub: https://flathub.org/apps/details/io.poez.Poezio