cloudflare-dyndns

cfddns (cloudflare-dyndns)

☁️ Automatic Cloudflare DNS updater for dynamic IP addresses

Requirements

• Node.js
• yarn (recommended) or npm
• Cloudflare account

Installation

yarn global add cloudflare-dyndns
# or
npm i -g cloudflare-dyndns

Before starting

Before you start, make sure you have the following ready:

• Cloudflare Zone ID of your domain (read how to find it here)
• Cloudflare API Token (read how to create it here)
  • Create it here
  • The token should have the following permission(s) on the zone you want to update:
    • Zone:DNS:Edit

Usage

cfddns # Starts the tool, will guide you through configuration on first run
cfddns --help # Shows help

Help

Usage: cfddns [options]

A CLI tool for automatically updating Cloudflare DNS records

Options:
  -V, --version             output the version number
  -c, --config              Force the config wizard to run even when config file is present
  -o, --once                Run the updater only once and then exit
  -w, --webserver           Force the web server to run even when disabled in config
  -dw, --disable-webserver  Force the web server to not run even when enabled in config
  -npw, --no-password       Make the webserver run passwordless
  -h, --help                Show this help message
  -d, --debug               Enable debug logging

How to report issues/questions

• For general issues/questions, open an issue

License

As this is an open-source project, support is limited. Please use GitHub Issues for support

ℹ️ All code in this repository is licensed under the MIT License.