cloudflare-dynamic-dns
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.2 • Public • Published

    cloudflare-dynamic-dns

    Build Status npm version

    Overview

    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.

    Installation

    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
    

    The 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 dev. The only difference between the two is that the development version includes source maps.

    Usage

    The documentation for the current version is available here.

    You can also build the documentation using npm:

    npm run-script docs
    

    Examples

    The following example illustrates the basic usage of cloudflare-dynamic-dns:

    var ddns = require("cloudflare-dynamic-dns");
     
    var options = {
        auth: {
            email: "<email>",
            key: "<key>"
        },
        recordName: "foo.bar.com",
        zoneName: "bar.com"
    };
     
    ddns.update(options, function(err) {
        if (err) {
            console.log("An error occurred:");
            console.log(err);
        } else {
            console.log("Success!");
        }
    });

    Additional examples can be found in the examples directory.

    Tests

    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-prod and test-dev scripts is that the development version includes source maps.

    License

    cloudflare-dynamic-dns is licensed under the Apache License 2.0. Please see the LICENSE.md file for more information.

    Install

    npm i cloudflare-dynamic-dns

    DownloadsWeekly Downloads

    11

    Version

    1.0.2

    License

    Apache-2.0

    Unpacked Size

    55.9 kB

    Total Files

    19

    Last publish

    Collaborators

    • avatar