timstephens24/cloudflare-ddns repository overview

⁠cloudflare-ddns

This is just a docker version version of adrienbrignon's cloudflare-ddns⁠.

⁠Introduction

A docker for dynamically updating Cloudflare DNS records. If you have a dynamic IP and you're hosting servers behind it, it's an easy way to make it 'pseudo-static'.

⁠Dependencies

• Docker
• For AAAA records an IPv6 address either for your container or on your host.

⁠Features

• Two ways to grab your IP address
  • HTTP
  • DNS lookup (dig)
• IPv4 and IPv6 support (A and AAAA records)
  • For IPv6 you might need to add --net=host
• Logging
• One configuration file for multiple records
• Multiple record settings:
  • Time to Live (TTL)
  • Proxy mode
  • Logging level
• Lightweight
• Smart update (your record will only be updated if needed)

⁠Usage

First, a few assumptions:

• You're using Cloudflare to host DNS for a domain you own.
• You have one or more A/AAAA records in Cloudflare you intend to dynamically update.

To use this utility, create a copy of the example.com.yml file inside the volume you want to pass to the docker container, i.e. /opt/docker/cloudflare-ddns/example.com.yml. The script will determine your public IP address and automatically update the records along with it and the settings you provided.

Because dynamic IPs can change regularly, it's recommended that you run this utility periodically in the background to keep your records up-to-date.

The easiest way to execute is to just run it:

docker run --net=host --name cloudflare -e DOMAIN=example.com -v '/opt/docker/cloudflare-ddns:/app/zones' timstephens24/cloudflare-ddns

After the initial pull you just need to start it again:

docker start cloudflare

To automate it after running you could use crontab to run it every 30 minutes:

*/30 * * * * docker start cloudflare

If you want to learn more about the Cloudflare API, you can read on here⁠.

⁠Credits and Thanks

• Cloudflare⁠ for having an API and otherwise generally being cool.
• icanhazip.com⁠ for making grabbing your public IP from a script super easy.
• thatjpk⁠ for the initial releases of this project.
• adrienbrignon⁠ for his fork that all this code except the Dockerfile.