| author | Alberto Bertogli
<albertito@blitiri.com.ar> 2018-03-02 20:25:42 UTC |
| committer | Alberto Bertogli
<albertito@blitiri.com.ar> 2018-03-03 14:04:21 UTC |
| parent | 0f7fb6b8c7d922968f0f76360f7ce40f8a644348 |
| README.md | +33 | -18 |
diff --git a/README.md b/README.md index 14726d9..7480618 100644 --- a/README.md +++ b/README.md @@ -6,30 +6,44 @@ It aims to be easy to configure and maintain for a small mail server, at the expense of flexibility and functionality. -It's written in [Go](https://golang.org). +It's written in [Go](https://golang.org), and distributed under the +[Apache license 2.0](http://en.wikipedia.org/wiki/Apache_License). + +[](https://travis-ci.org/albertito/chasquid) +[](https://goreportcard.com/report/github.com/albertito/chasquid) +[](https://coveralls.io/github/albertito/chasquid?branch=next) +[](https://godoc.org/blitiri.com.ar/go/chasquid) ## Features -* Easy to configure, hard to mis-configure in ways that are harmful or - insecure (e.g. no open relay, clear-text authentication, etc.). +* 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. -* SMTP UTF8 (international usernames). -* IDNA (international domain names). +* 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 letsencrypt. -* SPF checking. +* 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. -* Using dovecot for authentication (experimental). +* Supports using [Dovecot] for authentication (experimental). The following are intentionally *not* implemented: -* Custom email routing and transport. -* DKIM/DMARC checking (although the post-data hook can be used for it). +* Custom email routing. +* [DKIM]/[DMARC] checking (although the post-data hook can be used for it). + +[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 ## Status @@ -40,7 +54,14 @@ It's functional and has had some production exposure, but some things may still change in backwards-incompatible way, including the configuration format. It should be rare and will be avoided if possible. -You should subscribe to the mailing list to get notifications of such changes. +You can subscribe to the mailing list to get notifications of such changes, +and they are also documented in the [UPGRADING](UPGRADING.md). + + +## 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. ## Contact @@ -53,9 +74,3 @@ To subscribe, send an email to chasquid+subscribe@googlegroups.com. You can also browse the [archives](https://groups.google.com/forum/#!forum/chasquid). - -## 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. -