README.md 3.34 KB
Newer Older
1 2 3

# chasquid

4 5
[chasquid](https://blitiri.com.ar/p/chasquid) is an SMTP (email) server with a
focus on simplicity, security, and ease of operation.
6

7 8 9
It's written in [Go](https://golang.org), and distributed under the
[Apache license 2.0](http://en.wikipedia.org/wiki/Apache_License).

10 11
[![Travis-CI build status](https://travis-ci.org/albertito/chasquid.svg?branch=master)](https://travis-ci.org/albertito/chasquid)
[![Codefresh build status](https://g.codefresh.io/api/badges/build?repoOwner=albertito&repoName=chasquid&branch=master&pipelineName=chasquid&accountName=albertito&type=cf-1)](https://g.codefresh.io/repositories/albertito/chasquid/builds?filter=trigger:build;branch:master;service:5abec627df25930001c9940d~chasquid)
12 13 14
[![Go Report Card](https://goreportcard.com/badge/github.com/albertito/chasquid)](https://goreportcard.com/report/github.com/albertito/chasquid)
[![Coverage Status](https://coveralls.io/repos/github/albertito/chasquid/badge.svg?branch=next)](https://coveralls.io/github/albertito/chasquid?branch=next)
[![GoDoc](https://godoc.org/blitiri.com.ar/go/chasquid?status.svg)](https://godoc.org/blitiri.com.ar/go/chasquid)
15
[![Freenode](https://img.shields.io/badge/chat-freenode-brightgreen.svg)](https://webchat.freenode.net?channels=%23chasquid)
16 17 18 19


## Features

20 21 22 23 24 25 26
* 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].
27
    * Supports using [Dovecot] for authentication.
28 29 30 31 32 33 34 35 36 37
* 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].
38
    * [SPF] and [MTA-STS] checking.
39

40 41 42 43 44 45

[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
46
[MTA-STS]: https://datatracker.ietf.org/doc/draft-ietf-uta-mta-sts/
47 48
[Debian]: https://debian.org
[Ubuntu]: https://ubuntu.com
49 50 51 52 53 54 55 56 57 58


## Status

chasquid is in beta.

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.

59
You can subscribe to the mailing list to get notifications of such changes,
60
which are also documented in the [UPGRADING](UPGRADING.md) file.
61 62 63 64


## Documentation

65 66 67
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.
68 69 70 71


## Contact

72 73 74
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.
75 76 77

To subscribe, send an email to chasquid+subscribe@googlegroups.com.

78 79 80
You can also reach out via IRC, `#chasquid` on
[freenode](https://freenode.net/).

81