Skip to content

Commit 8cec0c9

Browse files
committed
doc: document IPv4-only relays
1 parent 06b6402 commit 8cec0c9

3 files changed

Lines changed: 28 additions & 2 deletions

File tree

doc/source/getting_started.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ Minimal requirements and prerequisites
1414

1515
You will need the following:
1616

17-
- Control over a domain through a DNS provider of your choice.
18-
1917
- A Debian 12 **deployment server** with reachable SMTP/SUBMISSIONS/IMAPS/HTTPS ports.
2018
IPv6 is encouraged if available. Chatmail relay servers only require
2119
1GB RAM, one CPU, and perhaps 10GB storage for a few thousand active
@@ -28,6 +26,9 @@ You will need the following:
2826
(An ed25519 private key is required due to an `upstream bug in
2927
paramiko <https://github.com/paramiko/paramiko/issues/2191>`_)
3028

29+
- Control over a domain through a DNS provider of your choice
30+
(there is experimental support for `DNS-less relays <iponly.html>`_).
31+
3132

3233
Setup with ``scripts/cmdeploy``
3334
-------------------------------------

doc/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ Contributions and feedback welcome through the https://github.com/chatmail/relay
1818
overview
1919
related
2020
faq
21+
iponly

doc/source/iponly.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
Hosting without DNS records
3+
===========================
4+
5+
In case you don't have a domain,
6+
for example in a local network,
7+
you can run a chatmail relay with only an IPv4 address as well.
8+
9+
To deploy a relay without a domain,
10+
run ``cmdeploy init`` with only the IPv4 address
11+
during the `installation steps <getting_started.html>`_,
12+
for example ``cmdeploy init 13.12.23.42``.
13+
14+
Drawbacks
15+
---------
16+
17+
- your transport encryption will only use self-signed TLS certificates,
18+
which are vulnerable against MITM attacks.
19+
the chatmail core's end-to-end encryption should suffice in most scenarios though.
20+
21+
- your messages will not be DKIM-signed;
22+
experimentally, most chatmail relays accept non-DKIM-signed messages from IPv4-only relays,
23+
but some relays might not accept messages from yours.
24+

0 commit comments

Comments
 (0)