mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2024-01-19 02:48:50 +00:00
110 lines
3.1 KiB
Markdown
110 lines
3.1 KiB
Markdown
# docker-mailserver
|
|
|
|
[![Build Status](https://travis-ci.org/tomav/docker-mailserver.svg?branch=master)](https://travis-ci.org/tomav/docker-mailserver)
|
|
|
|
A fullstack but simple mail server (smtp, imap, antispam, antivirus...).
|
|
Only configuration files, no SQL database. Keep it simple and versioned.
|
|
Easy to deploy and upgrade.
|
|
|
|
Includes:
|
|
|
|
- postfix with smtp auth
|
|
- courier-imap with ssl support
|
|
- amavis
|
|
- spamassasin supporting custom rules
|
|
- clamav with automatic updates
|
|
- opendkim
|
|
- opendmarc
|
|
- [LetsEncrypt](https://letsencrypt.org/) and self-signed certificates
|
|
- optional pop3 server
|
|
- [integration tests](https://travis-ci.org/tomav/docker-mailserver)
|
|
- [automated builds on docker hub](https://hub.docker.com/r/tvial/docker-mailserver/)
|
|
|
|
Why I created this image: [Simple mail server with Docker](http://tvi.al/simple-mail-server-with-docker/)
|
|
|
|
Before you open an issue, please have a look this `README`, the [FAQ](https://github.com/tomav/docker-mailserver/wiki/FAQ) and Postfix documentation.
|
|
|
|
## Usage
|
|
|
|
# get latest image
|
|
docker pull tvial/docker-mailserver
|
|
|
|
# create a "docker-compose.yml" file containing:
|
|
mail:
|
|
image: tvial/docker-mailserver
|
|
hostname: mail
|
|
domainname: domain.com
|
|
# your FQDN will be 'mail.domain.com'
|
|
ports:
|
|
- "25:25"
|
|
- "143:143"
|
|
- "587:587"
|
|
- "993:993"
|
|
volumes:
|
|
- ./spamassassin:/tmp/spamassassin/
|
|
- ./postfix:/tmp/postfix/
|
|
|
|
# start he container
|
|
docker-compose up -d mail
|
|
|
|
## Managing users and aliases
|
|
|
|
### Users
|
|
|
|
Users are managed in `postfix/accounts.cf`.
|
|
Just add the full email address and its password separated by a pipe.
|
|
|
|
Example:
|
|
|
|
user1@domain.tld|mypassword
|
|
user2@otherdomain.tld|myotherpassword
|
|
|
|
### Aliases
|
|
|
|
Please first read [Postfix documentation on virtual aliases](http://www.postfix.org/VIRTUAL_README.html#virtual_alias).
|
|
|
|
Aliases are managed in `postfix/virtual`.
|
|
An alias is a full email address that will be:
|
|
* delivered to an existing account in `postfix/accounts.cf`
|
|
* redirected to one or more other email adresses
|
|
|
|
Alias and target are space separated.
|
|
|
|
Example:
|
|
|
|
# Alias to existing account
|
|
alias1@domain.tld user1@domain.tld
|
|
|
|
# Forward to external email address
|
|
alias2@domain.tld external@gmail.com
|
|
|
|
## Environment variables
|
|
|
|
* DMS_SSL
|
|
* *empty* (default) => SSL disabled
|
|
* letsencrypt => Enables Let's Encrypt certificates
|
|
* self-signed => Enables self-signed certificates
|
|
* ENABLE_POP3
|
|
* *empty* (default) => POP3 service disabled
|
|
* 1 => Enables POP3 service
|
|
|
|
Please read [how the container starts](https://github.com/tomav/docker-mailserver/blob/master/start-mailserver.sh) to understand what's expected.
|
|
|
|
## SSL
|
|
|
|
Please read [the SSL page in the wiki](https://github.com/tomav/docker-mailserver/wiki/SSL) for more information.
|
|
|
|
## Todo
|
|
|
|
Things to do or to improve are stored on [Github](https://github.com/tomav/docker-mailserver/issues), some open by myself.
|
|
Feel free to improve this docker image.
|
|
|
|
## Contribute
|
|
|
|
- Fork
|
|
- Improve
|
|
- Add integration tests in `test/test.sh`
|
|
- Build image and run tests using `make`
|
|
- Document your improvements
|
|
- Commit, push and make a pull-request
|