summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormdecimus <mauro@stalw.art>2024-09-19 20:01:01 +0200
committermdecimus <mauro@stalw.art>2024-09-19 20:01:01 +0200
commit180a856cb4dd57299b09c6bd0649bfe9ec6172dc (patch)
tree69096aabbbdf7f7b301d64f3c1e081fba3f0cc1b
parentab7f17d5d970c85f29b583d9e70c99e18b4f41d6 (diff)
Updated features
-rw-r--r--README.md62
1 files changed, 26 insertions, 36 deletions
diff --git a/README.md b/README.md
index a2677509..91ca0910 100644
--- a/README.md
+++ b/README.md
@@ -11,39 +11,23 @@
<br>
<p align="center">
- <a href="https://github.com/stalwartlabs/mail-server/actions/workflows/build.yml">
- <img src="https://img.shields.io/github/actions/workflow/status/stalwartlabs/mail-server/build.yml?style=flat-square" alt="continuous integration">
- </a>
+ <a href="https://github.com/stalwartlabs/mail-server/actions/workflows/build.yml"><img src="https://img.shields.io/github/actions/workflow/status/stalwartlabs/mail-server/build.yml?style=flat-square" alt="continuous integration"></a>
&nbsp;
- <a href="https://www.gnu.org/licenses/agpl-3.0">
- <img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?label=license&style=flat-square" alt="License: AGPL v3">
- </a>
+ <a href="https://www.gnu.org/licenses/agpl-3.0"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg?label=license&style=flat-square" alt="License: AGPL v3"></a>
&nbsp;
- <a href="https://stalw.art/docs/get-started/">
- <img src="https://img.shields.io/badge/read_the-docs-red?style=flat-square" alt="Documentation">
- </a>
+ <a href="https://stalw.art/docs/get-started/"><img src="https://img.shields.io/badge/read_the-docs-red?style=flat-square" alt="Documentation"></a>
</p>
<p align="center">
- <a href="https://mastodon.social/@stalwartlabs">
- <img src="https://img.shields.io/mastodon/follow/109929667531941122?style=flat-square&logo=mastodon&color=%236364ff&label=Follow%20on%20Mastodon" alt="Mastodon">
- </a>
+ <a href="https://mastodon.social/@stalwartlabs"><img src="https://img.shields.io/mastodon/follow/109929667531941122?style=flat-square&logo=mastodon&color=%236364ff&label=Follow%20on%20Mastodon" alt="Mastodon"></a>
&nbsp;
- <a href="https://twitter.com/stalwartlabs">
- <img src="https://img.shields.io/twitter/follow/stalwartlabs?style=flat-square&logo=x&label=Follow%20on%20Twitter" alt="Twitter">
- </a>
+ <a href="https://twitter.com/stalwartlabs"><img src="https://img.shields.io/twitter/follow/stalwartlabs?style=flat-square&logo=x&label=Follow%20on%20Twitter" alt="Twitter"></a>
&nbsp;
- <a href="nostr:npub167hk2ermhky3pmudc3q0d2vnnhcesdgsrcqgywv447ls4xs5u89q5d6395">
- <img src="https://img.shields.io/nostr-band/followers/npub167hk2ermhky3pmudc3q0d2vnnhcesdgsrcqgywv447ls4xs5u89q5d6395?style=flat-square&logo=chatbot&label=Follow%20on%20Nostr" alt="Nostr">
- </a>
+ <a href="nostr:npub167hk2ermhky3pmudc3q0d2vnnhcesdgsrcqgywv447ls4xs5u89q5d6395"><img src="https://img.shields.io/nostr-band/followers/npub167hk2ermhky3pmudc3q0d2vnnhcesdgsrcqgywv447ls4xs5u89q5d6395?style=flat-square&logo=chatbot&label=Follow%20on%20Nostr" alt="Nostr"></a>
</p>
<p align="center">
- <a href="https://discord.gg/jtgtCNj66U">
- <img src="https://img.shields.io/discord/923615863037390889?label=Join%20Discord&logo=discord&style=flat-square" alt="Discord">
- </a>
+ <a href="https://discord.gg/jtgtCNj66U"><img src="https://img.shields.io/discord/923615863037390889?label=Join%20Discord&logo=discord&style=flat-square" alt="Discord"></a>
&nbsp;
- <a href="https://matrix.to/#/#stalwart:matrix.org">
- <img src="https://img.shields.io/matrix/stalwartmail%3Amatrix.org?label=Join%20Matrix&logo=matrix&style=flat-square" alt="Matrix">
- </a>
+ <a href="https://matrix.to/#/#stalwart:matrix.org"><img src="https://img.shields.io/matrix/stalwartmail%3Amatrix.org?label=Join%20Matrix&logo=matrix&style=flat-square" alt="Matrix"></a>
</p>
## Features
@@ -84,27 +68,33 @@ Key features:
- Sieve scripting language with support for all [registered extensions](https://www.iana.org/assignments/sieve-extensions/sieve-extensions.xhtml).
- Email aliases, mailing lists, subaddressing and catch-all addresses support.
- Automatic account configuration and discovery with [autoconfig](https://www.ietf.org/id/draft-bucksch-autoconfig-02.html) and [autodiscover](https://learn.microsoft.com/en-us/exchange/architecture/client-access/autodiscover?view=exchserver-2019).
- - Metrics, tracing, logging and alerts with **OpenTelemetry** and **Prometheus** integration.
- - Webhooks for event-driven automation.
- - Disk quotas.
-- **Web-based administration**:
- - Account, domain, group and mailing list management.
- - SMTP queue management for messages and outbound DMARC and TLS reports.
- - Report visualization interface for received DMARC, TLS-RPT and Failure (ARF) reports.
- - Configuration of every aspect of the mail server.
- - Log viewer with search and filtering capabilities.
- - Self-service portal for password reset and encryption-at-rest key management.
+ - Multi-tenancy support with domain and tenant isolation.
+ - Disk quotas per user and tenant.
- **Secure and robust**:
- Encryption at rest with **S/MIME** or **OpenPGP**.
- Automatic TLS certificate provisioning with [ACME](https://datatracker.ietf.org/doc/html/rfc8555) using `TLS-ALPN-01`, `DNS-01` or `HTTP-01` challenges.
- OAuth 2.0 [authorization code](https://www.rfc-editor.org/rfc/rfc8628) and [device authorization](https://www.rfc-editor.org/rfc/rfc8628) flows.
- Two-factor authentication with Time-based One-Time Passwords (`2FA-TOTP`)
- Application passwords (App Passwords).
- - Automated blocking of hosts that cause multiple authentication errors (aka **fail2ban**).
- - Access Control Lists (ACLs).
+ - Automated blocking of hosts that perform brute-force attacks or scans (aka **fail2ban**).
+ - Roles, permissions and Access Control Lists (ACLs).
- Rate limiting.
- Security audited (read the [report](https://stalw.art/blog/security-audit)).
- Memory safe (thanks to Rust).
+- **Observability**:
+ - Logging and tracing with **OpenTelemetry**, journald, log files and console support.
+ - Metrics with **OpenTelemetry** and **Prometheus** integration.
+ - Webhooks for event-driven automation.
+ - Alerts with email and webhook notifications.
+ - Live tracing and metrics.
+- **Web-based administration**:
+ - Dashboard with real-time statistics and monitoring.
+ - Account, domain, group and mailing list management.
+ - SMTP queue management for messages and outbound DMARC and TLS reports.
+ - Report visualization interface for received DMARC, TLS-RPT and Failure (ARF) reports.
+ - Configuration of every aspect of the mail server.
+ - Log viewer with search and filtering capabilities.
+ - Self-service portal for password reset and encryption-at-rest key management.
## Screenshots