Use markdown for the docker readme

1 files changed, 0 insertions, 78 deletions

diff --git a/docker/biboumi/README.rst b/docker/biboumi/README.rst
deleted file mode 100644
index f6d529d..0000000
--- a/docker/biboumi/README.rst
+++ /dev/null
@@ -1,78 +0,0 @@
-Biboumi Docker Image
-====================
-
-Running
--------
-
-This image does not embed any XMPP server. You need to have a running XMPP
-server first: as an other docker image, or running on the host machine.
-
-Assuming you have a running `prosody
-<https://hub.docker.com/r/prosody/prosody/>`_ container already running and
-`properly configured
-<https://prosody.im/doc/components#adding_an_external_component>`_ you can
-use the following command to start your biboumi container.
-
-```
-docker run --link prosody:xmpp \
-    -v $PWD/database:/var/lib/biboumi \
-    -e BIBOUMI_PASSWORD=P4SSW0RD \
-    -e BIBOUMI_HOSTNAME=irc.example.com \
-    -e BIBOUMI_ADMIN=blabla \
-    biboumi
-```
-
-If instead you already have an XMPP server running on the host machine, you
-can start the biboumi container like this:
-
-```
-docker run --network=host \
-    -v $PWD/database:/var/lib/biboumi \
-    -e BIBOUMI_PASSWORD=P4SSW0RD \
-    -e BIBOUMI_HOSTNAME=irc.example.com \
-    -e BIBOUMI_ADMIN=blabla \
-    -e BIBOUMI_XMPP_SERVER_IP=127.0.0.1 \
-    biboumi
-```
-
-Variables
----------
-
-The configuration file inside the image is a template that is completed when
-the container is started, using the following environment variables:
-
-* BIBOUMI_HOSTNAME: Sets the value of the *hostname* option.
-* BIBOUMI_SECRET: Sets the value of the *password* option.
-* BIBOUMI_ADMIN: Sets the value of the *admin* option.
-* BIBOUMI_XMPP_SERVER_IP: Sets the value of the *xmpp_server_ip* option. The default is **xmpp**.
-
-All these variables are optional, but biboumi will probably fail to start if
-the hostname and secret are missing.
-
-You can also directly provide your own configuration file by mounting it
-inside the container using the -v option:
-
-```
-docker run --link prosody:xmpp \
-    -v $PWD/biboumi.cfg:/etc/biboumi/biboumi.cfg \
-    biboumi
-```
-
-Linking with the XMPP server
-----------------------------
-
-You can use the --link option to connect to any server running in a docker
-container, but it needs to be called *xmpp*, or the custom value set for the
-**BIBOUMI_XMPP_SERVER_IP** option. For example, if you are using a container
-named ejabberd, you would use the option *--link ejabberd:xmpp*.
-
-If you want to connect to the XMPP server running on the host machine, use
-the **--network=host** option.
-
-Volumes
--------
-
-The database is stored in the /var/lib/biboumi/ directory. If you don’t bind
-a local directory to it, the database will be lost when the container is
-stopped. If you want to keep your database between each run, bind it with
-the -v option, like this: **-v /srv/biboumi/:/var/lib/biboumi**.