snappymail-docker

What's this?

Dockerfile and compose file to run the snappymail webmail client.

The image lives at ghcr.io.

Using the image

If you cloned the github repository, skip this step. Otherwise create a file docker-compose.yml with the following content:

services:
  snappymail:
    image: ghcr.io/waldner/snappymail-docker:latest
    container_name: snappymail
    hostname: snappymail
    volumes:
      - ${WEBMAIL_DATA}:/snappymail/data
    ports:
      - ${EXTERNAL_HTTP_PORT:-80}:80
    environment:
      - TZ=${TZ:-UTC}
      - USE_SSL=${USE_SSL:-0}
      - HTTP_AUTH_USER=${HTTP_AUTH_USER:-}
      - HTTP_AUTH_PASS=${HTTP_AUTH_PASS:-}
      - UPLOAD_MAX_SIZE=${UPLOAD_MAX_SIZE:-10m}

Create a file named .env (in the same place where you put the docker-compose.yml file) with the following content:

# mandatory: where the data volume for rainloop is in the host filesystem
WEBMAIL_DATA=/path/to/snappymail/data

# optional: maximum attachment/upload size, default 10m
UPLOAD_MAX_SIZE=20m

# optional: if you want HTTP auth, put credentials in here,
# otherwise don't define these two variables
HTTP_AUTH_USER=myuser
HTTP_AUTH_PASS=mypass

# optional: time zone (default: UTC)
TZ=Europe/Berlin

# optional: which host port will be exposed for HTTP requests (default: 80)
EXTERNAL_HTTP_PORT=8080

# optional: whether to enable ssl (default: 0)
USE_SSL=1

# mandatory if USE_SSL=1: TLS certificate and key locations in local filesystem
LOCAL_SSL_CERT=/path/to/server.crt
LOCAL_SSL_KEY=/path/to/server.key

# optional: which host port will be exposed for HTTPS requests (default: 443)
# only used if USE_SSL=1
EXTERNAL_HTTPS_PORT=8443

# optional: whether to generate and use a custom dhparams.pem file at startup (default: 1)
# this may make the boot process longer
DHPARAMS=0

If you want to use SSL (USE_SSL=1) and thus assigned values to LOCAL_SSL_CERT and LOCAL_SSL_KEY (and possibly EXTERNAL_HTTPS_PORT): create a docker-compose.override.yml in the same directory with the following content (or, if you cloned the repo, just run cp docker-compose.override.yml.sample docker-compose.override.yml):

services:
  snappymail:
    ports:
      - ${EXTERNAL_HTTPS_PORT:-443}:443
    volumes:
      - ${LOCAL_SSL_CERT}:/etc/nginx/server.crt
      - ${LOCAL_SSL_KEY}:/etc/nginx/server.key
    environment:
      EXTERNAL_HTTPS_PORT: ${EXTERNAL_HTTPS_PORT:-443}
      DHPARAMS: ${DHPARAMS:-1}

Run the image with docker compose up -d

Getting started

As explained in the docs, to perform the initial configuration you have to go to http[s]://your.domain.tld:yourport/?admin and follow the instruction in the wiki page. The initial username is admin, the initial password is in /snappymail/data/_data_/_default_/admin_password.txt (inside the container).

Miscellaneous

When using SSL, all incoming requests to $HTTP_EXTERNAL_PORT are redirected to the HTTPS version of the page on port $HTTPS_EXTERNAL_PORT.
All daemons log to stdout, so you can use docker logs to see the messages.
Internally, the container runs nginx and php-fpm, controlled by supervisord.