summaryrefslogtreecommitdiff
path: root/docker/biboumi
diff options
context:
space:
mode:
Diffstat (limited to 'docker/biboumi')
-rw-r--r--docker/biboumi/Dockerfile48
-rw-r--r--docker/biboumi/README.md62
-rw-r--r--docker/biboumi/biboumi.cfg6
-rw-r--r--docker/biboumi/entrypoint.sh11
4 files changed, 127 insertions, 0 deletions
diff --git a/docker/biboumi/Dockerfile b/docker/biboumi/Dockerfile
new file mode 100644
index 0000000..721d106
--- /dev/null
+++ b/docker/biboumi/Dockerfile
@@ -0,0 +1,48 @@
+# This Dockerfile creates a docker image running biboumi
+
+FROM docker.io/fedora:latest
+
+RUN dnf --refresh install -y\
+ gcc-c++\
+ cmake\
+ make\
+ udns-devel\
+ sqlite-devel\
+ libuuid-devel\
+ expat-devel\
+ libidn-devel\
+ systemd-devel\
+ git\
+ python\
+ && dnf clean all
+
+# Install botan
+RUN git clone https://github.com/randombit/botan.git && cd botan && ./configure.py --prefix=/usr && make -j8 && make install && ldconfig && rm -rf /botan
+
+# Install litesql
+RUN git clone git://git.louiz.org/litesql && mkdir /litesql/build && cd /litesql/build && cmake .. -DCMAKE_INSTALL_PREFIX=/usr && make -j8 && cd /litesql/build && make install && ldconfig && rm -rf /litesql
+
+# Install biboumi
+RUN git clone git://git.louiz.org/biboumi && mkdir ./biboumi/build && cd ./biboumi/build &&\
+ cmake .. -DCMAKE_INSTALL_PREFIX=/usr\
+ -DCMAKE_BUILD_TYPE=Release\
+ -DWITH_BOTAN=1\
+ -DWITH_LITESQL=1\
+ -DWITH_LIBIDN=1\
+ -DWITH_SYSTEMD=1\
+ && make -j8 && make install && rm -rf /biboumi
+
+RUN useradd biboumi
+
+RUN mkdir /var/lib/biboumi
+RUN chown -R biboumi:biboumi /var/lib/biboumi
+
+COPY ./biboumi.cfg /etc/biboumi/biboumi.cfg
+RUN chown -R biboumi:biboumi /etc/biboumi
+
+COPY ./entrypoint.sh /entrypoint.sh
+RUN chmod 755 /entrypoint.sh
+
+ENTRYPOINT ["/entrypoint.sh"]
+
+USER biboumi
diff --git a/docker/biboumi/README.md b/docker/biboumi/README.md
new file mode 100644
index 0000000..e69c1b0
--- /dev/null
+++ b/docker/biboumi/README.md
@@ -0,0 +1,62 @@
+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**.
diff --git a/docker/biboumi/biboumi.cfg b/docker/biboumi/biboumi.cfg
new file mode 100644
index 0000000..cc5df61
--- /dev/null
+++ b/docker/biboumi/biboumi.cfg
@@ -0,0 +1,6 @@
+xmpp_server_ip=BIBOUMI_XMPP_SERVER_IP
+port=5347
+db_name=/var/lib/biboumi/biboumi.sqlite
+hostname=BIBOUMI_HOSTNAME
+password=BIBOUMI_PASSWORD
+admin=BIBOUMI_ADMIN
diff --git a/docker/biboumi/entrypoint.sh b/docker/biboumi/entrypoint.sh
new file mode 100644
index 0000000..eda53a4
--- /dev/null
+++ b/docker/biboumi/entrypoint.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+
+sed -i s/BIBOUMI_XMPP_SERVER_IP/${BIBOUMI_XMPP_SERVER_IP:-xmpp}/ /etc/biboumi/biboumi.cfg
+sed -i s/BIBOUMI_HOSTNAME/${BIBOUMI_HOSTNAME:-biboumi.localhost}/ /etc/biboumi/biboumi.cfg
+sed -i s/BIBOUMI_ADMIN/${BIBOUMI_ADMIN:-}/ /etc/biboumi/biboumi.cfg
+sed -i s/BIBOUMI_PASSWORD/${BIBOUMI_PASSWORD:-missing_password}/ /etc/biboumi/biboumi.cfg
+
+echo "Running biboumi with the following conf: "
+cat /etc/biboumi/biboumi.cfg
+
+/usr/bin/biboumi /etc/biboumi/biboumi.cfg