Skip to content

Commit d43215e

Browse files
committed
docs: document tls_cert option in getting_started and faq
1 parent 86d5ff7 commit d43215e

2 files changed

Lines changed: 27 additions & 3 deletions

File tree

doc/source/faq.rst

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,12 @@ goes beyond what classic email servers offer:
1414
- **Instant/Realtime:** sub-second message delivery, realtime P2P
1515
streaming, privacy-preserving Push Notifications for Apple, Google, and `Ubuntu Touch <https://docs.ubports.com/en/latest/appdev/guides/pushnotifications.html>`_;
1616

17-
- **Security Enforcement**: only strict TLS, DKIM and OpenPGP with minimized metadata accepted
17+
- **Security Enforcement**: only strict TLS, DKIM and
18+
OpenPGP with minimized metadata accepted.
19+
Relays using ``tls_cert = self``
20+
still enforce TLS encryption for transport
21+
while relying on OpenPGP end-to-end encryption
22+
for message content protection.
1823

1924
- **Reliable Federation and Decentralization:** No spam or IP reputation checks, federating
2025
depends on established IETF standards and protocols.
@@ -44,8 +49,13 @@ automatically deployed and updated using `the chatmail relay
4449
repository <https://github.com/chatmail/relay>`__. Chatmail relays are
4550
composed of proven standard email server components, Postfix and
4651
Dovecot, and are configured to run unattended without much maintenance
47-
effort. Chatmail relays happily run on low-end hardware like a Raspberry
48-
Pi.
52+
effort. Chatmail relays happily run on low-end hardware
53+
like a Raspberry Pi.
54+
Setting ``tls_cert = self`` in ``chatmail.ini``
55+
enables running a relay with self-signed certificates,
56+
making it possible to operate on a LAN
57+
or behind a firewall
58+
without needing Let's Encrypt or a public domain.
4959

5060

5161
How trustable are chatmail relays?

doc/source/getting_started.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ steps. Please substitute it with your own domain.
4747
www.chat.example.org. 3600 IN CNAME chat.example.org.
4848
mta-sts.chat.example.org. 3600 IN CNAME chat.example.org.
4949

50+
.. note::
51+
52+
For ``tls_cert = self`` deployments (see step 3),
53+
the ``mta-sts`` CNAME and ``_mta-sts`` TXT records
54+
are not needed.
55+
5056
2. On your local PC, clone the repository and bootstrap the Python
5157
virtualenv.
5258

@@ -63,6 +69,14 @@ steps. Please substitute it with your own domain.
6369

6470
scripts/cmdeploy init chat.example.org # <-- use your domain
6571

72+
To use self-signed TLS certificates
73+
instead of Let's Encrypt,
74+
set ``tls_cert = self`` in ``chatmail.ini``.
75+
This is useful for private or test deployments
76+
and does not require a publicly resolvable domain.
77+
See the :doc:`overview`
78+
for details on certificate provisioning.
79+
6680
4. Verify that SSH root login to the deployment server server works:
6781

6882
::

0 commit comments

Comments
 (0)