aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4404f41
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+Utility to update the managed zone for `fcuny.xyz` in Google Cloud DNS.
+
+I use the domain `fcuny.xyz` to run a number of services on an IP provided by Tailscale. I don't want these domains to be visible on the web, but I also want to have a valid HTTPS certificate for them. By having a proper DNS I can use ACME to get the certificates, without making them available.
+
+Instead of updating the subdomains through the [console](https://console.cloud.google.com/net-services/dns/zones/fcuny-xyz/details?project=fcuny-homelab), I can now run this program.
+
+# Run
+
+To update the records, run `nix run .`.
+