DuckDNSUpdater

A simple lightweight https update function for DuckDNS

Installation

Use npm to install it:

npm install duckdnsupdater

Or simply clone this repository in your project.

Usage

To use it, you need to specify some parameters:

const duckdns = require('duckdnsupdater')(domain,token,minutes,noParamReq,onResponse);

• domain (Required): The domain name of your DuckDNS: http://domain.duckdns.org
• token (Required): Your token (you can find it in your duckdns page)
• minutes (Optional, default: 5): Every how many minutes you need to ping the server
• noParamReq (Optional, default: false): A boolean.
  If false the request will be:

  https://duckdns.org/update?domains=domain&token=token&verbose=true

  If true:

  https://duckdns.org/update/domain/token

• onResponse (Optional): The callback function for every request.
  If not specified, the output in the console will be something like that:

  |DUCKDNS|info| Pinged domain, ip: 32.69.69.169, NOCHANGE

  and if there's an error, it will be something like that:

  |DUCKDNS|WARN| Error, response: 
  ...

  If you want to specify your function, you need to do:

  const duckdns = require('duckdnsupdater')(mydomain,mytoken,minutes,noParamReq,(data)=>{
    // work here with the data returned
  });

What's new

Version 1.1.x

With the new update, the require module returns an instance of the DuckDNSUpdater class.
After requiring it, to start the request you need to do:

duckdns.start();

To stop it, simply do:

duckdns.stop();

Version 1.0.x

After requiring the module, the function will start automatically.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT