cloudflaredd is a small script meant to run as a systemd process to automatically upload dynamic dns changes to a set of domain dns records managed by Cloudflare. Essentially, every three minutes, we use a protocol named STUN (defined in RFC 5389) to retrieve our public ip address. If the address changed from the previous iteration, we update cloudflare records with new data. Using STUN is great because it's super fast (a single UDP-based round trip) and totally free because Google hosts free public STUN servers, which are typically used within the ICE protocol for nat traversal (which is heavily used in Google's WebRTC framework).
The project is meant to run as a systemctl
service in the background, and thus is super lightweight. It's implemented as a single C file with a dependency on libcurl. To download and build the project, simply do the following:
git clone [email protected]:MorganGallant/cloudflaredd.git
cd cloudflaredd
make
Before building, you will want to edit the static array defined on L253 of cloudflaredd.c
. Here, you can enter in all of your specific credentials and dns records that you want to update whenever a change of ip occurs. These are the defaults, which will not work:
static cf_dns_record_t cf_target_dns_records[] = {
{.identifer = NULL,
.name = "your-cool-domain.com",
.type = "A",
.zone = "zone-id-goes-here",
.api_token = "your-api-token-goes-here",
.proxied = false}};
For example, if you wanted to edit the test.morgangallant.com
A record, and the proxied dev.morgangallant.com
A record, the structure should look like the following: (identifier
can be NULL if you do not know the DNS Record ID)
static cf_dns_record_t cf_target_dns_records[] = {
{
.identifer = NULL,
.name = "test.morgangallant.com",
.type = "A",
.zone = "zone-id-goes-here",
.api_token = "your-api-token-goes-here",
.proxied = false
},
{
.identifer = NULL,
.name = "dev.morgangallant.com",
.type = "A",
.zone = "zone-id-goes-here",
.api_token = "your-api-token-goes-here",
.proxied = true
}
};
If it would benefit people, I'd gladly improve on the configuration aspect of cloudflaredd. Perhaps a .toml file or .yml file to describe the configuration, rather than having to compile it in. Let me know!
To setup this client to run in the background, simply copy the ddns.service
file to your systemd directory (probably /etc/systemd/system
). Once you have done this, edit the file and change the ExecStart
option to have the absolute path to the cloudflaredd binary. Then, once this file is saved, you can do the following to enable the systemd service to start at login:
sudo systemctl start ddns
sudo systemctl enable ddns # if you want cloudflareddns to start at login
As always, feel free to submit issues / pull requests to better the codebase. This is a small project that I needed to do for my tower, since my apartment doesn't have a static ip address. If you want to get in contact, send me an email!