README
1dnsmax.pl Readme
2------------------
3The dnsmax.pl perl script is a dynamic DNS update client that is
4compatible with the dnsmax.com and thatip.com DNS services.
5
6dnsmax.pl is responsible for keeping your DNS records pointed
7at your current IP address. When run, the program checks to see
8whether your IP address has changed since the last time an
9update was sent to our servers. If it has, the program sends
10an update.
11
12The program should be scheduled to run every few minutes.
13
14
15GETTING STARTED
16-----------------
17You may need to install some perl modules in order for dnsmax.pl
18to function. Please see the INSTALL file for details.
19
20Follow these steps to start using dnsmax.pl.
21
221. Run `./dnsmax.pl --configure`. Enter your account information
23 as prompted.
24
252. Run `./dnsmax.pl --fetchhosts`. Any dynamic DNS records that
26 you have configured in your account will be downloaded into
27 your configuration files.
28
293. Run `./dnsmax.pl --choosehosts`. Follow the instructions to
30 determine which of your hosts should be updated on this
31 computer.
32
334. Add a crontab entry to run
34 `/path/to/perl /path/to/dnsmax.pl --updateip`
35 every few minutes.
36
37
38USAGE SUMMARY
39---------------
40Usage: dnsmax.pl MODE [configuration_file]
41
42Available Modes
43
44--configure Create or edit a configuration file; set the account's
45 user name, password, and other settings.
46--fetchhosts Retrieve the latest list of dynamic DNS records for
47 the configured account. Determine which records
48 should be updated when an IP change is detected.
49--choosehosts Choose which hosts will be updated when an IP change is
50 detected.
51--updateip Determine whether the network's IP has changed since the
52 the last time it was checked, and send an update if
53 necessary.
54
55If configuration_file is not specified, a file named dnsmax.conf located
56in the working directory will be assumed.
57
58