mirror of
https://gitlab.com/simple-nixos-mailserver/nixos-mailserver.git
synced 2025-05-17 08:00:49 +05:00
README.md: reformat with markdownlint
This commit is contained in:
Martin Weinelt
parent
a7d580b934
commit
a6eb2a8f9a
88
README.md
88
README.md
@ -1,82 +1,82 @@
|
||||
# ![Simple Nixos MailServer][logo]
|
||||
|
||||
|
||||
[](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/commits/master)
|
||||
|
||||
|
||||
## Release branches
|
||||
|
||||
For each NixOS release, we publish a branch. You then have to use the
|
||||
SNM branch corresponding to your NixOS version.
|
||||
|
||||
* For NixOS 24.11
|
||||
- Use the [SNM branch `nixos-24.11`](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/tree/nixos-24.11)
|
||||
- [Documentation](https://nixos-mailserver.readthedocs.io/en/nixos-24.11/)
|
||||
- [Release notes](https://nixos-mailserver.readthedocs.io/en/nixos-24.11/release-notes.html#nixos-24-11)
|
||||
* Use the [SNM branch `nixos-24.11`](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/tree/nixos-24.11)
|
||||
* [Documentation](https://nixos-mailserver.readthedocs.io/en/nixos-24.11/)
|
||||
* [Release notes](https://nixos-mailserver.readthedocs.io/en/nixos-24.11/release-notes.html#nixos-24-11)
|
||||
* For NixOS 24.05
|
||||
- Use the [SNM branch `nixos-24.05`](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/tree/nixos-24.05)
|
||||
- [Documentation](https://nixos-mailserver.readthedocs.io/en/nixos-24.05/)
|
||||
- [Release notes](https://nixos-mailserver.readthedocs.io/en/nixos-24.05/release-notes.html#nixos-24-05)
|
||||
* Use the [SNM branch `nixos-24.05`](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/tree/nixos-24.05)
|
||||
* [Documentation](https://nixos-mailserver.readthedocs.io/en/nixos-24.05/)
|
||||
* [Release notes](https://nixos-mailserver.readthedocs.io/en/nixos-24.05/release-notes.html#nixos-24-05)
|
||||
* For NixOS unstable
|
||||
- Use the [SNM branch `master`](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/tree/master)
|
||||
- [Documentation](https://nixos-mailserver.readthedocs.io/en/latest/)
|
||||
* Use the [SNM branch `master`](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/tree/master)
|
||||
* [Documentation](https://nixos-mailserver.readthedocs.io/en/latest/)
|
||||
|
||||
## Features
|
||||
|
||||
* [x] Continous Integration Testing
|
||||
* [x] Multiple Domains
|
||||
* Postfix
|
||||
- [x] SMTP on port 25
|
||||
- [x] Submission TLS on port 465
|
||||
- [x] Submission StartTLS on port 587
|
||||
- [x] LMTP with Dovecot
|
||||
* [x] SMTP on port 25
|
||||
* [x] Submission TLS on port 465
|
||||
* [x] Submission StartTLS on port 587
|
||||
* [x] LMTP with Dovecot
|
||||
* Dovecot
|
||||
- [x] Maildir folders
|
||||
- [x] IMAP with TLS on port 993
|
||||
- [x] POP3 with TLS on port 995
|
||||
- [x] IMAP with StartTLS on port 143
|
||||
- [x] POP3 with StartTLS on port 110
|
||||
* [x] Maildir folders
|
||||
* [x] IMAP with TLS on port 993
|
||||
* [x] POP3 with TLS on port 995
|
||||
* [x] IMAP with StartTLS on port 143
|
||||
* [x] POP3 with StartTLS on port 110
|
||||
* Certificates
|
||||
- [x] ACME
|
||||
- [x] Custom certificates
|
||||
* [x] ACME
|
||||
* [x] Custom certificates
|
||||
* Spam Filtering
|
||||
- [x] Via Rspamd
|
||||
* [x] Via Rspamd
|
||||
* Virus Scanning
|
||||
- [x] Via ClamAV
|
||||
* [x] Via ClamAV
|
||||
* DKIM Signing
|
||||
- [x] Via Rspamd
|
||||
* [x] Via Rspamd
|
||||
* User Management
|
||||
- [x] Declarative user management
|
||||
- [x] Declarative password management
|
||||
- [x] LDAP users
|
||||
* [x] Declarative user management
|
||||
* [x] Declarative password management
|
||||
* [x] LDAP users
|
||||
* Sieve
|
||||
- [x] Allow user defined sieve scripts
|
||||
- [x] Moving mails from/to junk trains the Bayes filter
|
||||
- [x] ManageSieve support
|
||||
* [x] Allow user defined sieve scripts
|
||||
* [x] Moving mails from/to junk trains the Bayes filter
|
||||
* [x] ManageSieve support
|
||||
* User Aliases
|
||||
- [x] Regular aliases
|
||||
- [x] Catch all aliases
|
||||
* [x] Regular aliases
|
||||
* [x] Catch all aliases
|
||||
|
||||
### In the future
|
||||
|
||||
* Automatic client configuration
|
||||
- [ ] [Autoconfig](https://web.archive.org/web/20210624004729/https://developer.mozilla.org/en-US/docs/Mozilla/Thunderbird/Autoconfiguration)
|
||||
- [ ] [Autodiscovery](https://learn.microsoft.com/en-us/exchange/architecture/client-access/autodiscover?view=exchserver-2019)
|
||||
- [ ] [Mobileconfig](https://support.apple.com/guide/profile-manager/distribute-profiles-manually-pmdbd71ebc9/mac)
|
||||
* [ ] [Autoconfig](https://web.archive.org/web/20210624004729/https://developer.mozilla.org/en-US/docs/Mozilla/Thunderbird/Autoconfiguration)
|
||||
* [ ] [Autodiscovery](https://learn.microsoft.com/en-us/exchange/architecture/client-access/autodiscover?view=exchserver-2019)
|
||||
* [ ] [Mobileconfig](https://support.apple.com/guide/profile-manager/distribute-profiles-manually-pmdbd71ebc9/mac)
|
||||
* DKIM Signing
|
||||
- [ ] Allow per domain selectors
|
||||
- [ ] Allow passing DKIM signing keys
|
||||
* [ ] Allow per domain selectors
|
||||
* [ ] Allow passing DKIM signing keys
|
||||
* Improve the Forwarding Experience
|
||||
- [ ] Support [ARC](https://en.wikipedia.org/wiki/Authenticated_Received_Chain) signing with [Rspamd](https://rspamd.com/doc/modules/arc.html)
|
||||
- [ ] Support [SRS](https://en.wikipedia.org/wiki/Sender_Rewriting_Scheme) with [postsrsd](https://github.com/roehling/postsrsd)
|
||||
* [ ] Support [ARC](https://en.wikipedia.org/wiki/Authenticated_Received_Chain) signing with [Rspamd](https://rspamd.com/doc/modules/arc.html)
|
||||
* [ ] Support [SRS](https://en.wikipedia.org/wiki/Sender_Rewriting_Scheme) with [postsrsd](https://github.com/roehling/postsrsd)
|
||||
* User management
|
||||
- [ ] Allow local and LDAP user to coexist
|
||||
* [ ] Allow local and LDAP user to coexist
|
||||
* OpenID Connect
|
||||
- Depends on relevant clients adding support, e.g. [Thunderbird](https://bugzilla.mozilla.org/show_bug.cgi?id=1602166)
|
||||
* Depends on relevant clients adding support, e.g. [Thunderbird](https://bugzilla.mozilla.org/show_bug.cgi?id=1602166)
|
||||
|
||||
### Get in touch
|
||||
|
||||
- Matrix: [#nixos-mailserver:nixos.org](https://matrix.to/#/#nixos-mailserver:nixos.org)
|
||||
- IRC: `#nixos-mailserver` on [Libera Chat](https://libera.chat/guides/connect)
|
||||
* Matrix: [#nixos-mailserver:nixos.org](https://matrix.to/#/#nixos-mailserver:nixos.org)
|
||||
* IRC: `#nixos-mailserver` on [Libera Chat](https://libera.chat/guides/connect)
|
||||
|
||||
## How to Set Up a 10/10 Mail Server Guide
|
||||
|
||||
@ -89,16 +89,18 @@ For a complete list of options, [see in readthedocs](https://nixos-mailserver.re
|
||||
See the [How to Develop SNM](https://nixos-mailserver.readthedocs.io/en/latest/howto-develop.html) documentation page.
|
||||
|
||||
## Contributors
|
||||
|
||||
See the [contributor tab](https://gitlab.com/simple-nixos-mailserver/nixos-mailserver/-/graphs/master)
|
||||
|
||||
### Alternative Implementations
|
||||
|
||||
* [NixCloud Webservices](https://github.com/nixcloud/nixcloud-webservices)
|
||||
|
||||
### Credits
|
||||
|
||||
* send mail graphic by [tnp_dreamingmao](https://thenounproject.com/dreamingmao)
|
||||
from [TheNounProject](https://thenounproject.com/) is licensed under
|
||||
[CC BY 3.0](http://creativecommons.org/~/3.0/)
|
||||
* Logo made with [Logomakr.com](https://logomakr.com)
|
||||
|
||||
|
||||
[logo]: docs/logo.png
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user