1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
.. _install:
Installing poezio
=================
.. 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
-------------------------------------
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 stable package is provided in sid_ 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
(If another distribution provides a poezio package, please tell us and we will
add it to the list)
Thank to all the maintainers who took time to make and maintain those packages!
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.
.. code-block:: bash
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 :ref:`running poezio <poezio-run-label>`.
Poezio needs two libraries to run:
- aiodns_
- slixmpp_
- slixmpp can make use of cython_ to compile performance-critical modules and be faster
.. versionchanged:: 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
:ref:`installation part <poezio-install-label>`.
""""""""
slixmpp
""""""""
Poezio depends on slixmpp, a non-threaded fork of the SleekXMPP library.
.. code-block:: bash
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).
.. code-block:: bash
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:
.. code-block:: bash
make
.. _poezio-install-label:
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 :file:`poezio` directory:
.. code-block:: bash
./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 :file:`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``).
.. versionchanged:: 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):
.. code-block:: bash
make install
.. _poezio-run-label:
Running
~~~~~~~
If you didn’t install poezio, you can run it from the source directory
with:
.. code-block:: bash
./launch.sh
If you did, it should be in the ``$PATH`` as ``poezio``, so run:
.. code-block:: bash
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:
.. code-block:: bash
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
that should be created beforehand:
.. code-block:: bash
mkdir -p ~/.config/poezio ~/.local/share/poezio
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.
.. _stable sources: https://dev.louiz.org/project/poezio/download
.. _slixmpp: https://dev.louiz.org/projects/slixmpp
.. _aiodns: https://github.com/saghul/aiodns
.. _poezio: https://aur.archlinux.org/packages/poezio/
.. _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
.. _cython: http://cython.org
.. _bgo-overlay: https://bgo.zugaina.org/
.. _port: http://ports.su/net/poezio
.. _poezio/poezio: https://hub.docker.com/r/poezio/poezio/
.. _sid: https://packages.debian.org/sid/poezio
|
