| author | Alberto Bertogli
<albertito@blitiri.com.ar> 2018-05-20 10:55:01 UTC |
| committer | Alberto Bertogli
<albertito@blitiri.com.ar> 2018-05-20 11:05:32 UTC |
| parent | ead3e73c49731b86d2dc3f18cad3ec0d85648cd2 |
| README.md | +34 | -31 |
diff --git a/README.md b/README.md index f4e62dd..20176de 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ # chasquid -[chasquid](https://blitiri.com.ar/p/chasquid) is an SMTP (email) server. - -It aims to be easy to configure and maintain for a small mail server, at the -expense of flexibility and functionality. +[chasquid](https://blitiri.com.ar/p/chasquid) is an SMTP (email) server with a +focus on simplicity, security, and ease of operation. It's written in [Go](https://golang.org), and distributed under the [Apache license 2.0](http://en.wikipedia.org/wiki/Apache_License). @@ -14,37 +12,39 @@ It's written in [Go](https://golang.org), and distributed under the [](https://goreportcard.com/report/github.com/albertito/chasquid) [](https://coveralls.io/github/albertito/chasquid?branch=next) [](https://godoc.org/blitiri.com.ar/go/chasquid) +[](https://webchat.freenode.net?channels=%23chasquid) ## Features -* Easy to configure. -* Hard to mis-configure in ways that are harmful or insecure (e.g. no open - relay, or clear-text authentication). -* Tracking of per-domain TLS support, prevents connection downgrading. -* International usernames ([SMTPUTF8]) and domain names ([IDNA]). -* Hooks for easy integration with greylisting, anti-virus and anti-spam. -* Multiple domains, with per-domain user database and aliases. -* Multiple TLS certificates. -* Suffix dropping (`user+something@domain` → `user@domain`). -* Easy integration with [Let's Encrypt]. -* [SPF] checking. -* Monitoring HTTP server, with exported variables and tracing to help - debugging. -* Supports using [Dovecot] for authentication (experimental). - -The following are intentionally *not* implemented: - -* Custom email routing. -* [DKIM]/[DMARC] checking (although the post-data hook can be used for it). +* Easy + * Easy to configure. + * Hard to mis-configure in ways that are harmful or insecure (e.g. no open + relay, or clear-text authentication). + * Monitoring HTTP server, with exported variables and tracing to help + debugging. + * Integrated with [Debian] and [Ubuntu]. + * Supports using [Dovecot] for authentication (experimental). +* Useful + * Multiple/virtual domains, with per-domain users and aliases. + * Suffix dropping (`user+something@domain` → `user@domain`). + * Hooks for integration with greylisting, anti-virus, anti-spam, and + DKIM/DMARC. + * International usernames ([SMTPUTF8]) and domain names ([IDNA]). +* Secure + * Tracking of per-domain TLS support, prevents connection downgrading. + * Multiple TLS certificates. + * Easy integration with [Let's Encrypt]. + * [SPF] checking. + [SMTPUTF8]: https://en.wikipedia.org/wiki/Extended_SMTP#SMTPUTF8 [IDNA]: https://en.wikipedia.org/wiki/Internationalized_domain_name [Let's Encrypt]: https://letsencrypt.org [Dovecot]: https://dovecot.org [SPF]: https://en.wikipedia.org/wiki/Sender_Policy_Framework -[DKIM]: https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail -[DMARC]: https://en.wikipedia.org/wiki/DMARC +[Debian]: https://debian.org +[Ubuntu]: https://ubuntu.com ## Status @@ -61,17 +61,20 @@ which are also documented in the [UPGRADING](UPGRADING.md) file. ## Documentation -Check out the [how-to](docs/howto.md) or the [installation guide](INSTALL.md) -for more details on how to install and configure chasquid. +The [Debian+Dovecot+chasquid how-to](docs/howto.md) and the +[installation guide](INSTALL.md) +are the best starting points on how to install, configure and run chasquid. ## Contact -If you have any questions, comments or patches please send them to the mailing -list, chasquid@googlegroups.com. +If you have any questions, comments or patches please send them to the [mailing +list](https://groups.google.com/forum/#!forum/chasquid), +chasquid@googlegroups.com. To subscribe, send an email to chasquid+subscribe@googlegroups.com. -You can also browse the -[archives](https://groups.google.com/forum/#!forum/chasquid). +You can also reach out via IRC, `#chasquid` on +[freenode](https://freenode.net/). +