Installing poezio

Warning

Python 3.4 or above is required. To install it on a distribution that doesn’t provide it, see pyenv.

poezio in the GNU/Linux distributions

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: 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.
  • 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.
  • 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

(If another distribution provides a poezio package, please tell us and we will add it to the list)

Install from source

Stable version

Stable version packages are available in standalone (dependencies provided) and poezio-only packages (both with prebuilt html doc for convenience).

Those versions are also available on pypi (using pip3, for example), and it is recommended to install them this way if you absolutely want to install poezio and your distribution provides no package.

Development version

The stable versions of poezio are more like snapshots of states of development we deem acceptable. There is always an incentive to use the development version, like new features, bug fixes, and more support. Therefore, you might want to use the git version.

git clone git://git.poez.io/poezio
cd poezio

General

Poezio is a python3.4 (and above)-only application, so you will first need that.

Packages required for building poezio and deps:

  • make
  • gcc
  • libidn and libidn-dev, only if you want to use cython (see below)
  • python3-devel (or equivalent)
  • python3-setuptools

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 to running poezio.

Poezio needs two libraries to run:

  • aiodns
  • slixmpp
  • slixmpp can make use of cython to compile performance-critical modules and be faster

Changed in version 0.9.

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.

slixmpp

Poezio depends on slixmpp, a non-threaded fork of the SleekXMPP library.

git clone git://git.poez.io/slixmpp
python3 setup.py install --user

aiodns

The aiodns library is required in order to properly resolve XMPP domains (with SRV records).

pip install --user aiodns

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:

make

Installation

Note

The update.sh + launch.sh method is the recommended way of using and upgrading the devel version of poezio. Installing should only be done with stable versions. And preferably using your distribution’s package manager.

If you skipped the installation of the dependencies and you only want to run poezio without a system-wide install, do, in the poezio directory:

./update.sh

Note

You should probably install cython (for python3) on your system using your package manager, since the installation from pypi takes a long time.

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 poezio-venv).

Note

The python version used can be customized using the $POEZIO_PYTHON env variable.

If your distribution’s python3 does not have a venv module, install the package corresponding to that module (probably python3-venv).

Changed in version 0.12: Previously there was a $POEZIO_VENV_COMMAND env variable to define the command. Now it is required to use $POEZIO_PYTHON.

If you really want to install it, run as root (or sudo in ubuntu or whatever):

make install

Running

If you didn’t install poezio, you can run it from the source directory with:

./launch.sh

If you did, it should be in the $PATH as poezio, so run:

poezio

Docker images

poezio is available on the docker hub in the poezio/poezio repository in which poezio/poezio:latest is the latest built git version, and stable versions are tagged with their numbers. The image is based off alpine linux and we tried to keep the image size to a minimum (<100MiB).

You can therefore just fetch the images with docker pull:

docker pull poezio/poezio

In order to run poezio with non-temporary config and logs, and to have the right colors, you have to share the TERM env var and some directories:

docker run -it -e TERM -v ~/.config/poezio:/home/poezio-user/.config/poezio -v ~/.local/share/poezio:/home/poezio-user/.local/share/poezio poezio/poezio

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.