Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tozd/docker-mail
Docker image with a full-fledged e-mail service with virtual users. Read-only mirror of https://gitlab.com/tozd/docker/mail
https://github.com/tozd/docker-mail
docker docker-image email postfix
Last synced: 4 days ago
JSON representation
Docker image with a full-fledged e-mail service with virtual users. Read-only mirror of https://gitlab.com/tozd/docker/mail
- Host: GitHub
- URL: https://github.com/tozd/docker-mail
- Owner: tozd
- Created: 2015-11-30T10:43:34.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-07-14T02:32:26.000Z (over 1 year ago)
- Last Synced: 2024-08-02T12:50:57.660Z (3 months ago)
- Topics: docker, docker-image, email, postfix
- Language: Shell
- Homepage:
- Size: 43.9 KB
- Stars: 15
- Watchers: 6
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-starred - tozd/docker-mail - Docker image with a full-fledged e-mail service with virtual users. Read-only mirror of https://gitlab.com/tozd/docker/mail (docker)
README
# tozd/mail
**WORK IN PROGRESS**
Available as:
- [`tozd/mail`](https://hub.docker.com/r/tozd/mail)
- [`registry.gitlab.com/tozd/docker/mail`](https://gitlab.com/tozd/docker/mail/container_registry)
## Image inheritance
[`tozd/base`](https://gitlab.com/tozd/docker/base) ← [`tozd/dinit`](https://gitlab.com/tozd/docker/dinit) ← [`tozd/postfix`](https://gitlab.com/tozd/docker/postfix) ← `tozd/mail`
## Description
Image extending [tozd/postfix](https://gitlab.com/tozd/docker/postfix) image to provide
a full-fledged e-mail service with virtual users.
You should make sure you mount all volumes (especially `/srv/mail`) so that you do not lose e-mails and other
data when you are recreating a container. If volumes are empty, image will initialize them at the first startup.
Integrated services:
- [tozd/postfix](https://gitlab.com/tozd/docker/postfix) – sending and receiving e-mails, extends the image
- [tozd/sympa](https://gitlab.com/tozd/docker/sympa) – mailing lists, runs alongside the image
- [tozd/postfixadmin](https://gitlab.com/tozd/docker/postfixadmin) – virtual users, runs alongside the image
- [Amavis](https://www.ijs.si/software/amavisd/) – interface for virus and spam scanning
- [Clamav](http://www.clamav.net/) – antivirus engine
- [SpamAssassin](https://spamassassin.apache.org/) – anti-spam platform
- [Postgrey](http://postgrey.schweikert.ch/) – greylisting
- [Dovecot](http://www.dovecot.org/) – IMAP and POP3 server
The intended use of this image is that it is extended to provide necessary configuration files and customizations
for your installation, and used together with `tozd/sympa` and `tozd/postfixadmin`.
You can use [tozd/postgresql](https://gitlab.com/tozd/docker/postgresql)
PostgreSQL database.
You might find [tozd/external-ip](https://gitlab.com/tozd/docker/external-ip) Docker image useful, too.
**The image cannot run without extending (or mounting necessary files into it).**
Besides various data volumes they are configuration volumes you have to mount:
- `/config` is a volume which should provide all sensitive and custom configurations for services
- `/etc/postfixadmin/shared` is a volume shared with `tozd/postfix` container to provide necessary SSH keys for communication between containers
- `/etc/sympa/shared` is a volume shared with `tozd/sympa` container to get necessary SSH keys for communication between containers
`/config` volume should contain files:
- `/config/amavis/50-user` – Amavis configuration, the best place to configure your hostname, local domains, and spam handling
- `/config/dovecot/`
- `connect.conf` – should contain only PostgreSQL `connect` configuration parameter
- `local.conf` – hostname, postmaster address, and paths to your SSL keys (probably the best is to store them in `/config/ssl`)
- `/config/postfix/`
- `main.cf.append` – if it exists, it is appended to the `main.cf`
- `master.cf.append` – if it exists, it is appended to the `master.cf`
- `/config/postfixadmin/pgpass` – PostgreSQL password in the [password file format](http://www.postgresql.org/docs/9.3/static/libpq-pgpass.html),
used by the `postfixadmin-mailbox-postcreation.sh` script
- `/config/postgrey/`
- `whitelist_clients.local` – list of extra whitelisted clients
- `whitelist_recipients.local` – list of extra whitelisted recipients
- `run.config` – is run at the beginning of Postfix startup, use it to further configure Postfix and run `postmap` on files
- `run.initialization` – is run just before Postfix process itself is started, possibly use to fix any file permissions
- `/config/spamassassin/local.cf` – you probably want to set `trusted_networks` and `internal_networks` to `172.17.0.0/16`, and configure things like
Bayes; you can set `bayes_store_module Mail::SpamAssassin::BayesStore::PgSQL` to use a PostgreSQL database for Bayes learning, configure access to it,
and initialize it using `/usr/share/doc/spamassassin/sql/bayes_pg.sql`
In your `main.cf.append` you probably want to configure virtual users and PostgreSQL database access. Something similar
to:
```
virtual_alias_maps =
proxy:pgsql:/config/postfix/pgsql_virtual_alias_maps.cf,
proxy:pgsql:/config/postfix/pgsql_virtual_alias_domain_maps.cf,
proxy:pgsql:/config/postfix/pgsql_virtual_alias_domain_catchall_maps.cf,
regexp:/config/postfix/sympa_rewrite
virtual_minimum_uid = 120
virtual_uid_maps = static:120
virtual_gid_maps = static:120
virtual_mailbox_base = /srv/mail/domains
virtual_mailbox_domains = proxy:pgsql:/config/postfix/pgsql_virtual_domains_maps.cf
virtual_mailbox_limit = 0
virtual_mailbox_maps =
proxy:pgsql:/config/postfix/pgsql_virtual_mailbox_maps.cf,
proxy:pgsql:/config/postfix/pgsql_virtual_alias_domain_mailbox_maps.cf,
regexp:/config/postfix/sympa_transport
virtual_transport = dovecot
dovecot_destination_recipient_limit = 1
relay_domains = proxy:pgsql:/config/postfix/pgsql_relay_domains_maps.cf
```
See [full documentation](https://github.com/postfixadmin/postfixadmin/blob/master/DOCUMENTS/POSTFIX_CONF.txt) on how
to configure Postfix with Postfix Admin (`tozd/postfixadmin`).
The `/etc/sympa/shared` volume should contain also `sympa_rewrite` and `sympa_transport` files configuring the mailing
lists which exist.
Example of a `sympa_rewrite` file:
```
/^sympa-request@/ postmaster
/^sympa-owner@/ postmaster
/(.+)-owner@(.+)/ $1+owner@$2
```
Example of a `sympa_transport` file, for each domain you have Sympa providing mailing lists:
```
/^sympa@example\.com$/ sympadomain:
/^abuse-feedback-report@example\.com$/ sympabouncedomain:
/^bounce\+.*@example\.com$/ sympabouncedomain:
/^listmaster@example\.com$/ sympa:
/^.+(announce|list|info|event|press|talk|news)\+owner@example\.com$/ sympabounce:
/^.+(announce|list|info|event|press|talk|news)(-request|-editor|-subscribe|-unsubscribe)?@example\.com$/ sympa:
```
## GitHub mirror
There is also a [read-only GitHub mirror available](https://github.com/tozd/docker-mail),
if you need to fork the project there.