If you self host network resources on a residential IP and want to access your home network remotely, you need a dynamic DNS client. There are paid, closed-source solutions out there, but why bother when you can self host using free and open source software!

πŸ‡ΊπŸ‡Έ Origin

I wrote this script for the Raspberry Pi platform to enable low cost, simple self hosting to promote a more decentralized internet. On execution, the script fetches public IPv4 and IPv6 addresses and creates/updates DNS records for the subdomains in Cloudflare. Stale, duplicate DNS records are removed for housekeeping.

Source code is available on Github.

⚠️ Requirements

Add your custom domain name to your Cloudflare account

πŸ” Tech Stack

  • 🐍 Python 3.5+

🚦 Getting Started

Clone this repo to your workspace

git clone https://github.com/timothymiller/cloudflare-ddns.git

Edit config.json and replace the values with your own. Β 

Values explained: Β 

"api_key": "Your cloudflare API Key", 
"account_email": "The email address you use to sign in to cloudflare", "zone_id": "The ID of the zone that will get the records. From your dashboard click into the zone. Under the overview tab, scroll down and the zone ID is listed in the right rail", 
"subdomains": "Array of subdomains you want to assign the IP(s) to (e.g. foo or an empty string to update the base domain)",
"proxied": false (defaults to false. Make it true if you want CDN/SSL benefits from cloudflare. This usually disables SSH) 

πŸ“  Hosting multiple domains on the same IP?

You can save yourself some trouble when hosting multiple domains pointing to the same IP address (in the case of Traefik) by defining one A & AAAA record Β 'ddns.example.com' pointing to the IP of the server that will be updated by this DDNS script. For each subdomain, create a CNAME record pointing to 'ddns.example.com'. Now you don't have to manually modify the script config every time you add a new subdomain to your site!

πŸƒ Running

This script requires Python 3.5+, which comes preinstalled on the latest version of Raspbian. Download/clone this repo and execute `./sync`, which will set up a virtualenv, pull in any dependencies, and fire the script.

⏰ Scheduling

This script was written with the intention of cron managing it.

🐧 Linux instructions (all distros)

1. Upload the cloudflare-ddns folder to your home directory /home/your_username_here/

2. Run the following code in terminal Β 

crontab -e

3. Add the following lines to sync your DNS records every 15 minutes

*/15 * * * * /home/your_username_here/cloudflare-ddns/sync

Happy self hosting!