Compare commits
23 Commits
experiment
...
main
Author | SHA1 | Date |
---|---|---|
M_Viper | af4070c54e | |
Jason K | 88c73e30f8 | |
AgingOrange | 6af3585c79 | |
Jason K | d9ad375827 | |
9cco | 00db8af28f | |
9cco | 08ef1d559d | |
9cco | 46ea8de30c | |
9cco | 6a50f940cb | |
Jason K | 27e396cccc | |
9cco | ebcc60faa3 | |
9cco | 9d2e7fcc8a | |
9cco | ff6a8df63c | |
9cco | e8873cc328 | |
Jason K | 901fdb403c | |
Jason K | f556d0e5dd | |
Clément Nussbaumer | d13ba926f3 | |
Jason K | fba6204554 | |
Northport IO | 6ae5bd5c44 | |
Jason K | d151789229 | |
Sailboat265 | 7f1e80e000 | |
Jason K | ca4d5fd535 | |
Jason K | d8ceb1ba4b | |
Clément Nussbaumer | ea68158b97 |
32
README.md
32
README.md
|
@ -1,34 +1,4 @@
|
|||
# Cloudflare Dynamic DNS IP Updater
|
||||
<img alt="GitHub" src="https://img.shields.io/github/license/K0p1-Git/cloudflare-ddns-updater?color=black"> <img alt="GitHub last commit (branch)" src="https://img.shields.io/github/last-commit/K0p1-Git/cloudflare-ddns-updater/main"> <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/K0p1-Git/cloudflare-ddns-updater">
|
||||
|
||||
This script is used to update dynamic DNS entries for accounts on Cloudflare.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
git clone https://github.com/K0p1-Git/cloudflare-ddns-updater.git
|
||||
```
|
||||
|
||||
## Usage
|
||||
This script is used with crontab. Specify the frequency of execution through crontab.
|
||||
|
||||
```bash
|
||||
# ┌───────────── minute (0 - 59)
|
||||
# │ ┌───────────── hour (0 - 23)
|
||||
# │ │ ┌───────────── day of the month (1 - 31)
|
||||
# │ │ │ ┌───────────── month (1 - 12)
|
||||
# │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday 7 is also Sunday on some systems)
|
||||
# │ │ │ │ │ ┌───────────── command to issue
|
||||
# │ │ │ │ │ │
|
||||
# │ │ │ │ │ │
|
||||
# * * * * * /bin/bash {Location of the script}
|
||||
```
|
||||
|
||||
## Contributing
|
||||
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
||||
|
||||
## Reference
|
||||
This script was made with reference from [Keld Norman](https://www.youtube.com/watch?v=vSIBkH7sxos) video.
|
||||
|
||||
## License
|
||||
[MIT](https://github.com/K0p1-Git/cloudflare-ddns-updater/blob/main/LICENSE)
|
||||
This script is used to update Dynamic DNS (DDNS) service based on Cloudflare! Access your home network remotely via a custom domain name without a static IP! Written in pure BASH.
|
||||
|
|
|
@ -1,28 +1,42 @@
|
|||
#!/bin/bash
|
||||
## change to "bin/sh" when necessary
|
||||
|
||||
auth_email="" # 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="" # Your API Token or Global API Key
|
||||
zone_identifier="" # Can be found in the "Overview" tab of your domain
|
||||
record_name="" # Which record you want to be synced
|
||||
proxy=false # Set the proxy to true or false
|
||||
|
||||
ttl="3600" # Set the DNS TTL (seconds)
|
||||
proxy="false" # Set the proxy to true or false
|
||||
sitename="" # Title of site "Example Site"
|
||||
slackchannel="" # Slack Channel #example
|
||||
slackuri="" # URI for Slack WebHook "https://hooks.slack.com/services/xxxxx"
|
||||
discorduri="" # URI for Discord WebHook "https://discordapp.com/api/webhooks/xxxxx"
|
||||
|
||||
|
||||
###########################################
|
||||
## Check if we have a public IP
|
||||
###########################################
|
||||
ip=$(curl -s https://api.ipify.org || curl -s https://ipv4.icanhazip.com/)
|
||||
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
|
||||
|
||||
if [ "${ip}" == "" ]; then
|
||||
logger -s "DDNS Updater: No public IP found"
|
||||
exit 1
|
||||
# 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
|
||||
if [[ "${auth_method}" == "global" ]]; then
|
||||
auth_header="X-Auth-Key:"
|
||||
else
|
||||
auth_header="Authorization: Bearer"
|
||||
|
@ -33,7 +47,10 @@ fi
|
|||
###########################################
|
||||
|
||||
logger "DDNS Updater: Check Initiated"
|
||||
record=$(curl -s -X GET "https://api.cloudflare.com/client/v4/zones/$zone_identifier/dns_records?name=$record_name" -H "X-Auth-Email: $auth_email" -H "$auth_header $auth_key" -H "Content-Type: application/json")
|
||||
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
|
||||
|
@ -46,7 +63,7 @@ fi
|
|||
###########################################
|
||||
## Get existing IP
|
||||
###########################################
|
||||
old_ip=$(echo "$record" | grep -Po '(?<="content":")[^"]*' | head -1)
|
||||
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."
|
||||
|
@ -56,25 +73,51 @@ fi
|
|||
###########################################
|
||||
## Set the record identifier from result
|
||||
###########################################
|
||||
record_identifier=$(echo "$record" | grep -Po '(?<="id":")[^"]*' | head -1)
|
||||
record_identifier=$(echo "$record" | sed -E 's/.*"id":"(\w+)".*/\1/')
|
||||
|
||||
###########################################
|
||||
## Change the IP@Cloudflare using the API
|
||||
###########################################
|
||||
update=$(curl -s -X PUT "https://api.cloudflare.com/client/v4/zones/$zone_identifier/dns_records/$record_identifier" \
|
||||
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 "{\"id\":\"$zone_identifier\",\"type\":\"A\",\"proxied\":${proxy},\"name\":\"$record_name\",\"content\":\"$ip\"}")
|
||||
--data "{\"type\":\"A\",\"name\":\"$record_name\",\"content\":\"$ip\",\"ttl\":\"$ttl\",\"proxied\":${proxy}}")
|
||||
|
||||
###########################################
|
||||
## Report the status
|
||||
###########################################
|
||||
case "$update" in
|
||||
*"\"success\":false"*)
|
||||
logger -s "DDNS Updater: $ip $record_name DDNS failed for $record_identifier ($ip). DUMPING RESULTS:\n$update"
|
||||
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
|
||||
|
|
Loading…
Reference in New Issue