[d224244f] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY unbound-download-http "http://www.unbound.net/downloads/unbound-&unbound-version;.tar.gz">
|
---|
| 8 | <!ENTITY unbound-download-ftp " ">
|
---|
[4e9f7412] | 9 | <!ENTITY unbound-md5sum "0cefa62c1690b4db18583db84bff00e3">
|
---|
[a8e34533] | 10 | <!ENTITY unbound-size "4.7 MB">
|
---|
| 11 | <!ENTITY unbound-buildsize "47 MB (with tests)">
|
---|
| 12 | <!ENTITY unbound-time "0.7 SBU (with tests)">
|
---|
[d224244f] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="unbound" xreflabel="Unbound-&unbound-version;">
|
---|
| 16 | <?dbhtml filename="unbound.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
[d027410] | 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
[d224244f] | 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Unbound-&unbound-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="unbound">
|
---|
| 26 | <primary sortas="a-Unbound">Unbound</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Unbound</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | <application>Unbound</application> is a validating, recursive, and caching
|
---|
| 34 | DNS resolver. It is designed as a set of modular components that
|
---|
| 35 | incorporate modern features, such as enhanced security (DNSSEC)
|
---|
| 36 | validation, Internet Protocol Version 6 (IPv6), and a client resolver
|
---|
| 37 | library API as an integral part of the architecture.
|
---|
| 38 | </para>
|
---|
| 39 |
|
---|
[2a589b08] | 40 | &lfs7a_checked;
|
---|
[d224244f] | 41 |
|
---|
| 42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 43 | <itemizedlist spacing="compact">
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (HTTP): <ulink url="&unbound-download-http;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download (FTP): <ulink url="&unbound-download-ftp;"/>
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download MD5 sum: &unbound-md5sum;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Download size: &unbound-size;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated disk space required: &unbound-buildsize;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
| 70 | <para>
|
---|
| 71 | Estimated build time: &unbound-time;
|
---|
| 72 | </para>
|
---|
| 73 | </listitem>
|
---|
| 74 | </itemizedlist>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect3">Unbound Dependencies</bridgehead>
|
---|
| 77 |
|
---|
| 78 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 79 | <para role="required">
|
---|
| 80 | <xref linkend="openssl"/>
|
---|
[1b472ab] | 81 | <!-- broken?
|
---|
| 82 | or <xref linkend="nss"/>
|
---|
| 83 | -->
|
---|
[d224244f] | 84 | </para>
|
---|
| 85 |
|
---|
| 86 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 87 | <para role="optional">
|
---|
| 88 | <xref linkend="libevent"/>,
|
---|
[a8e34533] | 89 | <xref linkend="nettle"/>,
|
---|
[283bd88] | 90 | <xref linkend="python2"/>,
|
---|
[90a3dc30] | 91 | <xref linkend="swig"/> (for Python bindings),
|
---|
[a8e34533] | 92 | <xref linkend="doxygen"/> (for html documentation),
|
---|
[62b4c35] | 93 | <!--<ulink url="http://sourceforge.net/projects/expat/">expat</ulink>, installed by LFS. -->
|
---|
[a8e34533] | 94 | <ulink url="http://dnstap.info/">dnstap</ulink>, and
|
---|
| 95 | <ulink url="https://pypi.python.org/pypi/Sphinx">Sphinx</ulink> (for
|
---|
| 96 | Python bindings documentation)
|
---|
[d224244f] | 97 | </para>
|
---|
| 98 |
|
---|
| 99 | <para condition="html" role="usernotes">User Notes:
|
---|
| 100 | <ulink url="&blfs-wiki;/unbound"/>
|
---|
| 101 | </para>
|
---|
| 102 | </sect2>
|
---|
| 103 |
|
---|
| 104 | <sect2 role="installation">
|
---|
| 105 | <title>Installation of Unbound</title>
|
---|
| 106 |
|
---|
| 107 | <para>
|
---|
| 108 | There should be a dedicated user and group to take control of the
|
---|
| 109 | <command>unbound</command> daemon after it is started. Issue the following
|
---|
| 110 | commands as the <systemitem class="username">root</systemitem> user:
|
---|
| 111 | </para>
|
---|
| 112 |
|
---|
| 113 | <screen role="root"><userinput>groupadd -g 88 unbound &&
|
---|
| 114 | useradd -c "Unbound DNS resolver" -d /var/lib/unbound -u 88 \
|
---|
| 115 | -g unbound -s /bin/false unbound</userinput></screen>
|
---|
| 116 |
|
---|
| 117 | <para>
|
---|
| 118 | Install <application>Unbound</application> by running the following
|
---|
| 119 | commands:
|
---|
| 120 | </para>
|
---|
| 121 |
|
---|
[283bd88] | 122 | <screen><userinput>./configure --prefix=/usr \
|
---|
[d224244f] | 123 | --sysconfdir=/etc \
|
---|
[283bd88] | 124 | --disable-static \
|
---|
| 125 | --with-pidfile=/run/unbound.pid &&
|
---|
[d224244f] | 126 | make</userinput></screen>
|
---|
| 127 |
|
---|
| 128 | <para>
|
---|
[f3429309] | 129 | If you have <xref linkend="doxygen"/> package installed and want to build
|
---|
[d224244f] | 130 | html documentation, run the following command:
|
---|
| 131 | </para>
|
---|
| 132 |
|
---|
| 133 | <screen><userinput>make doc</userinput></screen>
|
---|
| 134 |
|
---|
| 135 | <para>To test the results, issue <command>make check</command>.</para>
|
---|
| 136 |
|
---|
| 137 | <para>
|
---|
| 138 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 139 | </para>
|
---|
| 140 |
|
---|
| 141 | <screen role="root"><userinput>make install &&
|
---|
[1b472ab] | 142 | mv -v /usr/sbin/unbound-host /usr/bin/</userinput></screen>
|
---|
[d224244f] | 143 |
|
---|
| 144 | <para>
|
---|
| 145 | If you built html documentation, install it by running the following
|
---|
| 146 | commands as the <systemitem class="username">root</systemitem> user:
|
---|
| 147 | </para>
|
---|
| 148 |
|
---|
| 149 | <screen role="root"><userinput>install -v -m755 -d /usr/share/doc/unbound-&unbound-version; &&
|
---|
| 150 | install -v -m644 doc/html/* /usr/share/doc/unbound-&unbound-version;</userinput></screen>
|
---|
| 151 |
|
---|
| 152 | </sect2>
|
---|
| 153 |
|
---|
| 154 | <sect2 role="commands">
|
---|
| 155 | <title>Command Explanations</title>
|
---|
| 156 |
|
---|
| 157 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 158 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 159 |
|
---|
| 160 | <para>
|
---|
| 161 | <option>--with-libevent</option>: This option enables libevent support
|
---|
| 162 | allowing use of large outgoing port ranges.
|
---|
| 163 | </para>
|
---|
| 164 |
|
---|
| 165 | <para>
|
---|
| 166 | <option>--with-pyunbound</option>: This option enables building of the Python
|
---|
| 167 | bindings.
|
---|
| 168 | </para>
|
---|
| 169 |
|
---|
| 170 | </sect2>
|
---|
| 171 |
|
---|
| 172 | <sect2 role="configuration">
|
---|
| 173 | <title>Configuring Unbound</title>
|
---|
| 174 |
|
---|
| 175 | <sect3 id="unbound-config">
|
---|
| 176 | <title>Config Files</title>
|
---|
| 177 |
|
---|
| 178 | <para><filename>/etc/unbound/unbound.conf</filename></para>
|
---|
| 179 |
|
---|
| 180 | <indexterm zone="unbound unbound-config">
|
---|
| 181 | <primary sortas="e-etc-unbound-unbound.conf">/etc/unbound/unbound.conf</primary>
|
---|
| 182 | </indexterm>
|
---|
| 183 |
|
---|
| 184 | </sect3>
|
---|
| 185 |
|
---|
| 186 | <sect3>
|
---|
| 187 | <title>Configuration Information</title>
|
---|
| 188 |
|
---|
| 189 | <para>
|
---|
| 190 | In the default configuration, <command>unbound</command> will bind to
|
---|
| 191 | localhost (127.0.0.1 IP address) and allow recursive queries only from
|
---|
| 192 | localhost clients. If you want to use <command>unbound</command> for
|
---|
| 193 | local DNS resolution, run the following command as the
|
---|
| 194 | <systemitem class="username">root</systemitem> user:
|
---|
| 195 | </para>
|
---|
| 196 |
|
---|
| 197 | <screen role="root"><userinput>echo "nameserver 127.0.0.1" > /etc/resolv.conf</userinput></screen>
|
---|
| 198 |
|
---|
| 199 | <para>
|
---|
| 200 | If you are using a DHCP client for connecting to a network,
|
---|
| 201 | <filename>/etc/resolv.conf</filename> gets overwritten with values
|
---|
[68a57ecd] | 202 | provided by DHCP server. You can override this, for example in <xref
|
---|
| 203 | linkend="dhcp"/>, by running the following command as the <systemitem
|
---|
| 204 | class="username">root</systemitem> user:
|
---|
[d224244f] | 205 | </para>
|
---|
| 206 |
|
---|
| 207 | <screen role="root"><userinput>sed -i '/request /i\supersede domain-name-servers 127.0.0.1;' \
|
---|
| 208 | /etc/dhcp/dhclient.conf</userinput></screen>
|
---|
| 209 |
|
---|
| 210 | <para>
|
---|
[68a57ecd] | 211 | For advanced configuration see
|
---|
| 212 | <filename>/etc/unbound/unbound.conf</filename> file and the
|
---|
| 213 | documentation.
|
---|
[d224244f] | 214 | </para>
|
---|
| 215 |
|
---|
[68a57ecd] | 216 | <para>
|
---|
| 217 | When <application>Unbound</application> is installed, some package
|
---|
| 218 | builds fail if the file <filename>/etc/unbound/root.key</filename> is
|
---|
| 219 | not found. This file is created by running the boot script (install
|
---|
| 220 | instructions below). Alternatively, it can be created by running the
|
---|
| 221 | following command as the <systemitem class="username">root</systemitem>
|
---|
| 222 | user:
|
---|
| 223 | </para>
|
---|
| 224 |
|
---|
| 225 | <screen role="root"><userinput>unbound-anchor</userinput></screen>
|
---|
| 226 |
|
---|
[d224244f] | 227 | </sect3>
|
---|
| 228 |
|
---|
| 229 | <sect3 id="unbound-init">
|
---|
[1258125] | 230 | <title><phrase revision="sysv">Boot Script</phrase>
|
---|
| 231 | <phrase revision="systemd">Systemd Unit</phrase></title>
|
---|
[d224244f] | 232 |
|
---|
| 233 | <para>If you want the <application>Unbound</application> server to
|
---|
| 234 | start automatically when the system is booted, install the
|
---|
[1258125] | 235 | <phrase revision="sysv"><filename>/etc/rc.d/init.d/unbound</filename>
|
---|
| 236 | init script</phrase>
|
---|
| 237 | <phrase revision="systemd"><filename>unbound.service</filename>
|
---|
| 238 | unit</phrase> included
|
---|
[3c7bd00] | 239 | in the <xref linkend="bootscripts" revision="sysv"/>
|
---|
| 240 | <xref linkend="systemd-units" revision="systemd"/> package.</para>
|
---|
[d224244f] | 241 |
|
---|
| 242 | <indexterm zone="unbound unbound-init">
|
---|
| 243 | <primary sortas="f-unbound">unbound</primary>
|
---|
| 244 | </indexterm>
|
---|
| 245 |
|
---|
| 246 | <screen role="root"><userinput>make install-unbound</userinput></screen>
|
---|
| 247 |
|
---|
| 248 | </sect3>
|
---|
| 249 |
|
---|
| 250 | </sect2>
|
---|
| 251 |
|
---|
| 252 | <sect2 role="content">
|
---|
| 253 | <title>Contents</title>
|
---|
| 254 |
|
---|
| 255 | <segmentedlist>
|
---|
| 256 | <segtitle>Installed Programs</segtitle>
|
---|
| 257 | <segtitle>Installed Library</segtitle>
|
---|
| 258 | <segtitle>Installed Directories</segtitle>
|
---|
| 259 |
|
---|
| 260 | <seglistitem>
|
---|
| 261 | <seg>
|
---|
| 262 | unbound, unbound-anchor, unbound-checkconf, unbound-control,
|
---|
[283bd88] | 263 | unbound-control-setup, and unbound-host
|
---|
[d224244f] | 264 | </seg>
|
---|
| 265 | <seg>
|
---|
[be4a407] | 266 | libunbound.so and (optional)
|
---|
[b6ff9d3f] | 267 | /usr/lib/python&python2-majorver;/site-packages/_unbound.so
|
---|
[d224244f] | 268 | </seg>
|
---|
| 269 | <seg>
|
---|
| 270 | /etc/unbound and /usr/share/doc/unbound-&unbound-version;
|
---|
| 271 | </seg>
|
---|
| 272 | </seglistitem>
|
---|
| 273 | </segmentedlist>
|
---|
| 274 |
|
---|
| 275 | <variablelist>
|
---|
| 276 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 277 | <?dbfo list-presentation="list"?>
|
---|
| 278 | <?dbhtml list-presentation="table"?>
|
---|
| 279 |
|
---|
| 280 | <varlistentry id="unbound-prog">
|
---|
| 281 | <term><command>unbound</command></term>
|
---|
| 282 | <listitem>
|
---|
| 283 | <para>
|
---|
| 284 | is a DNS resolver daemon.
|
---|
| 285 | </para>
|
---|
| 286 | <indexterm zone="unbound unbound-prog">
|
---|
| 287 | <primary sortas="b-unbound">unbound</primary>
|
---|
| 288 | </indexterm>
|
---|
| 289 | </listitem>
|
---|
| 290 | </varlistentry>
|
---|
| 291 |
|
---|
| 292 | <varlistentry id="unbound-anchor">
|
---|
| 293 | <term><command>unbound-anchor</command></term>
|
---|
| 294 | <listitem>
|
---|
| 295 | <para>
|
---|
| 296 | performs setup or update of the root trust anchor for DNSSEC
|
---|
| 297 | validation.
|
---|
| 298 | </para>
|
---|
| 299 | <indexterm zone="unbound unbound-anchor">
|
---|
| 300 | <primary sortas="b-unbound-anchor">unbound-anchor</primary>
|
---|
| 301 | </indexterm>
|
---|
| 302 | </listitem>
|
---|
| 303 | </varlistentry>
|
---|
| 304 |
|
---|
| 305 | <varlistentry id="unbound-checkconf">
|
---|
| 306 | <term><command>unbound-checkconf</command></term>
|
---|
| 307 | <listitem>
|
---|
| 308 | <para>
|
---|
| 309 | checks <command>unbound</command> configuration file for syntax
|
---|
| 310 | and other errors.
|
---|
| 311 | </para>
|
---|
| 312 | <indexterm zone="unbound unbound-checkconf">
|
---|
| 313 | <primary sortas="b-unbound-checkconf">unbound-checkconf</primary>
|
---|
| 314 | </indexterm>
|
---|
| 315 | </listitem>
|
---|
| 316 | </varlistentry>
|
---|
| 317 |
|
---|
| 318 | <varlistentry id="unbound-control">
|
---|
| 319 | <term><command>unbound-control</command></term>
|
---|
| 320 | <listitem>
|
---|
| 321 | <para>
|
---|
| 322 | performs remote administration on the <command>unbound</command> DNS
|
---|
| 323 | resolver.
|
---|
| 324 | </para>
|
---|
| 325 | <indexterm zone="unbound unbound-control">
|
---|
| 326 | <primary sortas="b-unbound-control">unbound-control</primary>
|
---|
| 327 | </indexterm>
|
---|
| 328 | </listitem>
|
---|
| 329 | </varlistentry>
|
---|
| 330 |
|
---|
| 331 | <varlistentry id="unbound-control-setup">
|
---|
| 332 | <term><command>unbound-control-setup</command></term>
|
---|
| 333 | <listitem>
|
---|
| 334 | <para>
|
---|
| 335 | generates self-signed certificate and private keys for the server
|
---|
| 336 | and client.
|
---|
| 337 | </para>
|
---|
| 338 | <indexterm zone="unbound unbound-control-setup">
|
---|
| 339 | <primary sortas="b-unbound-control-setup">unbound-control-setup</primary>
|
---|
| 340 | </indexterm>
|
---|
| 341 | </listitem>
|
---|
| 342 | </varlistentry>
|
---|
| 343 |
|
---|
| 344 | <varlistentry id="unbound-host">
|
---|
| 345 | <term><command>unbound-host</command></term>
|
---|
| 346 | <listitem>
|
---|
| 347 | <para>
|
---|
| 348 | is a DNS lookup utility similar to <command>host</command> from
|
---|
| 349 | <xref linkend="bind-utils"/>.
|
---|
| 350 | </para>
|
---|
| 351 | <indexterm zone="unbound unbound-host">
|
---|
| 352 | <primary sortas="b-unbound-host">unbound-host</primary>
|
---|
| 353 | </indexterm>
|
---|
| 354 | </listitem>
|
---|
| 355 | </varlistentry>
|
---|
| 356 |
|
---|
| 357 | <varlistentry id="libunbound">
|
---|
| 358 | <term><filename class="libraryfile">libunbound.so</filename></term>
|
---|
| 359 | <listitem>
|
---|
| 360 | <para>
|
---|
| 361 | provides the <application>Unbound</application> API functions to
|
---|
| 362 | programs.
|
---|
| 363 | </para>
|
---|
| 364 | <indexterm zone="unbound libunbound">
|
---|
| 365 | <primary sortas="c-libunbound">libunbound.so</primary>
|
---|
| 366 | </indexterm>
|
---|
| 367 | </listitem>
|
---|
| 368 | </varlistentry>
|
---|
| 369 |
|
---|
| 370 | </variablelist>
|
---|
| 371 |
|
---|
| 372 | </sect2>
|
---|
| 373 |
|
---|
| 374 | </sect1>
|
---|