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/Dockerfile | 45 ++++++++++++++++++++++++++++++++++++++ docker/biboumi/README.rst | 51 ++++++++++++++++++++++++++++++++++++++++++++ docker/biboumi/biboumi.cfg | 6 ++++++ docker/biboumi/entrypoint.sh | 10 +++++++++ 4 files changed, 112 insertions(+) create mode 100644 docker/biboumi/Dockerfile create mode 100644 docker/biboumi/README.rst create mode 100644 docker/biboumi/biboumi.cfg create mode 100644 docker/biboumi/entrypoint.sh (limited to 'docker') diff --git a/docker/biboumi/Dockerfile b/docker/biboumi/Dockerfile new file mode 100644 index 0000000..95bd150 --- /dev/null +++ b/docker/biboumi/Dockerfile @@ -0,0 +1,45 @@ +# 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 + +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.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*. diff --git a/docker/biboumi/biboumi.cfg b/docker/biboumi/biboumi.cfg new file mode 100644 index 0000000..fff6563 --- /dev/null +++ b/docker/biboumi/biboumi.cfg @@ -0,0 +1,6 @@ +xmpp_server_ip=xmpp +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..a0c0508 --- /dev/null +++ b/docker/biboumi/entrypoint.sh @@ -0,0 +1,10 @@ +#!/bin/bash + +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_SECRET/${BIBOUMI_SECRET:-missing_secret}/ /etc/biboumi/biboumi.cfg + +echo "Running biboumi with the following conf: " +cat /etc/biboumi/biboumi.cfg + +/usr/bin/biboumi /etc/biboumi/biboumi.cfg -- cgit v1.2.3 From f90969e1a18c148d93c82ab09ae48e4f634efbb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Fri, 17 Feb 2017 22:57:30 +0100 Subject: docker: Properly handle and document the /var/lib/biboumi directory --- docker/biboumi/Dockerfile | 3 +++ docker/biboumi/README.rst | 8 ++++++++ 2 files changed, 11 insertions(+) (limited to 'docker') diff --git a/docker/biboumi/Dockerfile b/docker/biboumi/Dockerfile index 95bd150..721d106 100644 --- a/docker/biboumi/Dockerfile +++ b/docker/biboumi/Dockerfile @@ -34,6 +34,9 @@ RUN git clone git://git.louiz.org/biboumi && mkdir ./biboumi/build && cd ./bibou 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 diff --git a/docker/biboumi/README.rst b/docker/biboumi/README.rst index b9c63ea..fb4b212 100644 --- a/docker/biboumi/README.rst +++ b/docker/biboumi/README.rst @@ -15,6 +15,7 @@ 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 \ @@ -49,3 +50,10 @@ 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*. +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**. -- cgit v1.2.3 From 27d847711c5e663d2fa3b2295f5f50c898783eb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Fri, 17 Feb 2017 14:58:23 +0100 Subject: docker: Add the XMPP_SERVER_IP option, and document the --network=host usage --- docker/biboumi/README.rst | 27 +++++++++++++++++++++++---- docker/biboumi/biboumi.cfg | 2 +- docker/biboumi/entrypoint.sh | 1 + 3 files changed, 25 insertions(+), 5 deletions(-) (limited to 'docker') diff --git a/docker/biboumi/README.rst b/docker/biboumi/README.rst index fb4b212..f6d529d 100644 --- a/docker/biboumi/README.rst +++ b/docker/biboumi/README.rst @@ -5,7 +5,7 @@ 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. +server first: as an other docker image, or running on the host machine. Assuming you have a running `prosody `_ container already running and @@ -22,6 +22,19 @@ docker run --link prosody:xmpp \ 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 --------- @@ -31,6 +44,7 @@ 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. @@ -47,9 +61,14 @@ docker run --link prosody:xmpp \ 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*. +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 ------- diff --git a/docker/biboumi/biboumi.cfg b/docker/biboumi/biboumi.cfg index fff6563..cc5df61 100644 --- a/docker/biboumi/biboumi.cfg +++ b/docker/biboumi/biboumi.cfg @@ -1,4 +1,4 @@ -xmpp_server_ip=xmpp +xmpp_server_ip=BIBOUMI_XMPP_SERVER_IP port=5347 db_name=/var/lib/biboumi/biboumi.sqlite hostname=BIBOUMI_HOSTNAME diff --git a/docker/biboumi/entrypoint.sh b/docker/biboumi/entrypoint.sh index a0c0508..4d00164 100644 --- a/docker/biboumi/entrypoint.sh +++ b/docker/biboumi/entrypoint.sh @@ -1,5 +1,6 @@ #!/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_SECRET/${BIBOUMI_SECRET:-missing_secret}/ /etc/biboumi/biboumi.cfg -- cgit v1.2.3 From 9f978cda943619c95a41e5da9047c3cc0dd31555 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Fri, 17 Feb 2017 22:59:16 +0100 Subject: docker: fix the SECRET->PASSWORD in entrypoint.sh --- docker/biboumi/entrypoint.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docker') diff --git a/docker/biboumi/entrypoint.sh b/docker/biboumi/entrypoint.sh index 4d00164..eda53a4 100644 --- a/docker/biboumi/entrypoint.sh +++ b/docker/biboumi/entrypoint.sh @@ -3,7 +3,7 @@ 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_SECRET/${BIBOUMI_SECRET:-missing_secret}/ /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 -- cgit v1.2.3 From 26eb28dc2368d14e171201a0c6b76b76b19e1ddc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Tue, 28 Feb 2017 19:39:09 +0100 Subject: Split the biboumi dockerfile into two, to be able to disable the cache --- docker/biboumi/Dockerfile | 30 +++++------------------------- docker/biboumi/Dockerfile.base | 23 +++++++++++++++++++++++ docker/biboumi/README.rst | 20 ++++++++++++++++++++ docker/biboumi/build-docker.sh | 14 ++++++++++++++ 4 files changed, 62 insertions(+), 25 deletions(-) create mode 100644 docker/biboumi/Dockerfile.base create mode 100755 docker/biboumi/build-docker.sh (limited to 'docker') diff --git a/docker/biboumi/Dockerfile b/docker/biboumi/Dockerfile index 721d106..7e73c9a 100644 --- a/docker/biboumi/Dockerfile +++ b/docker/biboumi/Dockerfile @@ -1,28 +1,8 @@ -# 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 +# This dockerfile uses the image built using Dockerfile.base, and installs +# biboumi in it + +FROM biboumi-base + RUN git clone git://git.louiz.org/biboumi && mkdir ./biboumi/build && cd ./biboumi/build &&\ cmake .. -DCMAKE_INSTALL_PREFIX=/usr\ -DCMAKE_BUILD_TYPE=Release\ diff --git a/docker/biboumi/Dockerfile.base b/docker/biboumi/Dockerfile.base new file mode 100644 index 0000000..bbc32c2 --- /dev/null +++ b/docker/biboumi/Dockerfile.base @@ -0,0 +1,23 @@ +# This dockerfile install all the dependencies needing to compile 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 diff --git a/docker/biboumi/README.rst b/docker/biboumi/README.rst index f6d529d..d2e2a7e 100644 --- a/docker/biboumi/README.rst +++ b/docker/biboumi/README.rst @@ -76,3 +76,23 @@ 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**. + +Building +-------- + +This image is built from 2 Dockerfiles: +- Dockerfile.base: builds and installs all the dependencies needed to build and run biboumi +- Dockerfile: builds and installs biboumi itself + +The goal is to be able to force the rebuild of biboumi itself (by using +the --no-cache option) without having to rebuild and install all its +dependencies. + +The build does not require any file in the build context, everything is +fetched during the build using git or dnf. + +To build a biboumi image named “foo/biboumi”, you can run the script: + +``` +./build-docker.sh foo/biboumi +``` diff --git a/docker/biboumi/build-docker.sh b/docker/biboumi/build-docker.sh new file mode 100755 index 0000000..d206b89 --- /dev/null +++ b/docker/biboumi/build-docker.sh @@ -0,0 +1,14 @@ +#!/bin/sh + +if [[ -z "$1" ]]; then + echo "Usage: ./build-docker.sh " + echo "Example: ./build-docker.sh docker.io/coucou/biboumi" + exit 1 +fi + +directory=$(dirname $0) +image_name=$1 + +echo $directory +docker build -t biboumi-base $directory -f $directory/Dockerfile.base +docker build -t $image_name $directory -f $directory/Dockerfile --no-cache -- cgit v1.2.3 From 90b3c07b6c43215076f2f1eacbfb1335aa714366 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Tue, 28 Feb 2017 23:46:55 +0100 Subject: Revert "Split the biboumi dockerfile into two, to be able to disable the cache" This reverts commit 26eb28dc2368d14e171201a0c6b76b76b19e1ddc. --- docker/biboumi/Dockerfile | 30 +++++++++++++++++++++++++----- docker/biboumi/Dockerfile.base | 23 ----------------------- docker/biboumi/README.rst | 20 -------------------- docker/biboumi/build-docker.sh | 14 -------------- 4 files changed, 25 insertions(+), 62 deletions(-) delete mode 100644 docker/biboumi/Dockerfile.base delete mode 100755 docker/biboumi/build-docker.sh (limited to 'docker') diff --git a/docker/biboumi/Dockerfile b/docker/biboumi/Dockerfile index 7e73c9a..721d106 100644 --- a/docker/biboumi/Dockerfile +++ b/docker/biboumi/Dockerfile @@ -1,8 +1,28 @@ -# This dockerfile uses the image built using Dockerfile.base, and installs -# biboumi in it - -FROM biboumi-base - +# 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\ diff --git a/docker/biboumi/Dockerfile.base b/docker/biboumi/Dockerfile.base deleted file mode 100644 index bbc32c2..0000000 --- a/docker/biboumi/Dockerfile.base +++ /dev/null @@ -1,23 +0,0 @@ -# This dockerfile install all the dependencies needing to compile 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 diff --git a/docker/biboumi/README.rst b/docker/biboumi/README.rst index d2e2a7e..f6d529d 100644 --- a/docker/biboumi/README.rst +++ b/docker/biboumi/README.rst @@ -76,23 +76,3 @@ 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**. - -Building --------- - -This image is built from 2 Dockerfiles: -- Dockerfile.base: builds and installs all the dependencies needed to build and run biboumi -- Dockerfile: builds and installs biboumi itself - -The goal is to be able to force the rebuild of biboumi itself (by using -the --no-cache option) without having to rebuild and install all its -dependencies. - -The build does not require any file in the build context, everything is -fetched during the build using git or dnf. - -To build a biboumi image named “foo/biboumi”, you can run the script: - -``` -./build-docker.sh foo/biboumi -``` diff --git a/docker/biboumi/build-docker.sh b/docker/biboumi/build-docker.sh deleted file mode 100755 index d206b89..0000000 --- a/docker/biboumi/build-docker.sh +++ /dev/null @@ -1,14 +0,0 @@ -#!/bin/sh - -if [[ -z "$1" ]]; then - echo "Usage: ./build-docker.sh " - echo "Example: ./build-docker.sh docker.io/coucou/biboumi" - exit 1 -fi - -directory=$(dirname $0) -image_name=$1 - -echo $directory -docker build -t biboumi-base $directory -f $directory/Dockerfile.base -docker build -t $image_name $directory -f $directory/Dockerfile --no-cache -- cgit v1.2.3 From ea0151165a8719e596cbd35165db28fe90a376b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Tue, 28 Feb 2017 23:54:02 +0100 Subject: Use markdown for the docker readme --- docker/biboumi/README.md | 77 ++++++++++++++++++++++++++++++++++++++++++++++ docker/biboumi/README.rst | 78 ----------------------------------------------- 2 files changed, 77 insertions(+), 78 deletions(-) create mode 100644 docker/biboumi/README.md delete mode 100644 docker/biboumi/README.rst (limited to 'docker') diff --git a/docker/biboumi/README.md b/docker/biboumi/README.md new file mode 100644 index 0000000..094bb78 --- /dev/null +++ b/docker/biboumi/README.md @@ -0,0 +1,77 @@ +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/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 -`_ container already running and -`properly configured -`_ 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**. -- cgit v1.2.3 From e6e37a6f209ae2e9416b0da03ff21469cb4645b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Wed, 1 Mar 2017 14:14:39 +0100 Subject: =?UTF-8?q?Don=E2=80=99t=20wrap=20the=20lines=20in=20docker/README?= =?UTF-8?q?.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docker/biboumi/README.md | 33 +++++++++------------------------ 1 file changed, 9 insertions(+), 24 deletions(-) (limited to 'docker') diff --git a/docker/biboumi/README.md b/docker/biboumi/README.md index 094bb78..e69c1b0 100644 --- a/docker/biboumi/README.md +++ b/docker/biboumi/README.md @@ -4,13 +4,9 @@ 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. +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. +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 \ @@ -21,8 +17,7 @@ docker run --link prosody:xmpp \ biboumi ``` -If instead you already have an XMPP server running on the host machine, you -can start the biboumi container like this: +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 \ @@ -37,19 +32,16 @@ docker run --network=host \ Variables --------- -The configuration file inside the image is a template that is completed when -the container is started, using the following environment 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. +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: +You can also directly provide your own configuration file by mounting it inside the container using the -v option: ``` docker run --link prosody:xmpp \ @@ -60,18 +52,11 @@ docker run --link prosody:xmpp \ 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*. +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. +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**. +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**. -- cgit v1.2.3 From 11c63ebceb07d9b65ed16182139477ea79739c12 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Mon, 6 Mar 2017 01:22:51 +0100 Subject: Add the gcrypt dependency to the biboumi-test docker images --- docker/biboumi-test/debian/Dockerfile.base | 1 + docker/biboumi-test/fedora/Dockerfile.base | 1 + 2 files changed, 2 insertions(+) (limited to 'docker') diff --git a/docker/biboumi-test/debian/Dockerfile.base b/docker/biboumi-test/debian/Dockerfile.base index 125c048..e609feb 100644 --- a/docker/biboumi-test/debian/Dockerfile.base +++ b/docker/biboumi-test/debian/Dockerfile.base @@ -14,6 +14,7 @@ RUN apt install -y g++\ libudns-dev\ libsqlite3-dev\ libuuid1\ + libgcrypt20-dev\ cmake\ make\ libexpat1-dev\ diff --git a/docker/biboumi-test/fedora/Dockerfile.base b/docker/biboumi-test/fedora/Dockerfile.base index 0fd3095..dd536e5 100644 --- a/docker/biboumi-test/fedora/Dockerfile.base +++ b/docker/biboumi-test/fedora/Dockerfile.base @@ -12,6 +12,7 @@ RUN dnf --refresh install -y\ udns-devel\ sqlite-devel\ libuuid-devel\ + libgcrypt-devel\ cmake\ make\ expat-devel\ -- cgit v1.2.3