From 702cb85df8798954737c93a4bd978d9a711ed343 Mon Sep 17 00:00:00 2001
From: Elizabeth Hunt <elizabeth.hunt@simponic.xyz>
Date: Thu, 11 Apr 2024 11:17:58 -0600
Subject: add acme script

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6618828
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# hatecomputers.club dns updater & certbot plugin
+
+this is a simple wrapper over hatecomputers.club's dns api
+
+## dns creation steps
+
+1. obtain an api key at [hatecomputers.club](https://hatecomputers.club)
+2. put it in `apikey.secret`
+3. modify `records.json` to your liking
+4. `./main.py --create --records-file=records.json`
+
+## certbot plugin
+
+follow the above to generate an api key.
+
+if you use the split-zone dns provided by hatecomputers.club and run your own certificate
+authority, you can try something like:
+```bash
+REQUESTS_CA_BUNDLE=~/armin/roots.pem certbot certonly \
+  --manual --manual-auth-hook ./plugin.sh \
+  --preferred-challenges dns \
+  -d *.internal.simponic.xyz \
+  --config-dir ./certbot \
+  --work-dir ./certbot \
+  --logs-dir ./certbot \
+  --server https://ca.internal.simponic.xyz/acme/ACME/directory \
+  --email simponic@hatecomputers.club \
+  --agree-tos \
+   --no-eff-email
+```
+
+otherwise:
+```bash
+sudo certbot certonly \
+  --manual --manual-auth-hook ./plugin.sh \
+  --preferred-challenges dns \
+  -d *.simponic.hatecomputers.club \
+  --email simponic@hatecomputers.club \
+  --agree-tos \
+  --no-eff-email
+```
-- 
cgit v1.3