summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Fennell <matthew@fennell.dev>2024-01-07 14:20:10 +0000
committerMatthew Fennell <matthew@fennell.dev>2024-01-07 14:20:10 +0000
commitc2476b0d1a5d31387205d69d7e38a9f5c4b0be0d (patch)
treed74150c07f13e563894d047bcd6deb643acce23f
parent3b4bc1fa0578e62bdd3b2cca04bfb5e1c3a5e292 (diff)
Add (simple case) DNS instructions to the readme
This commit adds some basic DNS instructions for the initial setup of the host, which can be used when the domain of the JID matches the domain of the host.
-rw-r--r--README.md21
1 files changed, 19 insertions, 2 deletions
diff --git a/README.md b/README.md
index 77049b5..d0b650b 100644
--- a/README.md
+++ b/README.md
@@ -20,10 +20,27 @@ and managed nodes.
Set up a server with the following things configured:
-* SSH access to a user that can become root
-* DNS records (see [Prosody's docs](https://prosody.im/doc/dns) for more info)
+#### Box
+
+The box needs:
+
+* SSH access to a user that can become root without a password
* `python3` installed
+#### DNS
+
+If the JID names match the domain of the server you are deploying to, create
+the following DNS records:
+
+| Type | Host | IP Address | TTL |
+| -------- | ---- | ---------- | --------- |
+| A Record | @ | Static IP | Automatic |
+
+See [Prosody's docs](https://prosody.im/doc/dns) for information on alternative
+arrangements.
+
+#### Firewall
+
Now, open the following firewall ports on the external firewall (the firewall
on the box itself will be taken care of by the playbook):