cloudflare-dynamic-dns is a Node.js module that updates a particular Cloudflare DNS record with an IP address, creating it if it does not exist.
The easiest way to install cloudflare-dynamic-dns is using npm:
npm install cloudflare-dynamic-dns
You can also build cloudflare-dynamic-dns from source using npm:
git clone https://github.com/michaelkourlas/node-cloudflare-dynamic-dns.git npm install npm run-script build
build script will build the production variant of
cloudflare-dynamic-dns, run all tests, and build the documentation.
You can build the production variant without running tests using the script
prod. You can also build the development version using the script
The only difference between the two is that the development version includes
The documentation for the current version is available here.
You can also build the documentation using npm:
npm run-script docs
The following example illustrates the basic usage of cloudflare-dynamic-dns:
var ddns = ;var options =auth:email: "<email>"key: "<key>"recordName: "foo.bar.com"zoneName: "bar.com";ddns;
Additional examples can be found in the examples directory.
cloudflare-dynamic-dns includes a set of tests to verify core functionality. You can run the tests using npm:
npm run-script test-prod
The only difference between the
test-dev scripts is that the
development version includes source maps.
cloudflare-dynamic-dns is licensed under the Apache License 2.0. Please see the LICENSE.md file for more information.