Introducing npm Teams! Private packages + team management tools.Learn more »

dnsimple-dyndns

2.0.0 • Public • Published

DNSimple Dynamic DNS

A simple Node JS application to sync a DNSimple DNS record of your choosing with your dynamic IP.

oclif Version Downloads/week License

Usage

$ npm install -g dnsimple-dyndns
$ dnsimple-dyndns COMMAND
running command...
$ dnsimple-dyndns (-v|--version|version)
dnsimple-dyndns/2.0.0 linux-x64 node-v10.15.2
$ dnsimple-dyndns --help [COMMAND]
USAGE
  $ dnsimple-dyndns COMMAND
...

Commands

dnsimple-dyndns config

Run through the setup Wizard and create a configuration file

USAGE
  $ dnsimple-dyndns config

OPTIONS
  -d, --domain=domain        The Domain Name you wish to use
  -q, --quiet                Do not display any output
  -s, --subDomain=subDomain  The Sub-Domain Name you wish to use
  -t, --token=token          DNSimple API Token belonging to an account

See code: src/commands/config.js

dnsimple-dyndns help [COMMAND]

display help for dnsimple-dyndns

USAGE
  $ dnsimple-dyndns help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

dnsimple-dyndns show

Show the current configuration

USAGE
  $ dnsimple-dyndns show

See code: src/commands/show.js

dnsimple-dyndns sync

Sync the configured record with your current IP

USAGE
  $ dnsimple-dyndns sync

OPTIONS
  -f, --force  Force the sync to happen, even if your IP hasn't changed
  -q, --quiet  Do not display any output

See code: src/commands/sync.js

Cron job

  1. Configure your record by running:

  2. Find out where the package was installed:

    $ npm root -g dnsimple-dyndns

    You should get a response, such as /usr/local/lib/node_modules/bin/dnsimple-dyndns.

  3. Create a crontab entry by typing the following command

    $ crontab -e

    and then add the following line

    */5 * * * * /usr/local/lib/node_modules/bin/dnsimple-dyndns sync

    This will create a crontask that run every 5 minutes.

    Please see Cron Cheatsheet for more assistance with this.

Install

npm i dnsimple-dyndns

DownloadsWeekly Downloads

1

Version

2.0.0

License

CC-BY-NC-SA-4.0

Unpacked Size

36 kB

Total Files

12

Last publish

Collaborators

  • avatar