Awesome Open Source
Awesome Open Source

Dynamic DNS

Updates a given a DNS record with your current IP

Example with the Cloudflare provider:

docker run \
  -e PROVIDER=cloudflare \
  -e CLOUDFLARE_APITOKEN=YOUR_API_TOKEN \
  -e CLOUDFLARE_ZONEID=YOUR_ZONE_ID \
  -e CLOUDFLARE_HOST=YOUR_DOMAIN \
  hugomd/cloudflare-ddns:2.1.0

Example running as a persistant daemon:

docker run -d --restart always \
  -e PROVIDER=cloudflare \
  -e CLOUDFLARE_APITOKEN=YOUR_API_TOKEN \
  -e CLOUDFLARE_ZONEID=YOUR_ZONE_ID \
  -e CLOUDFLARE_HOST=YOUR_DOMAIN \
  hugomd/cloudflare-ddns:2.1.0 -duration 2h

You can load environment variables through a config file of key/value pairs.

echo "PROVIDER=YOUR_PROVIDER" > config.env
docker run \
  -v $PWD/config.env:/tmp/config.env \
  hugomd/cloudflare-ddns -config /tmp/config.env

A note about Docker image tags: latest currently points to a now deprecated version of cloudflare-ddns, please use versioned tags e.g. hugomd/cloudflare-ddns:2.0.0.

Supported Providers

Provider Reference (used for PROVIDER environment variable)
Cloudflare cloudflare

CLI

Parameter Description Example Required
-duration Runs program perpetually and recheck after specified interval; parses time strings such as 5m, 15m, 2h30m5s. If not specified, or if equal to 0s, run once and exit. 2h false
-config Loads environment variables from a given file. Variables should be specified as lines of key=value pairs. No variables will be loaded if a file is not specified. /tmp/config.env false
-ipv4 Enable updates for IPv4 records. Default is true false false
-ipv6 Enable updates for IPv6 records. Default is false true false

Environment Variables

All providers require the following environment variable:

Environment Variable Description Example Required
PROVIDER The name of the provider you wish to use cloudflare true

Cloudflare

Environment Variable Description Example Required
CLOUDFLARE_APITOKEN An API Token, with permission to edit DNS records for your zone 12345 true
CLOUDFLARE_ZONEID The Zone ID of your domain in Cloudflare (you can find this in the "Overview" tab at the bottom of the page) dd255baaaaad2e8... true
CLOUDFLARE_HOST The record you want to update subdomain.example.com true

Deprecated Environment Variables

Cloudflare now supports API tokens as a more secure way of interacting with their API. Instead of using your global API key/email, you should use a token with limited permissions.

When upgrading, you'll need to replace a few existing environment variables.

Instead of providing a CLOUDFLARE_ZONE with your domain name, you should specify the Zone ID (CLOUDFLARE_ZONEID) of your domain. You can find this in the "Overview" tab for your domain.

Instead of your CLOUDFLARE_EMAIL and CLOUDFLARE_APIKEY, you should generate a token (CLOUDFLARE_APITOKEN) with permission to edit DNS records for your desired zone.

You don't need to make any changes to your CLOUDFLARE_HOST.

Contributing

Adding a new provider

To add a new provider:

  1. Create a new folder in lib/providers, called your_provider
  2. Create a package for your provider in the previously created folder, your_provider.
  3. Ensure your provider implements the Provider interface
  4. Import your provider in lib/providers/_all/all.go
  5. Open a PR 🎉

License

MIT, see LICENSE.



Alternative Project Comparisons
Related Awesome Lists
Top Programming Languages
Top Projects

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Golang (158,344
Docker (97,304
Provider (15,577
Dns (10,192
Cloudflare (2,483
Ddns (658
Dynamic Dns (590