path: root/doc
diff options
authormathieui <>2016-10-15 19:10:33 +0200
committermathieui <>2016-10-15 19:10:33 +0200
commit453d8a8a6f8957ffe2e9654e494f2d0ba19305f1 (patch)
tree38f9dd0ef86553a273720544b5f6f7524234c08d /doc
parent4a7da81eb56ad78541aa869d50f83dda4ac0c60c (diff)
Add documentation about docker
Diffstat (limited to 'doc')
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/source/install.rst b/doc/source/install.rst
index 1f3836ab..cf74b08e 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -195,6 +195,31 @@ If you did, it should be in the ``$PATH`` as ``poezio``, so run:
+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:
+.. code-block:: bash
+ 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:
.. _slixmpp:
.. _aiodns:
@@ -206,3 +231,4 @@ If you did, it should be in the ``$PATH`` as ``poezio``, so run:
.. _cython:
.. _bgo-overlay:
.. _port:
+.. _poezio/poezio: