]> the.earth.li Git - autodns.git/blob - README
Release 1.0.0
[autodns.git] / README
1 autodns 1.0.0 - A program to aid auto addition of secondary DNS.
2 Copyright 1999-2006 Jonathan McDowell for Project Purple.
3 http://www.earth.li/projectpurple/progs/autodns.html
4
5
6 Introduction:
7
8 AutoDNS is a simple Perl script designed to allow the easy addition of
9 secondary DNS zones controlled via email.
10
11 The principle is simple. AutoDNS accepts a GPG clear signed email on
12 stdin, so can simply be added to a .forward file or whatever. You
13 configure it to know about the key IDs of all the people you wish to be
14 able to setup secondaries on your server and add their keys to the GPG
15 keyring for the user it runs under.
16
17 The config file is autodns.conf; its location is controlled near the top
18 of autodns.pl - it defaults to /etc/bind/autodns.conf. The other bit of
19 config that's needed is a users file.
20
21 You'll also need a way for the script to be able to do a "ndc reconfig"
22 to load the info about the new secondary domains - I do this using sudo.
23
24 The format of commands to AutoDNS is very simple. It current accepts 5
25 commands:
26
27 BEGIN
28         Indicate the beginning of a block of commands.
29 END
30         Indicate the end of a block of commands.
31 ADD <domain>
32         Add <domain> to the list of secondaried domains.
33 DEL <domain>
34         Delete <domain> from the list of secondaried domains, assuming
35         it's owned by the current user and is being secondaried
36         currently.
37 LIST
38         List secondaried domains.
39 HELP
40         Show basic help.
41
42 So a typical email would contain:
43
44 BEGIN
45 ADD foo.bar
46 END
47
48 as the body, which would then be signed with gpg --clearsign and sent.
49 AutoDNS will reply with the results of the commands sent to it.
50
51
52 Users file
53
54 The users file is of a very simple format. It contains one user per
55 line like so:
56
57 <userid>:<gpgkeyid>:<priv>:<master server>
58
59 So an example would be:
60
61 noodles:5B430367:0:212.135.138.190
62
63 Lines beginning with a '#' are treated as comments. See autodns.users in
64 the tarball for an example.
65
66
67 Contacting the author:
68
69 I can be reached as noodles@earth.li.
70
71 All constructive criticism about autodns is welcome.
72
73
74 License:
75
76 autodns is distributed under the GNU Public License, a copy of which
77 should have been provided with this archive as LICENSE.