Read Me

===============================================================================
Oh Jasmin Dynamic DNS (ohjasmindns for short) v1.0

ohjasmindns is a set of scripts which together with an instance of djbdns or 
dbndns form a dynamic dns (dyndns) server. Send a web requests to your server 
and ohjasmindns takes care that your hostname always points to your current IP 
address.

===============================================================================

Dynamic DNS clients we tested ohjasmindns with include:

DDclient  - See https://sourceforge.net/apps/trac/ddclient/wiki

The projects website for comments, suggestions and requests:  

https://sourceforge.net/projects/ohjasmindns/

-------------------------------------------------------------------------------
REQUIREMENTS:

- an active instance of djbdns or dbndns.
- some webserver which runs php. we tested it with lighttpd and apache.
- interactive user account to install ohjasmindns.

-------------------------------------------------------------------------------
FILE DESCRIPTION:

dyndns.php: 
This is the web file which does the communication between your dyndns clients
and the ohjasmindns backend. 

updatedyndns.sh:
This file takes our own file format and writes all dyndns configs to 
/etc/tinydns/root/base_files/dyndns so that the dbndns package can use it.

updatedns.sh:
This is the script calling dbndns to update its cache.

-------------------------------------------------------------------------------
INSTALLATION:

## First of all, place dyndns.php into your www folder

cp dyndns.php /var/www

## Then make sure to create the folder structure for all dynamic dns config
## files.

cd /etc
mkdir dyndns
cd dyndns
mkdir hosts

## make sure your www user has write access to these files

chown -R www-data:www-data hosts
chmod -R 755 hosts

## Place both .sh files into /etc/tinydns/root
## They need to be in the same folder as your domain configuration

cp updatedyndns.sh
cp updatedns.sh

## rename
mv updatedyndns.sh updatedyndns
mv updatedns.sh updatedns

## Now we need to configure the sudoers file. Add this line to allow
## your webserver to call the updatedyndns script.

# User privilege specification
www-data        ALL = (ALL) NOPASSWD: /etc/tinydns/root/updatedyndns

## now for every dynamic dns client host you want to use you will need the
## following structure (folders and files with dynip as an ending).

/etc/dyndns/hosts/<domain>/<md5hashofpassword>/<ip>.dynip

## example

/etc/dyndns/hosts/dyn1.swordlord.com/khjpowqierkmnasd/127.0.0.1.dynip

## use php to get the md5 Hash of your password by calling this function:

print md5("my very hard to crack password!!!");

## the file your.current.ip.address.dynip will represent your current IP 
## address. the file is empty.
## 
## Now that you have done everything, you may test your installation.

-------------------------------------------------------------------------------
TROUBLESHOOTING:

  1. send us your problems, we will add the most common solutions to this file

-------------------------------------------------------------------------------
$Id$