Skip to content
Thilo Fromm edited this page May 2, 2023 · 22 revisions

Set up the mail server

To get started, you'll need an internet-connected server as well as a DNS name pointing to it. DNS is a requirement for getting letsencrypt certificates.

See the set-up instructions for more.

Operate the mail server

Operations include adding and removing users as well as managing aliases. The documentation also covers location of the service configuration files and renewing letsencrypt certificates. See the operations instructions for details.

Information on individual services can be found on the respective services pages:

Mail client settings

The server supports plain SMTP (enforces STARTTLS), SMTP over SSL, IMAP, and IMAP over SSL.

  • The server name (for both sending and receiving) is HOSTNAME.
  • SMTP:
    • Port 25 w/ STARTTLS
    • Port 465 w/ SSL/TLS
  • IMAP:
    • Port 143 (STARTTLS)
    • Port 993 w/ SSL/TLS

Either "plain" or "login" login is supported. Username is the full user@domain name supplied to user.sh add .... Password is the password provided (or generated).

Monitoring suite

mailserver ships with a comprehensive monitoring suite. The suite uses stock Grafana and Prometheus containers and wires these up to the mailserver container. A number of dashboards are shipped and provisioned to Grafana, including:

  • A main dashboard with most important metrics from all service dashboards below
  • SMTP server dashboard (Postfix)
  • IMAP server dashboard (Dovecot)
  • Fail2Ban dashboard
  • Server DNS health dashboard w/ copy-paste-able text for creating SPF. DKIM, and DMARC text records

More details at the monitoring page.

Issues and Workarounds

Contributing

Check out the repository layout to get started. If you'd like to work on a feature please state so in the corresponding feature issue. Please create a new issue if none exists for the feature you're aiming to implement.

Build the container

A Dockerfile is provided with this repo. (Re-)Build the container by issuing

$ docker build -t myemailserver .

Then update start_mailserver.sh and replace ghcr.io/t-lo/mailserver with myemailserver (or any other tag you've used in the docker build command above). Start your build:

./start_mailserver.sh