mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2024-01-19 02:48:50 +00:00
e12b032f77
* docs: change some absolute links to relative links * docs: change most hard-coded links to `edge` to point to `latest` * Apply suggestions from code review * docs: revert 404 page to edge and change canonical link to `latest --------- Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com> Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com>
50 lines
3.7 KiB
Markdown
50 lines
3.7 KiB
Markdown
# Docker Mailserver
|
|
|
|
[![ci::status]][ci::github] [![docker::pulls]][docker::hub] [![documentation::badge]][documentation::web]
|
|
|
|
[ci::status]: https://img.shields.io/github/actions/workflow/status/docker-mailserver/docker-mailserver/default_on_push.yml?branch=master&color=blue&label=CI&logo=github&logoColor=white&style=for-the-badge
|
|
[ci::github]: https://github.com/docker-mailserver/docker-mailserver/actions
|
|
[docker::pulls]: https://img.shields.io/docker/pulls/mailserver/docker-mailserver.svg?style=for-the-badge&logo=docker&logoColor=white
|
|
[docker::hub]: https://hub.docker.com/r/mailserver/docker-mailserver/
|
|
[documentation::badge]: https://img.shields.io/badge/DOCUMENTATION-GH%20PAGES-0078D4?style=for-the-badge&logo=git&logoColor=white
|
|
[documentation::web]: https://docker-mailserver.github.io/docker-mailserver/latest/
|
|
|
|
## :page_with_curl: About
|
|
|
|
A production-ready fullstack but simple containerized mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.). Only configuration files, no SQL database. Keep it simple and versioned. Easy to deploy and upgrade. Originally created by @tomav, this project is now maintained by volunteers since January 2021.
|
|
|
|
## :bulb: Documentation
|
|
|
|
We provide a [dedicated documentation][documentation::web] hosted on GitHub Pages. Make sure to read it as it contains all the information necessary to set up and configure your mail server. The documentation is crafted with Markdown & [MkDocs Material](https://squidfunk.github.io/mkdocs-material/).
|
|
|
|
## :boom: Issues
|
|
|
|
If you have issues, please search through [the documentation][documentation::web] **for your version** before opening an issue. The issue tracker is for issues, not for personal support. Make sure the version of the documentation matches the image version you're using!
|
|
|
|
## :link: Links to Useful Resources
|
|
|
|
1. [FAQ](https://docker-mailserver.github.io/docker-mailserver/latest/faq/)
|
|
2. [Usage](https://docker-mailserver.github.io/docker-mailserver/latest/usage/)
|
|
3. [Examples](https://docker-mailserver.github.io/docker-mailserver/latest/examples/tutorials/basic-installation/)
|
|
4. [Issues and Contributing](https://docker-mailserver.github.io/docker-mailserver/latest/contributing/issues-and-pull-requests/)
|
|
5. [Release Notes](./CHANGELOG.md)
|
|
6. [Environment Variables](https://docker-mailserver.github.io/docker-mailserver/latest/config/environment/)
|
|
7. [Updating](https://docker-mailserver.github.io/docker-mailserver/latest/faq/#how-do-i-update-dms)
|
|
|
|
## :package: Included Services
|
|
|
|
- [Postfix](http://www.postfix.org) with SMTP or LDAP authentication and support for [extension delimiters](http://www.postfix.org/postconf.5.html#recipient_delimiter) (_mail to `you+extension@example.com` delivered to `you@example.com`_)
|
|
- [Dovecot](https://www.dovecot.org) with SASL, IMAP, POP3, LDAP, [basic Sieve support](https://docker-mailserver.github.io/docker-mailserver/latest/config/advanced/mail-sieve) and [quotas](https://docker-mailserver.github.io/docker-mailserver/latest/config/user-management/accounts#notes)
|
|
- [Rspamd](https://rspamd.com/)
|
|
- [Amavis](https://www.amavis.org/)
|
|
- [SpamAssassin](http://spamassassin.apache.org/) supporting custom rules
|
|
- [ClamAV](https://www.clamav.net/) with automatic updates
|
|
- [OpenDKIM](http://www.opendkim.org) & [OpenDMARC](https://github.com/trusteddomainproject/OpenDMARC)
|
|
- [Fail2ban](https://www.fail2ban.org/wiki/index.php/Main_Page)
|
|
- [Fetchmail](http://www.fetchmail.info/fetchmail-man.html)
|
|
- [Postscreen](http://www.postfix.org/POSTSCREEN_README.html)
|
|
- [Postgrey](https://postgrey.schweikert.ch/)
|
|
- Support for [LetsEncrypt](https://letsencrypt.org/), manual and self-signed certificates
|
|
- A [setup script](https://docker-mailserver.github.io/docker-mailserver/latest/config/setup.sh) for easy configuration and maintenance
|
|
- SASLauthd with LDAP authentication
|