From e4c69adcd96f91ae688f335aa72ade88c759c179 Mon Sep 17 00:00:00 2001 From: futile Date: Fri, 17 Jul 2026 21:28:29 +0100 Subject: [PATCH] update readme --- README.md | 40 +++++++++++++++++++++++++--------------- 1 file changed, 25 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 5c72795..a56482d 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,23 @@ some kind of hosting setup ## setup -1. log into vps (make sure it's fedora) -2. we need git `sudo dnf install git -y` -3. clone this `git clone https://gitlab.com/futile/thingy` -4. cd in `cd thingy` -5. run the system setup script `./set-up-system.sh` -6. log out and back in `exit`, `ssh whatever@whatever`... -7. cd again `cd thingy` -8. populate a .env `micro .env` -9. finally, start everything `docker compose up` -10. continue with service-specific setups ..... +log into the vps, make sure it's fedora (or else 🔪) + +``` +sudo dnf install git -y +git clone https://gitlab.com/futile/thingy +./thingy/set-up-system.sh +exit +``` + +``` +ssh @ +cd thingy +micro .env +docker compose up +``` + +continue with service-specific setups ..... ## services @@ -28,6 +35,14 @@ specifics for everything - `m.yaoi.dog` – mail (server & admin dash) - `mail.yaoi.dog` – mail (webmail) +**dns setup** + +| type | host | value | notes | +|-------|--------|---------------------------- |----------------------------| +| `A` | `@` | `` | apex domain | +| `A` | `m` | `` | mailserver | +| `A` | `mail` | `` | webmail | +| `CAA` | `@` | `0 issue "letsencrypt.org"` | allow caddy to issue certs | ### stalwart @@ -71,8 +86,3 @@ specifics for everything - https://bulwarkmail.org/docs/deployment/docker - https://bulwarkmail.org/docs/guides/admin - https://bulwarkmail.org/docs/getting-started/configuration/environment-reference - -### caddy - -**notes** -- caddy will not be able to issue certificates if stalwart creates the CAA record, you should create one yourself like so: `CAA` `@` `0 issue "letsencrypt.org"`