From 6c35f49dd8c0a8f8add13c177660e65c64e649eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Fri, 17 Feb 2017 18:25:49 +0100 Subject: Add a biboumi Dockerfile --- docker/biboumi/README.rst | 51 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 docker/biboumi/README.rst (limited to 'docker/biboumi/README.rst') diff --git a/docker/biboumi/README.rst b/docker/biboumi/README.rst new file mode 100644 index 0000000..b9c63ea --- /dev/null +++ b/docker/biboumi/README.rst @@ -0,0 +1,51 @@ +Biboumi Docker Image +==================== + +Running +------- + +This image does not embed any XMPP server. You need to have a running XMPP +server (as an other docker container for example) first. + +Assuming you have a running `prosody +`_ container already running and +`properly configured +`_ you can +use the following command to start your biboumi container. + +``` +docker run --link prosody:xmpp \ + -e BIBOUMI_PASSWORD=P4SSW0RD \ + -e BIBOUMI_HOSTNAME=irc.example.com \ + -e BIBOUMI_ADMIN=blabla \ + 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. + +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, but it needs to be +called *xmpp*. For example, if you are using a container named ejabberd, you +would use the option *--link ejabberd:xmpp*. -- cgit v1.2.3