Mirrors/go-chasquid-smtp
1
0
Fork 0
mirror of https://blitiri.com.ar/repos/chasquid synced 2026-10-28 15:02:28 +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
docker/README.md
+12 -16
View File
@@ -1,4 +1,3 @@
# Docker
chasquid comes with a Dockerfile to create a container running [chasquid],
@@ -7,18 +6,13 @@ chasquid comes with a Dockerfile to create a container running [chasquid],
Note these are less thoroughly tested than the [traditional setup](howto.md),
which is the recommended way to use chasquid.
[chasquid]: https://blitiri.com.ar/p/chasquid
[dovecot]: https://dovecot.org
[Let's Encrypt]: https://letsencrypt.org
## Images
There are pre-built images at the
[gitlab registry](https://gitlab.com/albertito/chasquid/container_registry)
and [dockerhub](https://hub.docker.com/r/albertito/chasquid).
They are automatically built, and tagged with the corresponding branch name.
Use the *main* tag for a stable version.
[gitlab registry](https://gitlab.com/albertito/chasquid/container_registry) and
[dockerhub](https://hub.docker.com/r/albertito/chasquid). They are
automatically built, and tagged with the corresponding branch name. Use the
*main* tag for a stable version.
If, instead, you want to build the image yourself, just run:
@@ -59,12 +53,12 @@ Password:
pepe@example.com added to /data/dovecot/users
```
Upon startup, the image will obtain a TLS certificate for you using [Let's
Encrypt](https://letsencrypt.com/). You need to tell it the domain(s) to get a
certificate from by setting the `AUTO_CERTS` variable.
Upon startup, the image will obtain a TLS certificate for you using
[Let's Encrypt](https://letsencrypt.com/). You need to tell it the domain(s) to
get a certificate from by setting the `AUTO_CERTS` variable.
Because certificates expire, you should restart the container every week or
so. Certificates will be renewed automatically upon startup if needed.
Because certificates expire, you should restart the container every week or so.
Certificates will be renewed automatically upon startup if needed.
In order for chasquid to get access to the source IP address, you will need to
use host networking, or create a custom docker network that does IP forwarding
@@ -79,10 +73,12 @@ $ docker run -e AUTO_CERTS=mail.yourdomain.com \
registry.gitlab.com/albertito/chasquid:main
```
## Debugging
To get a shell on the running container for debugging, you can use `docker ps`
to find the container ID, and then `docker exec -it CONTAINERID /bin/bash` to
open a shell on the running container.
[chasquid]: https://blitiri.com.ar/p/chasquid
[dovecot]: https://dovecot.org
[let's encrypt]: https://letsencrypt.org