607ea4400d
In commit 5305d584 we fixed an issue with the way the Docker image
adds the "hostname" option to chasquid.conf.
Currently, the Docker entrypoint sets the "hostname" option in
chasquid.conf if it's missing.
That works fine, except when there is a configuration change and the
domain is removed. In that case, the hostname option will have a stale
value, forcing the user to re-create the container, which can be
cumbersome.
This patch fixes the issue by unconditionally setting the hostname
option to one of the available domains at the time of start up.
Thanks to Jaywann@github for finding and reporting this problem on
https://github.com/albertito/chasquid/issues/16, and suggesting an
alternative fix!
Docker
chasquid comes with a Dockerfile to create a container running chasquid, dovecot, and managed certificates with Let's Encrypt.
Note these are less thoroughly tested than the traditional setup, which is the recommended way to use chasquid.
Images
There are pre-built images at the gitlab registry and dockerhub. They are automatically built, and tagged with the corresponding branch name. Use the master tag for a stable version.
If, instead, you want to build the image yourself, just run:
$ docker build -t chasquid -f docker/Dockerfile .
Running
First, pull the image into your target machine:
$ docker pull registry.gitlab.com/albertito/chasquid:master
You will need a data volume to store persistent data, outside the image. This will contain the mailboxes, user databases, etc.
$ docker volume create chasquid-data
To add your first user to the image:
$ docker run \
--mount source=chasquid-data,target=/data \
-it --entrypoint=/add-user.sh \
registry.gitlab.com/albertito/chasquid:master
Email (full user@domain format): pepe@example.com
Password:
pepe@example.com added to /data/dovecot/users
Upon startup, the image will obtain a TLS certificate for you using Let's
Encrypt. You need to tell it the domain(s) to get a
certificate from by setting the AUTO_CERTS variable.
Because certificates expire, you should restart the container every week or so. Certificates will be renewed automatically upon startup if needed.
In order for chasquid to get access to the source IP address, you will need to use host networking, or create a custom docker network that does IP forwarding and not proxying.
Finally, start the container:
$ docker run -e AUTO_CERTS=mail.yourdomain.com \
--mount source=chasquid-data,target=/data \
--network host \
registry.gitlab.com/albertito/chasquid:master
Debugging
To get a shell on the running container for debugging, you can use docker ps
to find the container ID, and then docker exec -it CONTAINERID /bin/bash to
open a shell on the running container.