← Back to branch summary

~ubuntu-branches/ubuntu/trusty/maradns/trusty

« back to all changes in this revision

Viewing changes to doc/en/source/quick_start.ej

  • Committer: Package Import Robot
  • Author(s): Nicholas Bamber
  • Date: 2012-01-06 08:47:03 UTC
  • mfrom: (1.1.17) (10.1.12 experimental)
  • Revision ID: package-import@ubuntu.com-20120106084703-e3kw2c5a6djne2gw
Tags: 2.0.04-1
http://bugs.debian.org/612229
http://bugs.debian.org/477787
* Allowed watch file to pick up 2.x releases
* New upstream release
* Refreshed patches
* Added override to stop deletion of server/MaraDNS.c.orig
* Added patch to stop corruption of deadwood source code
* Added public domain stanza trying to give useful information about
  the public domain status (or otherwise) of certain files.
* Updated doc-base index file
* Split out documentation into separate package as it is written from
  an upstream point of view
* Added askmara-tcp tool to maradns-zoneserver package
* Added experimental maradns-deadwood package (Closes: #612229)
* Turned on compilation for IPv6 (Closes: #477787)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/source/quick_start.ej
8
8
<i>This guide is for experienced UNIX/Linux/BSD users who just want to 
9
9
   quickly try out MaraDNS</i>
10
10
<p>
11
 
MaraDNS acts as both a recursive and an authoritative DNS server.  In
12
 
other words, MaraDNS can both be used to speed up the internet, and/or
13
 
serve domains that you may have.
 
11
MaraDNS acts as an authoritative DNS server.  Recursion is handled by
 
12
the included "Deadwood" program.  
14
13
<p>
15
14
 
16
 
To try out MaraDNS as a recursive nameserver is easy:
 
15
To try out Deadwood as a recursive nameserver:
17
16
<ul>
18
17
 
19
 
<li>Compile MaraDNS.  Type in './configure; make' in the 
 
18
<li>Compile MaraDNS and Deadwood.  Type in './configure; make' in the 
20
19
  top-level MaraDNS directory.
21
20
  Note: No need to compile if you downloaded a binary RPM or Debian package.
22
21
 
 
22
<li>The the file deadwood-{version number}/src/Deadwood and place it in
 
23
    /usr/local/sbin
 
24
 
23
25
<li>Take the file server/maradns and place it in /usr/local/sbin
24
26
 
25
27
<li> Take the file tools/duende and place it in /usr/local/sbin
26
28
 
27
29
<li>Create an empty directory called /etc/maradns
28
30
 
29
 
<li>Create a mararc file.  This file only needs to be three lines long
30
 
    on systems with a /dev/urandom file, and four lines long on older
31
 
    operating systems without /dev/urandom
 
31
<li>Create a dwood3rc file.  This file only needs to be three lines long
 
32
    on systems with a /dev/urandom file.
32
33
<p>
33
 
     Here is a sample mararc file:
 
34
     Here is a sample dwood3rc file:
34
35
<pre>
35
36
        ipv4_bind_addresses = "127.0.0.1"
36
37
        chroot_dir = "/etc/maradns"
37
38
        recursive_acl = "127.0.0.1"
38
39
</pre>
39
 
     This mararc file says that MaraDNS will have the ip "127.0.0.1" (this
 
40
     This dwood3rc file says that MaraDNS will have the ip "127.0.0.1" (this
40
41
     is the bind_address), run from the directory /etc/maradns (the chroot_dir
41
42
     value), and only allow the ip "127.0.0.1" to make recursive queries (the
42
43
     recursive_acl value).
43
44
 
44
 
<li>Place the mararc file in the location /etc/mararc on your system.
 
45
<li>Place the dwood3rc file in the location /etc/dwood3rc on your system.
45
46
 
46
 
<li>Run MaraDNS as a non-daemon: 
 
47
<li>Run Deadwood as a non-daemon: 
47
48
<blockquote>
48
49
<pre>
49
 
        /usr/local/sbin/maradns
 
50
        /usr/local/sbin/Deadwood
50
51
</pre>
51
52
</blockquote>
52
 
Since MaraDNS needs to bind to a privileged port (port 53), it needs
53
 
to start up running as root.  MaraDNS is designed with security in mind, and
 
53
Since Deadwood needs to bind to a privileged port (port 53), it needs
 
54
to start up running as root.  Deadwood is designed with security in mind, and
54
55
will drop root privileges before being visible to the public internet.
55
56
 
56
 
<li>Test MaraDNS in another window or virtual terminal
 
57
<li>Test Deadwood in another window or virtual terminal
57
58
     
58
59
<blockquote>
59
60
<pre>
70
71
</pre>
71
72
</blockquote>
72
73
 
73
 
<li>If this works, make MaraDNS run as a daemon:
 
74
<li>If this works, make Deadwood run as a daemon:
74
75
 
75
76
<blockquote>
76
77
<pre>
77
 
        /usr/local/sbin/duende /usr/local/sbin/maradns
 
78
        /usr/local/sbin/duende /usr/local/sbin/Deadwood
78
79
</pre>
79
80
</blockquote>
80
81
 
81
82
     duende is a tool that daemonizes maradns; the daemonizer is a separate
82
83
     program.
83
84
 
84
 
<li>If this all works, install MaraDNS:
 
85
<li>If this all works, install MaraDNS and Deadwood:
85
86
<blockquote>
86
87
<pre>
87
88
        make install
90
91
</ul>
91
92
<p>
92
93
 
93
 
It is also possible to set up MaraDNS as both an authoritative and recursive
94
 
name server with the same IP:
 
94
It is also possible to set up the program "maradns" as an authoritative
 
95
name server:
95
96
 
96
97
<ul>
97
98
<li>Here is the MaraRC file:
98
99
<pre>
99
100
        ipv4_bind_addresses = "127.0.0.1"
100
101
        chroot_dir = "/etc/maradns"
101
 
        recursive_acl = "127.0.0.1"
102
102
        csv2 = {}
103
103
        csv2["example.com."] = "db.example.com"
104
104
</pre>
110
110
    (Yes, experienced DNS admins, you can have SOA, NS, MX, SRV, and any other
111
111
     kind of DNS data stored in a csv2 zone file.  Read the csv2 man page for
112
112
     details)
113
 
<li>Recursive queries will be resolved normally
114
113
<li>Queries for <tt>example.com</tt> will resolve to 10.1.2.3
115
114
<li>Any other 
116
115
<tt>name.example.com</tt> query will return a "this host does not exist"
118
117
</ul>
119
118
 
120
119
Look in doc (in particular, the tutorial), or read the relevant man 
121
 
pages for more information on how to set up MaraDNS.
 
120
pages for more information on how to set up Deadwood and MaraDNS.
122
121
<p>
123
122
 
124
123
</ul>