DynIP 0.1e
A painfully simple UDP Client/Server for tracking the IP addresses of your devices.
License: BSD
Keywords: udp ip tracking

About DynIP
===========

DynIP is an embarrasingly-simple client and server purely for getting systematic updates of a client's IP address.


How it works
------------

The client is typically configured to run on a schedule basis using crontab or Windows Scheduled Tasks.  When launched, the client sends a UDP datagram to the server, with it's hostname in the data packet.

The server, when it receives the UDP datagram, opens a JSON file at the path specified in the ``CLIENT_LOG_PATH``.  The server looks to see if the client name (the data portion of the packet) is already in the list of known addresses.  If it is, it updates the record with the new IP address from the packet header and the current date and time.  If it is new, it adds it to the dict of known hosts.


Installation
------------

Either download the package from PyPi, or use easy_install: ::

    $ easy_install DynIP

Usage
=====

Configuration
-------------

First, build a configuration file to start from: ::

    $ dynip-init [path for configuration file]

DynIP will create a configuration file at the path you specify. 

To configure the server, copy or edit the .conf file and set the ``server_ip``, ``server_port`` and ``client_log_path`` parameters in the ``DynIP:Server`` section.  Descriptions of each are in the .conf file.


Launching the Server
--------------------

Start the server by typing: ::

    $ dynipd [path to .conf file]

The server will endlessly listen for packets until it is killed (by pressing CTRL-C if you launched it in the foreground, or killing it by the PID if you launched it in the background).


Launching the Client
--------------------

To launch the client and have it fire off a UDP packet, edit your .conf file, and modify the ``server_hostname`` and ``server_port`` lines in the ``DynIP:Client`` section.  Descriptions of each are in the code.

Then launch the client by typing: ::

    $ dynipc [path to .conf file]

The client will fire a single UDP packet to the server.  The server will then save the hostname, ip address and date/time in the file specified in ``client_log_path`` in the .conf file.

Options
-------

To enable verbose (INFO-level) logging, add `-v` to the command line when launching the server or client. ::

    $ dynipd -v [path to .conf file]
    $ dynipc -v [path to .conf file]


To enable debug (DEBUG-level) logging, add `--debug` to the command line when launching the server or client. ::

    $ dynipd --debug [path to .conf file]
    $ dynipc --debug [path to .conf file]


Both the server and client return usage information if you add `--help` or `-h` to the command line when invoking the client or server.


Why I Built It
==============

I am about to go on an extended trip away from home, yet need to know the dynamic IP address that is assigned to my home cable router so that I can easily help my family remotely in case they need help with their computers.  In order to do this, I need to know the IP address that my cable provider as assigned to my cable modem.

By installing the client on each of my computers at home and triggering the client to run every 5 minutes, the server will always keep a log of the most recent public IP address of the boundary device.


License
=======

DynIP is licensed under the BSD License.  See the LICENSE file.