From 9764c3027bb08e6cd09d19dbc9c4858a5ede2bb2 Mon Sep 17 00:00:00 2001 From: Joerg Elfring Date: Thu, 22 Nov 2018 20:01:37 +0100 Subject: [PATCH] prosody: Fix Readme --- prosody-0.11/README.md | 49 ++++++++++++++++++++++++++---------------- 1 file changed, 30 insertions(+), 19 deletions(-) diff --git a/prosody-0.11/README.md b/prosody-0.11/README.md index ccfa1dd..cde95af 100644 --- a/prosody-0.11/README.md +++ b/prosody-0.11/README.md @@ -1,4 +1,5 @@ -# Prosody Docker image +## Prosody Docker image +Source: https://bitbucket.org/elfrinjo/dockerfiles/src/master/prosody-0.11/ Create an image for running prosody XMPP server version 0.11 http://prosody.im/ on Alpine Linux. @@ -8,20 +9,26 @@ HINT: This is not an official image. Builds might not happen regularly. You will need to configure a vhost inside the config volume (prosody.cfg.lua). The certificate generation with prosodyctl does not work. -However, certificates can be put into the config volume or be linked in from an -other volume (like letsencrypt). I suggest acme.sh for communication with -Letsencrypt. https://github.com/Neilpang/acme.sh/wiki/Run-acme.sh-in-docker +However, certificates can be put into the config volume. +I suggest acme.sh for communication with Letsencrypt. +https://github.com/Neilpang/acme.sh/wiki/Run-acme.sh-in-docker You need to configure the certificates location inside prosodys config. IPORTANT: You really should add TLS. -## Usage +## Upgrading from 0.10 +The module configuration has to be updated: +- Replace mod_omemo_all_access with mod_profile +- Replace mod_mam_muc with mod_muc_mam +- Disable mod_omemo_all_access -Start the container with volumes for config, database and maybe additional -certificates. +## Usage +Start the container with volumes for config and database. Do not forget to customize your configuration! +. +. ```console -$ docker run -d \ +# docker run -d \ -p 5000:5000 \ -p 5222:5222 \ -p 5269:5269 \ @@ -32,19 +39,21 @@ $ docker run -d \ -v /etc/localtime:/etc/localtime:ro \ -v prosody-cfg:/usr/local/etc/prosody:ro \ -v prosody-data:/usr/local/var/lib/prosody \ - elfrinjo/prosody + elfrinjo/prosody-0.11 ``` - +. +. To create the first user, exec into the running container and use prosodyctl. ```console -$ docker exec -ti prosody bash -/ $ prosodyctl adduser JID +# docker exec -ti prosody bash +#/$ prosodyctl adduser JID ``` - +. +. To Create a certificate for you host: ```console -$ docker pull neilpang/acme.sh -$ docker run --rm -it \ +# docker pull neilpang/acme.sh +# docker run --rm -it \ --volume prosody-acme:/acme.sh \ --net=host \ neilpang/acme.sh --issue \ @@ -52,19 +61,21 @@ $ docker run --rm -it \ -d conference.example.com \ --standalone ``` - +. +. To renew the certificate: ```console -$ docker pull neilpang/acme.sh -$ docker run --rm -it \ +# docker pull neilpang/acme.sh +# docker run --rm -it \ --volume prosody-acme:/acme.sh \ --net=host \ neilpang/acme.sh --cron --standalone -$ docker run --rm \ +# docker run --rm \ -v prosody-acme:/acme.sh \ -v prosody-cfg:/target \ neilpang/acme.sh --install-cert \ -d example.com \ --key-file /target/certs/example.com/example.com.key \ --fullchain-file /target/certs/example.com/fullchain.cer +# docker restart prosody ```