===============================================================================
DDCLIENT v3.6.5

ddclient is a Perl client used to update dynamic DNS entries for accounts
on many dynamic DNS services.

IMPORTANT:	The format and options used by ddclient have CHANGED.
		Please examine the sample configuration file.
		It is highly recommended that you take advantage of the
		new daemon mode of operation.

IMPORTANT:	The installation location for the ddclient script has changed from
			/root/bin/
		to
			/usr/sbin/

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

Dynamic DNS services currently supported include:

DynDNS.org - See http://www.dyndns.org for details on obtaining a free account.
Hammernode - See http://www.hn.org for details on obtaining a free account.
Zoneedit   - See http://www.zoneedit.com for details.
EasyDNS    - See http://www.easydns.com for details.
NameCheap  - See http://www.namecheap.com for details

Also include is support for DSL Reports host monitoring service. [Highly recommended]
See http://dslreports.com for details.

DDclient now supports many of cable/dsl broadband routers. 

Comments, suggestions and requests can always be sent to:
	mailto:paul+ddclient@burry.ca

If you use ddclient, please send a brief note to:
	mailto:paul+ddclient@burry.ca
and indicate if you would like to be notified of new releases.

.. Paul Burry

IMPORTANT UPDATE:
Paul doesn't maintain the code anymore.  Everything is done through sf.net.
Please check out http://ddclient.sourceforge.net and the project page.

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

- one or more accounts from:
  DynDNS.org - See http://www.dyndns.org for details on obtaining a free account.
  Hammernode - See http://www.hn.org for details on obtaining a free account.
  Zoneedit   - See http://www.zoneedit.com for details.
  EasyDNS    - See http://www.easydns.com for details.
  NameCheap  - See http://www.namecheap.com for details

- Perl 5.004 or later

- Linux or probably any common Unix system

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

  cp ddclient /usr/sbin/
  mkdir /etc/ddclient
  cp sample-etc_ddclient.conf /etc/ddclient/ddclient.conf
  vi /etc/ddclient/ddclient.conf
  -- and change hostnames, logins, and passwords appropriately

  ## For those using Redhat style rc files and using daemon-mode:
  cp sample-etc_rc.d_init.d_ddclient /etc/rc.d/init.d/ddclient
  ## enable automatic startup when booting
  /sbin/chkconfig --add ddclient
  ## start the first time by hand
  /etc/rc.d/init.d/ddclient start

  ## If you are not using daemon-mode, configure cron and dhcp or ppp
  ## as described below.

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

  1. enable debugging and verbose messages.
	$ ddclient -daemon=0 -debug -verbose -noquiet

  2. Do you need to specify a proxy?
     If so, just add a
	proxy=your.isp.proxy
     to the ddclient.conf file.

  3. Define the IP address of your router with fw=xxx.xxx.xxx.xxx in
     /etc/ddclient/ddclient.conf and then try
    	$ ddclient -daemon=0 -query
     to see if the router status web page can be understood.

  4. Need support for another router/firewall?
     Define the router status page yourself with:
	fw=url-to-your-router's-status-page
	fw-skip=any-string-preceding-your-IP-address

     ddclient does something like this to provide builtin support for 
     common routers.
     For example, the Linksys routers could have been added with:
        fw=192.168.1.1/Status.htm
	fw-skip=WAN.*?IP Address

     OR
     Send me the output from:
      $ ddclient -geturl {fw-ip-status-url} [-login login [-password password]]
     and I'll add it to the next release!

     ie. for my fw/router I used:
	$ ddclient -geturl 192.168.1.254/status.htm

  5. Some broadband routers require the use of a password when ddclient
     accesses its status page to determine the router's WAN IP address.
     If this is the case for your router, add
	fw-login=your-router-login
	fw-password=your-router-password
     to the beginning of your ddclient.conf file.
     Note that some routers use either 'root' or 'admin' as their login
     while some others accept anything.

-------------------------------------------------------------------------------
USING DDCLIENT WITH ppp

If you are using a ppp connection, you can easily update your DynDNS
entry with each connection, with:
  ## configure pppd to update DynDNS with each connection
  cp sample-etc_ppp_ip-up.local /etc/ppp/ip-up.local

Alternatively, you may just configure ddclient to operate as a daemon
and monitor your ppp interface.

-------------------------------------------------------------------------------
USING DDCLIENT WITH cron

If you have not configured ddclient to use daemon-mode, you'll need to
configure cron to force an update once a month so that the dns entry will
not become stale.

  ## configure cron to force an update twice a month
  cp sample-etc_cron.d_ddclient /etc/cron.d/ddclient
  vi /etc/cron.d/ddclient

-------------------------------------------------------------------------------
USING DDCLIENT WITH dhcpcd-1.3.17

If you are using dhcpcd-1.3.17 or thereabouts, you can easily update
your DynDNS entry automatically every time your lease is obtained
or renewed by creating an executable file named:
  /etc/dhcpc/dhcpcd-{your-interface}.exe
ie.:
  cp sample-etc_dhcpc_dhcpcd-eth0.exe /etc/dhcpc/dhcpcd-{your-interface}.exe

In my case, it is named dhcpcd-eth0.exe and contains the lines:
  #!/bin/sh
  PATH=/usr/sbin:/root/bin:${PATH}
  logger -t dhcpcd IP address changed to $1
  ddclient -proxy fasthttp.sympatico.ca -wildcard -ip $1 | logger -t ddclient 
  exit 0

Other DHCP clients may have another method of calling out to programs
for updating DNS entries. 

Alternatively, you may just configure ddclient to operate as a daemon
and monitor your ethernet interface.

-------------------------------------------------------------------------------
USING DDCLIENT WITH dhclient

If you are using the ISC DHCP client (dhclient), you can update 
your DynDNS entry automatically every time your lease is obtained
or renewed by creating an executable file named:
  /etc/dhclient-exit-hooks
ie.:
  cp sample-etc_dhclient-exit-hooks /etc/dhclient-exit-hooks

Edit /etc/dhclient-exit-hooks to change any options required.

Alternatively, you may just configure ddclient to operate as a daemon
and monitor your ethernet interface.

-------------------------------------------------------------------------------
$Header: /cvsroot/ddclient/ddclient/README,v 1.8 2004/12/03 07:30:44 wimpunk Exp $
