https://github.com/roccomuso/no-ip

Noip.com Dynamic DNS update client built in Node.js
https://github.com/roccomuso/no-ip

client dns duc no-ip nodejs update

Last synced: 2 months ago
JSON representation

Noip.com Dynamic DNS update client built in Node.js

• Host: GitHub
• URL: https://github.com/roccomuso/no-ip
• Owner: roccomuso
• License: mit
• Created: 2017-04-14T09:43:47.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-01-26T18:02:46.000Z (11 months ago)
• Last Synced: 2024-10-24T13:52:11.708Z (2 months ago)
• Topics: client, dns, duc, no-ip, nodejs, update
• Language: JavaScript
• Homepage:
• Size: 105 KB
• Stars: 38
• Watchers: 5
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# no-ip [![Build Status](https://travis-ci.org/roccomuso/no-ip.svg?branch=master)](https://travis-ci.org/roccomuso/no-ip) [![NPM Version](https://img.shields.io/npm/v/no-ip.svg)](https://www.npmjs.com/package/no-ip) [![Dependency Status](https://david-dm.org/roccomuso/no-ip.png)](https://david-dm.org/roccomuso/no-ip) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) 

> [Noip.com](https://noip.com) Dynamic DNS update client built in Node.js. **It makes easy to remote access your connected devices**!

## Install

The easiest way to get **no-ip** is with npm:

    $ npm install no-ip --save

or having it globally installed and used as a standalone tool:

    $ npm install -g no-ip

## Example usage

```javascript

var NoIP = require('no-ip')

var noip = new NoIP({

  hostname: 'hello-world.ddns.net',

  user: '[email protected]',

  pass: 's3cr3tz'

})

noip.on('error', function(err){

  console.log(err)

})

noip.on('success', function(isChanged, ip){

  console.log(isChanged, ip)

})

noip.update() // Manual update, you can also provide a custom IP address

// noip.start() // start an automatic renewal every 1h by default or provide a custom ms.

// noip.stop() // stop the previously started automatic update

```

## Events

`.on('success', callback)`: The callback accepts two params `isChanged` and `ip` that gives you the current IP address your domain is currently pointing to and a boolean value indicating if an update was performed.

`.on('error', callback)`: Called when an [error](https://www.noip.com/integrate/response) occurs.

## Methods

`.update([ip])`: Send an update request. Optionally you can provide a custom IP.

`.start([ms])`: Start an automatic renewal every 1h by default or provide a custom [ms](https://github.com/zeit/ms).

`.stop()`: Stop the automatic update.

`.setOffline([boolean])`: Sets the current host to offline status. Offline settings are an Enhanced / No-IP Plus feature. You should call the `update` method after this flag have been set.

`.setIp([ip])`: Set a custom IP Address for the update requests.

## Standalone usage

If used standalone, I recommend you to start it with some process manager, like [PM2](https://github.com/Unitech/pm2).

    $ no-ip -h hello-world.ddns.net -u hello -p s3cr3t -s

That start automatic DNS renewal once an hour.

To see supported parameters and usage examples just type:

    $ no-ip --help

# Debug

This module makes use of the node [DEBUG](https://github.com/visionmedia/debug) module.

You can enable it setting the `DEBUG` env var to `no-ip` before the app starts:

    $ DEBUG=no-ip

## Author

Rocco Musolino ([@roccomuso](https://twitter.com/roccomuso))

## License

MIT