summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorSteph Enders <steph@senders.io>2023-07-05 10:40:37 -0400
committerSteph Enders <steph@senders.io>2023-07-05 10:40:37 -0400
commit0e0988682f887cd5e363ab7e23e9ed2a4c67184e (patch)
treea413c4e252f88b2a00dead7a72af1374fb9057b1 /README.txt
parent7ad553afa01bc362871480ad74780e678f88e7ea (diff)
Create update script
This script will: 1. take in a domain and a config path 2. fetch your domains current IP using dig 3. fetch your server IP using ipinfo.io/ip (via curl) 4. then if there is a mismatch it will: 4.1. fetch your DNS A Record for that API from the API 4.2. POST an update for that DNS record with the new IP from the API 5. else print that things are successful The porkbun APIs denoted here: https://porkbun.com/api/json/v3/documentation
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.txt b/README.txt
index 98b08a1..22d827d 100644
--- a/README.txt
+++ b/README.txt
@@ -4,4 +4,8 @@ Sometimes your servers IP changes underneath you. This util is script you can se
== SETUP
-Ensure your API keys are somewhere secure and accessible to the script
+Ensure your API keys are somewhere secure and accessible to the script. It will be sourced by the script so should be sh env compatible (aka KEY=VALUE)
+
+== REQUIREMENTS
+
+curl, dig, jq