mirror of
https://blitiri.com.ar/repos/chasquid
synced 2026-01-20 19:45:54 +00:00
d348477841
This patch adds configuration to integrate with readthedocs.org, using mkdocs as rendering engine. It also does minor documentation updates, to tidy some things up (clearer titles, move some documentation from the root into docs/, etc).
75 lines
3.0 KiB
Markdown
75 lines
3.0 KiB
Markdown
|
|
# chasquid
|
|
|
|
[chasquid](https://blitiri.com.ar/p/chasquid) is an SMTP (email) server with a
|
|
focus on simplicity, security, and ease of operation.
|
|
|
|
It is designed mainly for individuals and small groups.
|
|
|
|
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://gitlab.com/albertito/chasquid/commits/master)
|
|
[](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://chasquid.readthedocs.io/en/latest/?badge=latest)
|
|
[](https://webchat.freenode.net?channels=%23chasquid)
|
|
|
|
|
|
## Features
|
|
|
|
* 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.
|
|
* 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] and [MTA-STS] 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
|
|
[MTA-STS]: https://tools.ietf.org/html/rfc8461
|
|
[Debian]: https://debian.org
|
|
[Ubuntu]: https://ubuntu.com
|
|
|
|
|
|
## Documentation
|
|
|
|
The [how-to guide](docs/howto.md) and the [installation
|
|
guide](docs/install.md) are the best starting points on how to install,
|
|
configure and run chasquid.
|
|
|
|
You will find [all documentation here](https://chasquid.readthedocs.io).
|
|
|
|
|
|
## Contact
|
|
|
|
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 reach out via IRC, `#chasquid` on
|
|
[freenode](https://freenode.net/).
|
|
|
|
|