Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xerren09/cloudflare-dynamic-dns
A small script to automatically update the IP address(es) attached to a Cloudflare DNS record(s), written in NodeJS.
https://github.com/xerren09/cloudflare-dynamic-dns
cloudflare dns-update dynamic-dns dynamic-dns-updater nodejs
Last synced: about 1 month ago
JSON representation
A small script to automatically update the IP address(es) attached to a Cloudflare DNS record(s), written in NodeJS.
- Host: GitHub
- URL: https://github.com/xerren09/cloudflare-dynamic-dns
- Owner: Xerren09
- License: bsd-3-clause
- Created: 2022-03-15T12:35:29.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-07T00:51:46.000Z (4 months ago)
- Last Synced: 2024-09-07T03:27:54.478Z (4 months ago)
- Topics: cloudflare, dns-update, dynamic-dns, dynamic-dns-updater, nodejs
- Language: JavaScript
- Homepage:
- Size: 15.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-dynamic-dns
A small script to automatically update the IP address(es) attached to a CloudFlare DNS record(s).
This was written in somewhat of a hurry to allow a Raspberry PI to host some university projects.
## Configuration
The `config.json` file's `records` array can handle individual DNS records in this format:
```json
{
"ip": "",
"checkIntervalMS": 0,
"logging": "",
"records": [
{
"authEmail": "[email protected]",
"authKey": "0000000000000000000000000000000000000",
"zoneName": "example1.com",
"zoneIdentifier": "",
"recordName": "example1.com",
"recordIdentifier": ""
},
{
"authEmail": "[email protected]",
"authKey": "0000000000000000000000000000000000000",
"zoneName": "example2.com",
"zoneIdentifier": "",
"recordName": "example2.com",
"recordIdentifier": ""
}
]
}
```
The `authEmail` field is the email that is registered with the domain, and `authKey` can be obtained from [https://dash.cloudflare.com/profile/api-tokens](https://dash.cloudflare.com/profile/api-tokens), in the "Global API Key" section.
The `zoneName` should be set to the root domain name of the website, while the `recordName` is the name of the A Type record.
Both `zoneIdentifier` and `recordIdentifier` should be left empty, along with the `ip` field on the top of the file; these will be filled out by the script on startup.
The `checkIntervalMS` property can be used to set how often, in milliseconds, the script should check if the IP address has changed. By default it is set to 0 minutes, which disables this function. This is useful if the script is periodically called from another source (for example from cron).
Once started, this script runs once - or if the `checkIntervalMS` property is set, indefinitely - and logs any issues into `./logs/log.txt`.
For full logging (write to logline everytime a check has been done, regardless if the IP changed), set `logging` to 'full'.
## IP check
The script checks for the machine's IP address by sending a get request to a great external service, [https://www.ipify.org/](https://www.ipify.org/) <3.