cloudflare-ddns

cloudflare-ddns

This is an updated fork of https://github.com/wyattjoh/cloudflare-ddns.

This was a project designed to explore the Cloudflare API through their official Go Client.

This application updates a given domain name to the current machine's IP address with the use of the https://ipify.org service. Alternative IP address services may be used if it returns the IP address of the current machine in plain text by overriding the configuration option.

You can run this service in a cron job or a systemd timer, or once, up to you!

Installation

Install with the Go toolchain to compile from source:

go install github.com/pellared/cloudflare-ddns@latest

Configuration

Configuration is specified in the environment or as command line arguments.

• --token or ENV['CF_API_TOKEN'] (required if --key and --email not provided) - The API Token that has the Zone.DNS permission for the specific zone.
• --key or ENV['CF_API_KEY'] (required if --token not provided) - specify the Global (not CA) Cloudflare API Key generated on the "My Account" page.
• --email or ENV['CF_API_EMAIL'] (required if --token not provided) - Email address associated with your Cloudflare account.
• --domain or ENV['CF_DOMAIN'] (required) - Comma separated domain names that should be updated. (i.e. mypage.example.com OR example.com)
• --ipendpoint or ENV['CF_IP_ENDPOINT'] (optional, default: https://api.ipify.org) - Alternative ip address service endpoint.

Note: One of --key and --email or --token must be defined

You can run with --help or -h to print help.