Mirrors/go-chasquid-smtp
1
0
Fork 0
mirror of https://blitiri.com.ar/repos/chasquid synced 2026-01-07 17:47:14 +00:00
Code Releases Activity

README: Update links and shields

Browse Source 
This patch updates the README file, adjusting some of the existing
references, as well as adding new ones (mainly pointing to new
documentation).
This commit is contained in:
Alberto Bertogli
2019-10-25 15:39:00 +01:00
parent e8511e3f55
commit 809578cb57
1 changed files with 17 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -9,12 +9,12 @@ It is designed mainly for individuals and small groups.
It's written in [Go](https://golang.org), and distributed under the It's written in [Go](https://golang.org), and distributed under the
[Apache license 2.0](http://en.wikipedia.org/wiki/Apache_License). [Apache license 2.0](http://en.wikipedia.org/wiki/Apache_License).
[![Travis-CI build status](https://travis-ci.org/albertito/chasquid.svg?branch=master)](https://travis-ci.org/albertito/chasquid) [![Travis-CI status](https://travis-ci.org/albertito/chasquid.svg?branch=master)](https://travis-ci.org/albertito/chasquid)
[![pipeline status](https://gitlab.com/albertito/chasquid/badges/master/pipeline.svg)](https://gitlab.com/albertito/chasquid/commits/master) [![Gitlab CI status](https://gitlab.com/albertito/chasquid/badges/master/pipeline.svg)](https://gitlab.com/albertito/chasquid/pipelines)
[![Go Report Card](https://goreportcard.com/badge/github.com/albertito/chasquid)](https://goreportcard.com/report/github.com/albertito/chasquid) [![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) [![Coverage](https://img.shields.io/badge/coverage-next-brightgreen.svg)](https://blitiri.com.ar/p/chasquid/coverage.html)
[![GoDoc](https://godoc.org/blitiri.com.ar/go/chasquid?status.svg)](https://godoc.org/blitiri.com.ar/go/chasquid) [![Docs](https://img.shields.io/badge/docs-reference-blue.svg)](https://blitiri.com.ar/p/chasquid/docs/)
[![Freenode](https://img.shields.io/badge/chat-freenode-brightgreen.svg)](https://webchat.freenode.net?channels=%23chasquid) [![Freenode](https://img.shields.io/badge/chat-freenode-blue.svg)](https://webchat.freenode.net/#chasquid)
## Features ## Features
@@ -23,14 +23,14 @@ It's written in [Go](https://golang.org), and distributed under the
* Easy to configure. * Easy to configure.
* Hard to mis-configure in ways that are harmful or insecure (e.g. no open * Hard to mis-configure in ways that are harmful or insecure (e.g. no open
relay, or clear-text authentication). relay, or clear-text authentication).
* Monitoring HTTP server, with exported variables and tracing to help * [Monitoring] HTTP server, with exported variables and tracing to help
debugging. debugging.
* Integrated with [Debian] and [Ubuntu]. * Integrated with [Debian] and [Ubuntu].
* Supports using [Dovecot] for authentication. * Supports using [Dovecot] for authentication.
* Useful * Useful
* Multiple/virtual domains, with per-domain users and aliases. * Multiple/virtual domains, with per-domain users and aliases.
* Suffix dropping (`user+something@domain` → `user@domain`). * Suffix dropping (`user+something@domain` → `user@domain`).
* Hooks for integration with greylisting, anti-virus, anti-spam, and * [Hooks] for integration with greylisting, anti-virus, anti-spam, and
DKIM/DMARC. DKIM/DMARC.
* International usernames ([SMTPUTF8]) and domain names ([IDNA]). * International usernames ([SMTPUTF8]) and domain names ([IDNA]).
* Secure * Secure
@@ -40,22 +40,24 @@ It's written in [Go](https://golang.org), and distributed under the
* [SPF] and [MTA-STS] checking. * [SPF] and [MTA-STS] checking.
[SMTPUTF8]: https://en.wikipedia.org/wiki/Extended_SMTP#SMTPUTF8 [Debian]: https://debian.org
[Dovecot]: https://blitiri.com.ar/p/chasquid/docs/dovecot/
[Hooks]: https://blitiri.com.ar/p/chasquid/docs/hooks/
[IDNA]: https://en.wikipedia.org/wiki/Internationalized_domain_name [IDNA]: https://en.wikipedia.org/wiki/Internationalized_domain_name
[Let's Encrypt]: https://letsencrypt.org [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 [MTA-STS]: https://tools.ietf.org/html/rfc8461
[Debian]: https://debian.org [Monitoring]: https://blitiri.com.ar/p/chasquid/docs/monitoring/
[Ubuntu]: https://ubuntu.com [SMTPUTF8]: https://en.wikipedia.org/wiki/Extended_SMTP#SMTPUTF8
[SPF]: https://en.wikipedia.org/wiki/Sender_Policy_Framework
[Tracking]: https://blitiri.com.ar/p/chasquid/docs/sec-levels/ [Tracking]: https://blitiri.com.ar/p/chasquid/docs/sec-levels/
[Ubuntu]: https://ubuntu.com
## Documentation ## Documentation
The [how-to guide](docs/howto.md) and the [installation The [how-to guide](https://blitiri.com.ar/p/chasquid/docs/howto/) and the
guide](docs/install.md) are the best starting points on how to install, [installation guide](https://blitiri.com.ar/p/chasquid/docs/install/) are the
configure and run chasquid. best starting points on how to install, configure and run chasquid.
You will find [all documentation here](https://blitiri.com.ar/p/chasquid/docs/). You will find [all documentation here](https://blitiri.com.ar/p/chasquid/docs/).