Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 2.47 KB

README.md

File metadata and controls

28 lines (19 loc) · 2.47 KB
Raw

CloudFlare Dynamic DNS

This Rust program allows you to use the free CloudFlare DNS service as a dynamic DNS provider. It provides functions to get your external IPv4 and IPv6 addresses, get the ID of a DNS zone, and create or update a DNS record in that zone.

This is a strongly inspired by hotio's excellent CloudFlareDDNS tool. Initially, I wrote this to practice writing Rust code.

Usage

To use this program, you will need a CloudFlare account and an API key. You can find instructions for how to generate an API key in the CloudFlare documentation.

Once you have an API key, you can set the environment variables to configure the program.

It will your external IP address(es), get the ID of the specified DNS zones, and create or update a DNS record in those zones.

Environment

  • CLOUDFLAREDDNS_USER and CLOUDFLAREDDNS_APIKEY: The username/API key for your CloudFlare account. These are used to authenticate with the CloudFlare API.
  • CLOUDFLAREDDNS_RECORDTYPES: A semicolon-separated list of record types to create/update. This can include A, AAAA, or both.
  • CLOUDFLAREDDNS_HOSTS: A semicolon-separated list of hostnames to update. This should be the name of the DNS record that you want to create/update in each zone.
  • CLOUDFLAREDDNS_ZONES: A semicolon-separated list of zone names to update. This should be the name of the DNS zone that contains the record that you want to update.
  • CLOUDFLAREDDNS_IPV4_API_ENDPOINT/CLOUDFLAREDDNS_IPV6_API_ENDPOINT: The API endpoint to use to obtain the current external IPv4 and IPv6 address, respectively. This variable is optional and by default CloudFlareDDNS uses the https://api.ipify.org and https://api6.ipify.org endpoints.
  • CLOUDFLAREDDNS_REPEAT_INTERVAL is used to specify the interval at which the DNS records should be updated. Every time they are updated, the external IP addresses are retrieved again as well. This variable is optional and, if not specified, the program will run only once and then exit.

Note that CLOUDFLAREDDNS_HOSTS and CLOUDFLAREDDNS_ZONES are parsed as parallel arrays. In other words, they must contain a matching number of elements, and each element's position in the variable should match the position of the corresponding element in the other variable.

License

This program is licensed under the GPLv3 license. See LICENSE for more information.