heathcliff26/cloudflare-dyndns repository overview

⁠cloudflare-dyndns

Implements the API from Fritz!Box DynDNS Script for Cloudflare⁠, but can also be used as a standalone client.

Additionally to consuming less resources and being a smaller image, it also implements POST in addition to GET requests, meaning no longer does the token need to be included in the url.

The client package can also be used as a golang API, should you want to build your application with included cloudflare dyndns capabilities.

⁠Table of Contents

• cloudflare-dyndns⁠
  • Table of Contents⁠
  • Container Images⁠
    • Image location⁠
    • Tags⁠
  • Usage⁠
  • API (Server Mode)⁠
    • Examples⁠

⁠Container Images

⁠Image location

⁠Tags

There are different flavors of the image:

⁠Usage

The binary can be run either as a server, a standalone client or in relay mode where it will call a server.

The main use case for relay mode would be when you want to restrict your cloudflare API key to a static IP.

Output of cloudflare-dyndns -h

Usage of cloudflare-dyndns:
  -config string
        Path to config file, can be empty when running in mode server
  -env
        Used together with -config, when set will expand enviroment variables in config
  -mode string
        Set what mode to run, options are "server", "client" and "relay" (default "server")

An example config can be found here⁠.

⁠API (Server Mode)

⁠Examples

Here is an example GET request:

https://dyndns.example.com/?token=testtoken&domains=foo.example.net,bar.example.org,example.net&ipv4=100.100.100.100&ipv6=fd00::dead&proxy=true

or alternatively in the format Fritz!Box DynDNS Script for Cloudflare⁠ from :

http://example.org/?cf_key=testtoken&domain=foo.example.net&ipv4=100.100.100.100&ipv6=fd00::dead&proxy=true

When using POST the format is:

{
  "token": "",
  "domains": [
    "foo.example.org",
    "bar.example.net"
  ],
  "ipv4": "100.100.100.100",
  "ipv6": "fd00::dead",
  "proxy": true
}