Skip to content

Commit

Permalink
feat(ddns): DDNS is now done on artemis
Browse files Browse the repository at this point in the history
  • Loading branch information
szinn committed Feb 26, 2025
1 parent 6432f2c commit f6e340a
Show file tree
Hide file tree
Showing 3 changed files with 136 additions and 2 deletions.
14 changes: 12 additions & 2 deletions .taskfiles/Machine/Taskfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,21 @@ tasks:
install-artemis-docker:
desc: Install docker
cmds:
- ssh [email protected] apt update -y && sudo apt upgrade -y
- ssh [email protected] 'curl -fsSL https://get.docker.com -o /opt/get-docker.sh && sudo sh /opt/get-docker.sh && rm /opt/get-docker.sh'
- ssh [email protected] 'apt update -y && apt upgrade -y'
- ssh [email protected] 'curl -fsSL https://get.docker.com -o /opt/get-docker.sh && sh /opt/get-docker.sh && rm /opt/get-docker.sh'
- ssh [email protected] apt install -y docker-compose
- ssh [email protected] systemctl restart docker.service

install-artemis-ddns:
desc: Install Cloudflare DDNS
cmds:
- op inject --in-file "{{.FILES_DIR}}/artemis/cloudflare-ddns.sh" 2>/dev/null > /tmp/cloudflare-ddns.sh
- scp /tmp/cloudflare-ddns.sh [email protected]:/usr/local/bin/cloudflare-ddns.sh
- rm /tmp/cloudflare-ddns.sh
- ssh [email protected] 'chmod +x /usr/local/bin/cloudflare-ddns.sh && chmod og+rx /usr/local/bin/cloudflare-ddns.sh'
- scp "{{.FILES_DIR}}/artemis/cloudflare-ddns.crontab" [email protected]:/etc/cron.d/cloudflare-ddns
- ssh [email protected] chmod -x /etc/cron.d/cloudflare-ddns

restart-artemis-adguard:
desc: Restart AdGuardHome
cmds:
Expand Down
1 change: 1 addition & 0 deletions .taskfiles/Machine/files/artemis/cloudflare-ddns.crontab
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*/10 * * * * root /usr/local/bin/cloudflare-ddns.sh
123 changes: 123 additions & 0 deletions .taskfiles/Machine/files/artemis/cloudflare-ddns.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
#!/bin/bash
## change to "bin/sh" when necessary

auth_email="op://Kubernetes/cloudflare/USERNAME" # The email used to login 'https://dash.cloudflare.com'
auth_method="token" # Set to "global" for Global API Key or "token" for Scoped API Token
auth_key="op://Kubernetes/cloudflare/CLOUDFLARE_DNS_TOKEN" # Your API Token or Global API Key
zone_identifier="op://Kubernetes/cloudflare/TECH_ZONE_ID" # Can be found in the "Overview" tab of your domain
record_name="op://Kubernetes/cloudflare/TECH_ZONE" # Which record you want to be synced
ttl=3600 # Set the DNS TTL (seconds)
proxy="false" # Set the proxy to true or false
sitename="op://Kubernetes/cloudflare/TECH_ZONE" # Title of site "Example Site"
slackchannel="" # Slack Channel #example
slackuri="" # URI for Slack WebHook "https://hooks.slack.com/services/xxxxx"
discorduri="op://Kubernetes/discord/DISCORD_K8S_MAIN_WEBHOOK" # URI for Discord WebHook "https://discordapp.com/api/webhooks/xxxxx"


###########################################
## Check if we have a public IP
###########################################
ipv4_regex='([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])'
ip=$(curl -s -4 https://cloudflare.com/cdn-cgi/trace | grep -E '^ip'); ret=$?
if [[ ! $ret == 0 ]]; then # In the case that cloudflare failed to return an ip.
# Attempt to get the ip from other websites.
ip=$(curl -s https://api.ipify.org || curl -s https://ipv4.icanhazip.com)
else
# Extract just the ip from the ip line from cloudflare.
ip=$(echo $ip | sed -E "s/^ip=($ipv4_regex)$/\1/")
fi

# Use regex to check for proper IPv4 format.
if [[ ! $ip =~ ^$ipv4_regex$ ]]; then
logger -s "DDNS Updater: Failed to find a valid IP."
exit 2
fi

###########################################
## Check and set the proper auth header
###########################################
if [[ "${auth_method}" == "global" ]]; then
auth_header="X-Auth-Key:"
else
auth_header="Authorization: Bearer"
fi

###########################################
## Seek for the A record
###########################################

logger "DDNS Updater: Check Initiated"
record=$(curl -s -X GET "https://api.cloudflare.com/client/v4/zones/$zone_identifier/dns_records?type=A&name=$record_name" \
-H "X-Auth-Email: $auth_email" \
-H "$auth_header $auth_key" \
-H "Content-Type: application/json")

###########################################
## Check if the domain has an A record
###########################################
if [[ $record == *"\"count\":0"* ]]; then
logger -s "DDNS Updater: Record does not exist, perhaps create one first? (${ip} for ${record_name})"
exit 1
fi

###########################################
## Get existing IP
###########################################
old_ip=$(echo "$record" | sed -E 's/.*"content":"(([0-9]{1,3}\.){3}[0-9]{1,3})".*/\1/')
# Compare if they're the same
if [[ $ip == $old_ip ]]; then
logger "DDNS Updater: IP ($ip) for ${record_name} has not changed."
exit 0
fi

###########################################
## Set the record identifier from result
###########################################
record_identifier=$(echo "$record" | sed -E 's/.*"id":"([A-Za-z0-9_]+)".*/\1/')

###########################################
## Change the IP@Cloudflare using the API
###########################################
update=$(curl -s -X PATCH "https://api.cloudflare.com/client/v4/zones/$zone_identifier/dns_records/$record_identifier" \
-H "X-Auth-Email: $auth_email" \
-H "$auth_header $auth_key" \
-H "Content-Type: application/json" \
--data "{\"type\":\"A\",\"name\":\"$record_name\",\"content\":\"$ip\",\"ttl\":$ttl,\"proxied\":${proxy}}")

###########################################
## Report the status
###########################################
case "$update" in
*"\"success\":false"*)
echo -e "DDNS Updater: $ip $record_name DDNS failed for $record_identifier ($ip). DUMPING RESULTS:\n$update" | logger -s
if [[ $slackuri != "" ]]; then
curl -L -X POST $slackuri \
--data-raw '{
"channel": "'$slackchannel'",
"text" : "'"$sitename"' DDNS Update Failed: '$record_name': '$record_identifier' ('$ip')."
}'
fi
if [[ $discorduri != "" ]]; then
curl -i -H "Accept: application/json" -H "Content-Type:application/json" -X POST \
--data-raw '{
"content" : "'"$sitename"' DDNS Update Failed: '$record_name': '$record_identifier' ('$ip')."
}' $discorduri
fi
exit 1;;
*)
logger "DDNS Updater: $ip $record_name DDNS updated."
if [[ $slackuri != "" ]]; then
curl -L -X POST $slackuri \
--data-raw '{
"channel": "'$slackchannel'",
"text" : "'"$sitename"' Updated: '$record_name''"'"'s'""' new IP Address is '$ip'"
}'
fi
if [[ $discorduri != "" ]]; then
curl -i -H "Accept: application/json" -H "Content-Type:application/json" -X POST \
--data-raw '{
"content" : "'"$sitename"' Updated: '$record_name''"'"'s'""' new IP Address is '$ip'"
}' $discorduri
fi
exit 0;;
esac

0 comments on commit f6e340a

Please sign in to comment.