Jan Christian Grünhage
I'm forking this, with the following changes: - daemon instead of CLI tool run via cron - mandatory config file - use cloudflare crate instead of home grown API client - IPv6 support - CNPLv6+ licensed instead of MIT licensed
|1 year ago|
|src||1 year ago|
|.gitignore||1 year ago|
|Cargo.lock||1 year ago|
|Cargo.toml||1 year ago|
|LICENSE||1 year ago|
|README.md||1 year ago|
Cloudflare DDNS service
This is a simple daemon that runs in the background and checks for your public IP regularily. If it changes, the service sets the corresponding DNS record. The service supports both IPv4 and IPv6 addresses.
Use the package manager cargo to install Cloudflare DDNS service.
cargo install cloudflare-ddns-service
The services adheres to the XDG spec for locating the config file. In most
cases, that means the config file is located at
As you can see from the path, the configuration should be a yaml file. A sample could look like this:
api_token: "secretkey" zone: "example.com" domain: "example.example.com" ipv4: true # defaults to true ipv6: true # defaults to false interval: 15 # seconds, defaults to 60
As you can see, we have a token here. This token needs to have access to at least:
- reading you account zones (for getting the zone ID from the zone name)
- reading and writing to the DNS zone (for first fetching the records and then modifying them.
Aside of the token, you also have to prepare some DNS records before running
this: If you enabled IPv4 support, there needs to be a DNS
A record for the
configured domain already, and if you enabled IPv6 support, you need a DNS
AAAA record set on the configured domain. The service will not create new
records, it just modifies existing records.
To run the service, just call the binary. You can optionally set the
env var to configure the log level:
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
cloudflare-ddns-service is cooperative non-violent software: you can use, redistribute, and/or modify it under the terms of the CNPLv6+ as found in the LICENSE file in the source code root directory or at https://git.pixie.town/thufie/CNPL.
cloudflare-ddns-service comes with ABSOLUTELY NO WARRANTY, to the extent
permitted by applicable law. See
LICENSE for details.
This fork has been made to severly refactor the utility (have it running constantly instead of running it in cron, for supporting IPv6, and for not using a homegrown Cloudflare API client but the library provided by Cloudflare themselves). Due to the nature of these changes, I have not sent a PR, as it makes this basically a separate tool and nearly all code has been rewritten.