% WtDNS Installation
% Jonas Eckerman <jonas@truls.org>
% 2012-09-26 19:53:25 UTC (v0.002)

# Installation

This thing does not have any kind of advanced installation stuff that
automagically tailors the installation to suite your system. Currently it
doesn't even have any simple provisions for manually choosing paths and stuff.
Neither does it have any checks or options to make it compile in different
systems. It compiles and installs fine in my Ubuntu systems, but you may have
to edit some source code and makefiles files to install it in your system.

The install procedure goes something like this:

0: Edit "wtdnsd/knobs.h" if you want to change some hardcoded stuff in wtdnsd.

1: Run "make". Hope that it works. If it stops with an error, try to fix it.

2: Run "make install".

3: Try to run installed programs. When they complain about missing perl
   modules, install those modules and try again.

4: Edit configuration and init files.

Step 2 will install executables, documentation and example configuration
files. To actually use the system, you'll need to edit the configuration. If
your system is not using Upstart, you'll have to create an init script.

If you run into problems at step 1, please tell me about them. Maybe I can do
something to the makefiles or source code to make it work.

# Installed Files

The following files will be installed if the directory structure seems
suitable.

## /usr/share/doc/wtdns/*

The text documentation, as well as configuration examples, are installed to
this directory.

## /etc/wtdns/wtdns.ini

An example configuration file for the DNS server and utilities. Edit it to
suite your system.

## /etc/wtdns/apache_wtdns-fromlog_vhost.conf

An example virtual host configuration for using wtdns-fromlog together with
Apache httpd as a dynamic DNS service updater.

## /etc/cron.d/wtdns

A cron definition for running wtdns-maintain to clean old records in the
dynamic DNS system. The definition is commented so it is not actually used
unless you edit the fule.

## /etc/init/wtdnsd.conf

An Upstart job definition for the WtDNS daemon. The job is set to "manual"
so you'll have to edit the file if you want the system to automagically start
the daemon.

## Man pages

The installation installes man pages to "/usr/share/man/" and/or
"/usr/man/" if found.

## /usr/bin/*

The commands wtdnshash, wtdnsadd, wtdns-deepen and wtdns-flatten will be
installed here.

## /usr/sbin/*

The programs wtdnsd, wtdns-fromlog and wtdns-maintain will be installed here.

# Configuration

The documentation for the different pieces and the configuration file contains
information about configuring and running WtDNS.
