2021-01-16 10:16:05 +01:00
# Docker Mailserver
2016-06-25 10:57:46 +02:00
2021-04-01 22:44:31 +02:00
[![ci::status]][ci::github] [![docker::pulls]][docker::hub] [![documentation::badge]][documentation::web]
2020-12-22 11:08:50 +01:00
2022-12-23 14:32:06 +01:00
[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
2021-01-16 10:16:05 +01:00
[ci::github]: https://github.com/docker-mailserver/docker-mailserver/actions
2024-01-27 13:51:37 +01:00
[docker::pulls]: https://img.shields.io/docker/pulls/mailserver/docker-mailserver.svg?style=for-the-badge& logo=docker& logoColor=white& color=blue
2021-01-16 10:16:05 +01:00
[docker::hub]: https://hub.docker.com/r/mailserver/docker-mailserver/
2024-01-27 13:51:37 +01:00
[documentation::badge]: https://img.shields.io/badge/DOCUMENTATION-GH%20PAGES-0078D4?style=for-the-badge& logo=googledocs& logoColor=white
2023-03-22 11:43:10 +01:00
[documentation::web]: https://docker-mailserver.github.io/docker-mailserver/latest/
2020-12-19 13:17:48 +01:00
2023-02-19 13:25:14 +01:00
## :page_with_curl: About
2022-02-23 18:22:44 +01:00
2024-01-27 13:51:37 +01:00
A production-ready fullstack but simple containerized mail server (SMTP, IMAP, LDAP, Anti-spam, Anti-virus, etc.).
- Only configuration files, no SQL database. Keep it simple and versioned. Easy to deploy and upgrade.
- Originally created by [@tomav ](https://github.com/tomav ), this project is now maintained by volunteers since January 2021.
2015-03-28 16:44:40 +01:00
2024-01-27 13:51:37 +01:00
## <!-- Adds a thin line break separator style -->
2020-09-09 17:19:48 +02:00
2024-01-27 13:51:37 +01:00
> [!TIP]
> Be sure to read [our documentation][documentation::web]. It provides guidance on initial setup of your mail server.
2023-02-19 13:25:14 +01:00
2024-01-27 13:51:37 +01:00
> [!IMPORTANT]
> 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!
2023-02-19 13:25:14 +01:00
## :link: Links to Useful Resources
2023-03-22 11:43:10 +01:00
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/ )
2023-02-19 13:25:14 +01:00
5. [Release Notes ](./CHANGELOG.md )
2023-03-22 11:43:10 +01:00
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 )
2020-03-16 18:38:28 +01:00
2023-02-19 13:25:14 +01:00
## :package: Included Services
2015-03-29 14:07:56 +02:00
docs: Refactor pages for Account Management (#4122)
* docs: Relocate account / auth pages into a common section
* docs: Update references to relocated pages
* docs: Add account management overview page
Updates remaining links to account sections on this page instead (_for `accounts`, `aliases`, `quotas`_).
This page will cover the features and defer to separate pages for more specific content where relevant.
* docs: Correct relocated pages titles and links
* docs: Accounts (Dovecot Master) - Minor revisions
* docs: Fix highlighting roundcube PHP snippet in OAuth2 page
* docs: Accounts (File) - Refactor
- Manual method not necessary to document.
- Condense `setup` example guidance.
- Quotas / Aliases content migrated to Overview when not specific about file provisioner.
Some of the content is this commit is not a complete revision.
* chore: Temporary commit
* docs(refactor): Sub-addressing section
Much better docs on the sub-addressing feature supported by Postfix and Dovecot, along with the guidance with usage in Sieve.
* docs: Revise accounts section
Add some context regarding DMS accounts and their distinction/overlap from the email address functionality, and it's relevant context for receiving/sending.
File provisioner, minor revisions to referencing associated config files and account management.
* docs: Minor adjustments
* docs: Refactor the quota section
Better documented with links and coverage over the workaround details we've implemented.
* docs: Revise the quota section
Minor revisions with phrasing, admonitions for structure and better explanation of the feature functionality/purpose.
* docs: Alias section refactor
Extensively covers known issues and technical details that have been discussed often enough.
The improvements should benefit both users and maintainers.
* docs: Refactor master accounts page
This rewrite should more clearly document the feature, along with a better example and additional links for reference.
* docs: OAuth2 revision
Minor update to this page:
- Links extracted to bottom of page as per convention.
- ENV file example converted to preferred `compose.yaml` ENV settings.
* docs: Sieve minor revisions
- Correct link to subaddressing section
- Make the config file example snippets intended filename less ambiguous.
- Minor rephrasng.
* docs: Revise accounts overview section
Revised the account section and added additional clarity for common confusion with relation to sender address and multi-domain support.
Top of the page now clarifies it's a technical reference and directs users to the related pages for configuration / caveats.
Technical Overview links to Dovecot docs were missing.
* docs: Another revision pass
File based provisioner docs:
- Sections indent with info admonitions.
- Accounts section expanded with config format and example.
- Quotas section expanded and shifted to bottom (alphabetical sort).
- Split into `setup` CLI and config reference groups.
Overview page:
- Sections indent with info admonitions.
- Revised content.
* docs(chore): Shift sub-addressing section
This is related to accounts and aliases, but not provisioners, thus extract out of the accounts parent section.
* docs: Document `postfix-accounts.cf` third column
This lacked documentation but was community contributed feature to allow further customization of a Dovecot Account.
It has caveats as DMS does not take these into consideration anywhere in scripts. Documenting officially for better awareness.
* docs: Revise and expand supplementary pages
Better outline the OAuth2 login process, the two supported login mechanisms and their docs/rfcs, along with documenting caveat with mail client compatibility.
Add a verification tip for the OAuth2 support, showing how `curl` can be used, along with caveat presently affecting the `curl` in DMS v14.
Additionally note the feature still isn't documented fully, providing the user with additional references for more information.
`ACCOUNT_PROVISIONER` ENV docs minimized. No `OIDC` provisioner plans, the OAuth2 docs page now mentions SCIM 2.0 API as the next step towards resolving that concern. The tip admonition was removed as it no longer provides value, instead we link to the Account Management overview page.
Dovecot Master Accounts docs page now lightly document the `setup` CLI and config format for the feature.
* docs: Fix broken anchor links
Some anchor links to different parts of our docs have gone stale. This branch also broke a few itself that I missed.
The build now only reports issues with anchor links to Content Tabs, which it must not be aware of during the build (_MKDocs Material specific feature?_)
* docs(lint): Fix indentation level
* chore: Add entry to `CHANGELOG.md` + corrections
2024-07-22 00:00:53 +02:00
- [Postfix ](http://www.postfix.org ) with SMTP or LDAP authentication and support for [extension delimiters ](https://docker-mailserver.github.io/docker-mailserver/latest/config/account-management/overview/#aliases )
- [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/account-management/overview/#quotas )
2023-02-19 12:36:43 +01:00
- [Rspamd ](https://rspamd.com/ )
2019-08-31 09:15:42 +02:00
- [Amavis ](https://www.amavis.org/ )
2021-03-28 22:07:52 +02:00
- [SpamAssassin ](http://spamassassin.apache.org/ ) supporting custom rules
2019-08-31 09:15:42 +02:00
- [ClamAV ](https://www.clamav.net/ ) with automatic updates
2023-02-19 13:25:14 +01:00
- [OpenDKIM ](http://www.opendkim.org ) & [OpenDMARC ](https://github.com/trusteddomainproject/OpenDMARC )
2019-08-31 09:15:42 +02:00
- [Fail2ban ](https://www.fail2ban.org/wiki/index.php/Main_Page )
- [Fetchmail ](http://www.fetchmail.info/fetchmail-man.html )
2023-05-23 17:25:08 +02:00
- [Getmail6 ](https://getmail6.org/documentation.html )
2019-08-31 09:15:42 +02:00
- [Postscreen ](http://www.postfix.org/POSTSCREEN_README.html )
- [Postgrey ](https://postgrey.schweikert.ch/ )
2023-02-19 13:25:14 +01:00
- Support for [LetsEncrypt ](https://letsencrypt.org/ ), manual and self-signed certificates
2023-03-22 11:43:10 +01:00
- A [setup script ](https://docker-mailserver.github.io/docker-mailserver/latest/config/setup.sh ) for easy configuration and maintenance
2023-02-19 13:25:14 +01:00
- SASLauthd with LDAP authentication
2024-01-12 21:45:14 +01:00
- OAuth2 authentication (_via `XOAUTH2` or `OAUTHBEARER` SASL mechanisms_)
