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

A shell script that works as Dynamic Update Client (DUC) for noip.com
https://github.com/theonemule/no-ip

dynamic-dns dynamic-update-client no-ip

Last synced: 7 days ago
JSON representation

A shell script that works as Dynamic Update Client (DUC) for noip.com

• Host: GitHub
• URL: https://github.com/theonemule/no-ip
• Owner: theonemule
• License: mit
• Created: 2015-03-17T17:44:19.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-03-16T00:11:18.000Z (8 months ago)
• Last Synced: 2024-08-02T14:10:37.368Z (3 months ago)
• Topics: dynamic-dns, dynamic-update-client, no-ip
• Language: Shell
• Homepage:
• Size: 17.6 KB
• Stars: 119
• Watchers: 9
• Forks: 47
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: license

Awesome Lists containing this project

README

        
I'm probably not the first one to do this, but I had a need to use NO-IP's dynamic DNS service so I could easily configure devices and computers to access resources on my LAN when I'm away. For those less familiar with NO-IP, it is a free dynamic DNS service. Most home and small office connections to the Internet have a dynamic IP, which means the IP addresses changes most every time the connection from the router is established. Typically, a domain name requires a static IP address to work. Dynamic DNS  allows  a domain name (i.e subdomain.example.com) to use a dynamic IP by updating NO-IP with a new IP address when the IP address changes. NO-IP then associates that IP with the domain name so services can be setup against the domain rather than the IP that changes. This makes configuring things easier.

Many routers have a built in NO-IP client, but my router doesn't support NO-IP, and for whatever reason, I could never get the client that NO-IP recommended for a Linux host to work. I downloaded the source and compile it following the instructions, and it appeared to be running, but it never updated my IP address. There was no output to the console or to a log file either to diagnose the problem that I could find, so I decided to go about writing my own, which really wasn't that hard to do using a bash script and a few simple utilities on my Linux box. Here is my how-to guide and documentation for setting this up. I'm running Ubuntu server so I'm using apt and nano, but this should work on anything POSIX based such as Mac OS X, BSD, any flavor of Linux -- even the Raspberry Pi.

The script can be run as a single instance with command line parameters, as a daemon, using crontabs (a utility for running programs on a schedule) or as a Linux service. 

This script has one dependency, which is wget. This is usually installed by default on most Linux and BSD distros, but if not use your package manager to install it.

      sudo apt-get install wget

-or-

      sudo yum install wget

Usage:

------

      no-ip.sh -u=username -p=password -h=host.sample.com -d=true -l=/path/to/logfile.log

Parameters:

    -u, --username 

Username to logon to no-ip.com.

    -p, --password

Password to logon to no-ip.com.

    -h, --hostname

The domain name to update.

    -d, --detectip

Tells the script to detect your external IP address. This takes precedence over -i.

    -i, --ip

Maually sets the IP address to update. If neither -d or -i are specified, no-ip will use the IP address it detects.

    -n, --interval

When running the script as a daemon/service (see Installation), this will update no-ip every n minutes.

    -l, --logfile

Sets the path to a log file. This file must be writable.

    -c, --config

Sets the path to a config file. This file must be readable. Config file parameters take precedence over command line parameters.

Examples:

---------

    no-ip.sh 

Runs the script with the settings in the config file in the default locaion /etc/no-ip/no-ip.conf

    no-ip.sh -u=username -p=password -h=host.sample.com -d=true -l=/path/to/logfile.log

Does a one-time update, detecting the UP and logging the results

    no-ip.sh -c=/home/username/no-ip.conf

Run the script with the settings in the config file.

    no-ip.sh /dev/null 2>&1 &

Runs the script as a daemon with the settings in the config file in the default locaion /etc/no-ip/no-ip.conf.

Config File:

------------

The config file uses a simple syntax to define parameters. Any command line parameter (except --config) can also be specified in the config file. The same rules apply for the config file parameters as caommand line parameters (ie. "detectip" overrides "ip" if both are specified).

Example:

    user=username 

    password=password 

    hostname=hostname.example.com

    logfile=/var/log/no-ip.log

    interval=10

    detectip=true

Installation:

-------------

**Before installing the script, download and extract the files to your local machine. The instructions assume your are in the no-ip-master folder.**

      cd ~

      wget https://github.com/theonemule/no-ip/archive/master.zip

      unzip master.zip

      cd no-ip-master

      

Method 1: crontabs

Crontabs allows you to specify a schedule to run the script and it will also run the script as the user the crontab is configured for. Make sure that the user has execute permissions on the script, read permissions on the config file, and write permissions to the log file. **Crontabs will run the script on a scheduled basis so there is no need to specify an interval.**

Here's how to run the script as root.

1.) Create a folder in etc.

    sudo mkdir /etc/no-ip

2.)  Create a config file.

    sudo touch /etc/no-ip/no-ip.conf

3.) Set the parameters with your favorite editor. I use nano.  See the Config File section above for details.

 

    sudo nano /etc/no-ip/no-ip.conf

    

    user=username 

    password=password 

    hostname=hostname.example.com

    logfile=/var/log/no-ip.log

    detectip=true

4.) Copy no-ip.sh to /usr/sbin

    sudo cp no-ip.sh /usr/sbin/no-ip.sh

5.) Make the script executable

    sudo chmod +x /usr/sbin/no-ip.sh

6.) Logon as root

    sudo -i

7.) Edit root's crontab

    crontab -e

8.) Add the entry to the bottom. */10 tells crontab to run the script every time the current time is divisble by 10, or every 10 minutes and save the crontab.

    */10 * * * * /usr/sbin/no-ip.sh

Method 2: Linux Service (written for Debian-based distros. This will vary for other distros)

Make sure root has execute permissions on the script, read permissions on the config file, and write permissions to the log file. 

1.) Create a folder in /etc.

    sudo mkdir /etc/no-ip

2.) Create a config file.

    sudo touch /etc/no-ip/no-ip.conf

3.) Set the parameters with your favorite editor. I use nano.  See the Config File section above for details.

    sudo nano /etc/no-ip/no-ip.conf

    

    user=username 

    password=password 

    hostname=hostname.example.com

    logfile=/var/log/no-ip.log

    interval=10

    detectip=true

4.) Copy no-ip.sh to /usr/sbin

    sudo cp no-ip.sh /usr/sbin/no-ip.sh

5.) Make the script executable

    sudo chmod +x /usr/sbin/no-ip.sh

6.) Copy no-ip-service to init.d

    sudo cp no-ip-service /etc/init.d/no-ip-service

7.) Make no-ip-service executable

    sudo chmod +x /etc/init.d/no-ip-service

8.) Start the service

    sudo service no-ip-service start

9.) Add the service to start at boot.

    update-rc.d no-ip-service defaults