https://github.com/offsetmonkey538/cloudflare-ddns-updater
Simple shell script that keeps a Cloudflare DNS record up to date with the current IPv4 and IPv6 address of the computer it's run on
https://github.com/offsetmonkey538/cloudflare-ddns-updater
cloudflare-api cloudflare-dns ddns ddns-updater dns posix-sh shell shell-script
Last synced: about 1 year ago
JSON representation
Simple shell script that keeps a Cloudflare DNS record up to date with the current IPv4 and IPv6 address of the computer it's run on
- Host: GitHub
- URL: https://github.com/offsetmonkey538/cloudflare-ddns-updater
- Owner: OffsetMonkey538
- License: mit
- Created: 2025-04-09T11:25:29.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-09T13:19:09.000Z (about 1 year ago)
- Last Synced: 2025-04-11T04:08:22.261Z (about 1 year ago)
- Topics: cloudflare-api, cloudflare-dns, ddns, ddns-updater, dns, posix-sh, shell, shell-script
- Language: Shell
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cloudflare DDNS Updater
This script will keep the IPv4 and IPv6 addresses of Cloudflare DNS entries up to date with the current public IP address of the computer it is run on.
It uses the Cloudflare api and `jq` command for checking the IP address currently set for the DNS records and compares them with results from the [ipify.org](https://www.ipify.org/) api (https://api.ipify.org and https://api6.ipify.org)
If the IP addresses don't match, it will send a request to the Cloudflare api to set the new addresses.
## Setting up
First clone the repository and cd into it.
For configuration, rename the `.env-example` file to just `.env`. Then you can start filling it with values.
### ZONE_ID
You can get the zone id from the [Cloudflare Dashboard](https://dash.cloudflare.com) by clicking on the domain you want. It should be on the right side of the screen.
### API_TOKEN
To get the api token, go to your [Cloudflare Dashboard](https://dash.cloudflare.com) and scroll down to `Manage Account` on the left. Click on it and select `Account API Tokens`.
Click on `Create Token` and select the `Edit zone DNS` template. Select the correct zone and create the token.
### DOMAIN
Set this to the (sub)domain you want to be updated. (For example `server.example.com`)
### RECORD_IDs
Go to your [Cloudflare Dashboard](https://dash.cloudflare.com), select your domain and go to `DNS`.
Here you need to create 2 DNS records for the same (sub)domain, one for IPv4 (Type A) and one for IPv6 (Type AAAA).
Create them with the correct name, other settings will be filled by the script. For the address you can temporarily use `1.2.3.4` for IPv4 and `1:2:3:4:5:6:7:8` for IPv6.
Now that the records are created, you need to get their ids.
To do this, you can run the script like this: `LIST_RECORDS=true ./run.sh`, which will print the `A` and `AAAA` record ids for the `DOMAIN` you defined before.
From there, copy the values into the `.env` file.
### TTL
The time-to-live of the records, in seconds. The default of 300 seconds (5 min) should be fine, but you can increase or decrease this if you plan on running the script at a different interval.
## Running the script
You can set up cron to run the script. Just run the `crontab -e` command and paste in the following:
```cronexp
*/5 * * * * cd /path/to/cloudflare-ddns-updater && ./run.sh
```
This will run the script every five minutes. It first has to cd into the directory as otherwise the script wouldn't be able to access the `.env` file.