Mirrors/go-chasquid-smtp
1
0
Fork 0
mirror of https://blitiri.com.ar/repos/chasquid synced 2026-10-29 15:02:30 +00:00
Code Releases Activity

docs: Auto-format markdown documentation

Browse Source 
This patch uses mdformat to auto-format markdown documentation.

To support \ for line breaks (which is what mdformat uses), mkdocs now
requires the pymdownx.escapeall extension.

Because of incompatibilities between mdformat (which formats to
CommonMark) and mkdocs (which expects Python-Markdown), there are now
some limitations: no nested lists, multi-paragraph list items, or
admonitions support.

These limitations are acceptable for now, although some of the docs had
to be adjusted to meet them.
This commit is contained in:
Alberto Bertogli
2026-10-14 15:14:42 +01:00
parent 6cc59ca661
commit 9a59bd77d1
22 changed files with 355 additions and 493 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/relnotes.md
+19 -47
View File
@@ -1,10 +1,8 @@
# Release notes
This file contains notes for each release, summarizing changes and explicitly
noting backward-incompatible changes or known security issues.
## 1.18.0 (2026-06-07)
- Conform to the stricter OpenMetrics format in the monitoring exporter, which
@@ -12,7 +10,6 @@ noting backward-incompatible changes or known security issues.
- Fix extra newlines in the authentication log entries.
- Docker image improvements, including updating the Dovecot config to 2.4.
## 1.17.0 (2025-11-30)
- Fix `Received` header format when including the IP address.
@@ -20,7 +17,6 @@ noting backward-incompatible changes or known security issues.
- Docker image improvements and bug fixes.
- Minor fixes for systems without /bin.
## 1.16.0 (2025-06-08)
- Minor bug fixes to `chasquid-util`.
@@ -31,7 +27,6 @@ noting backward-incompatible changes or known security issues.
- Make the max queue size and give up time
[configurable](man/chasquid.conf.5.md) *(experimental)*.
## 1.15.0 (2025-01-17)
- Exit if there's an error reading users/aliases files on startup.
@@ -40,15 +35,14 @@ noting backward-incompatible changes or known security issues.
### 1.15.1 (2025-03-30)
Implement a workaround for a Microsoft bug in TLS session ticket handling,
that is causing deliverability issues, and they are being too slow at fixing.
Implement a workaround for a Microsoft bug in TLS session ticket handling, that
is causing deliverability issues, and they are being too slow at fixing.
See this [chasquid issue](https://github.com/albertito/chasquid/issues/64),
this [Go issue](https://github.com/golang/go/issues/70232) and this
[Postfix thread](https://www.mail-archive.com/postfix-users@postfix.org/msg104308.html)
for more details.
## 1.14.0 (2024-04-21)
- Add built-in [DKIM](dkim.md) signing and verification.
@@ -59,17 +53,16 @@ for more details.
[SemVer](https://semver.org/)-compatible, to help integration with other
software that expects it (e.g. [pkg.go.dev](https://pkg.go.dev/)).
## 1.13 (2023-12-24)
Security fixes:
- Strict CRLF enforcement in DATA contents, to prevent [SMTP smuggling
attacks](https://www.postfix.org/smtp-smuggling.html)
- Strict CRLF enforcement in DATA contents, to prevent
[SMTP smuggling attacks](https://www.postfix.org/smtp-smuggling.html)
([CVE-2023-52354](https://nvd.nist.gov/vuln/detail/CVE-2023-52354)). \
[RFC5322](https://www.rfc-editor.org/rfc/rfc5322#section-2.3) and
[RFC5321](https://www.rfc-editor.org/rfc/rfc5321#section-2.3.8) say
that the only valid newline terminator in SMTP is CRLF. \
[RFC5321](https://www.rfc-editor.org/rfc/rfc5321#section-2.3.8) say that the
only valid newline terminator in SMTP is CRLF. \
When an invalid newline terminator is found in an incoming message, the
connection is now aborted immediately (previous releases also accepted
LF-terminated lines). \
@@ -84,11 +77,10 @@ Other changes:
entry in the config.
- `docker/add-user.sh`: Support getting email and password from env variables.
## 1.12 (2023-10-07)
- Support [aliases with drop characters and
suffix separators](aliases.md#drop-characters-and-suffix-separators).
- Support
[aliases with drop characters and suffix separators](aliases.md#drop-characters-and-suffix-separators).
- Improved delivery on some low-level TLS negotiation errors.
- `smtp-check`: Add flag to specify local name.
- `chasquid-util`: `aliases-resolve` and `domaininfo-remove` subcommands now
@@ -98,7 +90,6 @@ Other changes:
command that was added a while ago, and there is no need for it anymore.
- Handle symlinks under the `certs/` directory.
## 1.11 (2023-02-19)
- New tracing library for improved observability.
@@ -110,14 +101,12 @@ Backport the security fixes from 1.13 (*Strict CRLF enforcement in DATA
contents*, fixes
[CVE-2023-52354](https://nvd.nist.gov/vuln/detail/CVE-2023-52354)).
## 1.10 (2022-09-01)
- Support [catch-all aliases](aliases.md#catch-all).
- Fix bug in Docker image with user-provided certificates.
- Miscellaneous test improvements.
## 1.9 (2022-03-05)
- Improve certificate validation logic in the SMTP courier.
@@ -125,11 +114,10 @@ contents*, fixes
- Support `""` values for `drop_characters` and `suffix_separators` in the
configuration file.
## 1.8 (2021-07-30)
- Stricter error checking to help prevent cross-protocol attacks
(like [ALPACA](https://alpaca-attack.com/)).
- Stricter error checking to help prevent cross-protocol attacks (like
[ALPACA](https://alpaca-attack.com/)).
- Allow authenticating users without an `@domain` part.
- Add integration for
[chasquid-rspamd](https://github.com/Thor77/chasquid-rspamd) and
@@ -138,18 +126,16 @@ contents*, fixes
- Use `application/openmetrics-text` as content type in the openmetrics
exporter.
## 1.7 (2021-05-31)
- chasquid-util no longer depends on the unmaintained docopt-go.
If you relied on undocumented parsing behaviour before, your invocations may
need adjustment. In particular, `--a b` is no longer supported, and `--a=b`
must be used instead.
- chasquid-util no longer depends on the unmaintained docopt-go. If you relied
on undocumented parsing behaviour before, your invocations may need
adjustment. In particular, `--a b` is no longer supported, and `--a=b` must
be used instead.
- Improve handling of errors when talking to Dovecot for authentication.
- Fix handling of `hostname` option in the Docker image.
- Miscellaneous documentation and test improvements.
## 1.6 (2020-11-22)
- Pass the EHLO domain to the post-data hook.
@@ -157,7 +143,6 @@ contents*, fixes
- Implement HAProxy protocol support (experimental).
- Documentation updates.
## 1.5 (2020-09-12)
- Add OpenMetrics exporter (compatible with Prometheus).
@@ -166,14 +151,12 @@ contents*, fixes
- Fix rspamd greylist action handling in the default hook.
- Miscellaneous monitoring server improvements.
## 1.4 (2020-05-22)
- Use the configured hostname in outgoing SMTP HELO/EHLO.
- Allow config overrides from the command line.
- Miscellaneous test improvements and code cleanups.
## 1.3 (2020-04-12)
- Improved handling of DNS temporary errors.
@@ -181,7 +164,6 @@ contents*, fixes
Arch installation instructions).
- Miscellaneous test improvements and cleanups.
## 1.2 (2019-12-06)
Security fixes:
@@ -197,7 +179,6 @@ Release notes:
- New documentation sections (monitoring, release notes).
- Many miscellaneous test improvements.
## 1.1 (2019-10-26)
- Added hooks for aliases resolution.
@@ -207,7 +188,6 @@ Release notes:
- Documentation and test improvements.
- Minor bug fixes.
## 1.0 (2019-07-15)
No backwards-incompatible changes. No more are expected within this major
@@ -217,7 +197,6 @@ version.
- Make DSN tidier, especially in handling multi-line errors.
- Miscellaneous test improvements.
## 0.07 (2019-01-19)
No backwards-incompatible changes.
@@ -227,14 +206,12 @@ No backwards-incompatible changes.
- Miscellaneous test improvements.
- DKIM integration examples and test.
## 0.06 (2018-07-22)
No backwards-incompatible changes.
- New MTA-STS (Strict Transport Security) checking.
## 0.05 (2018-06-05)
No backwards-incompatible changes.
@@ -244,7 +221,6 @@ No backwards-incompatible changes.
- Periodic reload of domaininfo, support removing entries manually.
- Dovecot auth support no longer considered experimental.
## 0.04 (2018-02-10)
No backwards-incompatible changes.
@@ -252,18 +228,16 @@ No backwards-incompatible changes.
- Add Dovecot authentication support (experimental).
- Miscellaneous bug fixes to mda-lmtp and tests.
## 0.03 (2017-07-15)
**Backwards-incompatible changes:**
- The default MTA binary has changed. It's now maildrop by default.
If you relied on procmail being the default, add the following to
- The default MTA binary has changed. It's now maildrop by default. If you
relied on procmail being the default, add the following to
`/etc/chasquid/chasquid.conf`: `mail_delivery_agent_bin: "procmail"`.
- chasquid now listens on a third port, submission-on-TLS.
If using systemd, copy the `etc/systemd/system/chasquid-submission_tls.socket`
file to `/etc/systemd/system/`, and start it.
- chasquid now listens on a third port, submission-on-TLS. If using systemd,
copy the `etc/systemd/system/chasquid-submission_tls.socket` file to
`/etc/systemd/system/`, and start it.
Release notes:
@@ -271,7 +245,6 @@ Release notes:
- Change the default MDA binary to `maildrop`.
- Add a very basic MDA that uses LMTP to do the mail delivery.
## 0.02 (2017-03-03)
No backwards-incompatible changes.
@@ -280,7 +253,6 @@ No backwards-incompatible changes.
- Fall back through the MX list on errors.
- Experimental MTA-STS implementation (disabled by default).
## 0.01 (2016-11-03)
Initial release.