relay/docs/DOCKER_INSTALLATION_EN.md

Known issues and limitations

• Requires cgroups v2 configured in the system. Operation with cgroups v1 has not been tested.
• Yes, of course, using systemd inside a container is a hack, and it would be better to split it into several services, but since this is an MVP, it turned out to be easier to do it this way initially than to rewrite the entire deployment system.
• The Docker image is only suitable for amd64. If you need to run it on a different architecture, try modifying the Dockerfile (specifically the part responsible for installing dovecot).

Docker installation

This section provides instructions for installing Chatmail using docker-compose.

Preliminary setup

We use chat.example.org as the Chatmail domain in the following steps. Please substitute it with your own domain.

1. Setup the initial DNS records. The following is an example in the familiar BIND zone file format with a TTL of 1 hour (3600 seconds). Please substitute your domain and IP addresses.

    chat.example.com. 3600 IN A 198.51.100.5
    chat.example.com. 3600 IN AAAA 2001:db8::5
    www.chat.example.com. 3600 IN CNAME chat.example.com.
    mta-sts.chat.example.com. 3600 IN CNAME chat.example.com.
   

2. clone the repository on your server.

    git clone https://github.com/chatmail/relay
    cd relay
   

Installation

1. Configure kernel parameters because they cannot be changed inside the container, specifically fs.inotify.max_user_instances and fs.inotify.max_user_watches. Run the following:

echo "fs.inotify.max_user_instances=65536" | sudo tee -a /etc/sysctl.d/99-inotify.conf
echo "fs.inotify.max_user_watches=65536" | sudo tee -a /etc/sysctl.d/99-inotify.conf
sudo sysctl --system

2. Copy ./docker/example.env and rename it to .env. This file stores variables used in docker-compose.yaml.

cp ./docker/example.env .env

3. Configure environment variables in the .env file. These variables are used in the docker-compose.yaml file to pass repeated values. Below is the list of variables used during deployment:

• MAIL_DOMAIN – The domain name of the future server. (required)
• DEBUG_COMMANDS_ENABLED – Run debug commands before installation. (default: false)
• FORCE_REINIT_INI_FILE – Recreate the ini configuration file on startup. (default: false)
• USE_FOREIGN_CERT_MANAGER – Use a third-party certificate manager. (default: false)
• RECREATE_VENV - Recreate the virtual environment (venv). If set to true, the environment will be recreated when the container starts, which will increase the startup time of the service but can help avoid certain errors. (default: false)
• INI_FILE – Path to the ini configuration file. (default: ./chatmail.ini)
• PATH_TO_SSL – Path to where the certificates are stored. (default: /var/lib/acme/live/${MAIL_DOMAIN})
• ENABLE_CERTS_MONITORING – Enable certificate monitoring if USE_FOREIGN_CERT_MANAGER=true. If certificates change, services will be automatically restarted. (default: false)
• CERTS_MONITORING_TIMEOUT – Interval in seconds to check if certificates have changed. (default: '60')
• CMDEPLOY_STAGES – Deployment stages to run on container start. (default: "configure,activate"). Set to "install,configure,activate" to force a full reinstall.

You can also use any variables from the ini configuration file; they must be in uppercase.

4. Build the Docker image:

docker compose build chatmail

5. Start docker compose and wait for the installation to finish:

docker compose up -d # start service
docker compose logs -f chatmail # view container logs, press CTRL+C to exit

6. After installation is complete, you can open https://<your_domain_name> in your browser.

Using custom files

When using Docker, you can apply modified configuration files to make the installation more personalized. This is usually needed for the www/src section so that the Chatmail landing page is customized to your taste, but it can be used for any other cases as well.

To replace files correctly:

1. Create the ./custom directory. It is in .gitignore, so it won’t cause conflicts when updating.

mkdir -p ./custom

2. Modify the required file. For example, index.md:

mkdir -p ./custom/www/src
nano ./custom/www/src/index.md

3. In docker-compose.yaml, add the file mount in the volumes section:

services:
  chatmail:
    volumes:
      ...
      ## custom resources
      - ./custom/www/src/index.md:/opt/chatmail/www/src/index.md

4. Restart the service:

docker compose down
docker compose up -d

Forcing a full reinstall

The Docker image bakes the install stage (binary downloads, package setup, chatmaild venv) into the image at build time. On container start, only the configure and activate stages run by default.

To force a full reinstall (e.g., after updating the source), either rebuild the image:

docker compose build chatmail
docker compose up -d

Or override the stages at runtime without rebuilding:

CMDEPLOY_STAGES="install,configure,activate" docker compose up -d