Commit 545aaa19 authored by Michael Graff's avatar Michael Graff
Browse files

reorder sections; make all installation instructons including quickstart a...

reorder sections; make all installation instructons including quickstart a child of the installation chapter.  Put requirements and supported OS versions first in the installation section.  More work to be done

git-svn-id: svn://bind10.isc.org/svn/bind10/trunk@1528 e5f2f494-b856-4b98-b285-d166d9295462
parent e38c7518
......@@ -4,6 +4,8 @@
<!ENTITY mdash "&#x2014;" >
]>
<book>
<?xml-stylesheet href="userguide.css" type="text/css"?>
<bookinfo>
<title>BIND 10 User Guide</title>
<subtitle>Administrator Reference for BIND 10</subtitle>
......@@ -105,6 +107,9 @@
</para>
</section>
<section id="managing_once_running">
<title>Managing BIND 10</title>
<para>
Once BIND 10 is running, two commands are used to interact directly with
the system:
......@@ -121,9 +126,10 @@
tool to load standard master zone files
</simpara>
</listitem>
<!-- TODO usermgr -->
<!-- TODO usermgr -->
</itemizedlist>
</para>
</section>
<para>
The tools and modules are covered in full detail in this users guide.
......@@ -163,7 +169,76 @@ var/
</chapter>
<chapter id="quickstart">
<chapter id="installation">
<title>Installation</title>
<section>
<title>Required Software</title>
<para>
BIND 10 requires Python 3.1.
</para>
<para>
Building from source code requires the Boost
build-time headers. At least Boost version 1.34 is required.
<!-- TODO: we don't check for this version -->
<!-- NOTE: jreed has tested with 1.34, 1.38, and 1.41. -->
</para>
<para>
If the Boost System Library is detected at configure time,
BIND 10 will be built using an alternative method for
networking I/O using Boost ASIO support. This provides
asynchrony support; with ASIO the Authoritative DNS server
can handle other queries while the processing of a TCP
transaction stalls.
This dependency is not required unless you need
<!-- TODO: want --> this feature as TCP transport support is
provided using alternative code.
</para>
<note><para>
For the Y1 prototype release, the only supported data source
backend is SQLite3. The authoritative server requires
SQLite 3.3.9 or newer,
and the XFRin module requires the Python _sqlite3.so module.
</para></note>
<!-- TODO: this will change ... -->
<!-- TODO: list where to get these from -->
<note><para>
Some operating systems do not provide these dependencies
in their default installation nor standard packages
collections.
You may need to install them separately.
</para></note>
<para>
Building BIND 10 also requires a C++ compiler and
standard development headers.
BIND 10 builds have been tested with GCC g++ 3.4.3, 4.1.2,
4.2.1, 4.3.2, and 4.4.1.
</para>
</section>
<section>
<title>Supported Platforms</title>
<para>
BIND 10 builds have been tested on Debian GNU/Linux 5,
Ubuntu 9.10, NetBSD 5, Solaris 10, FreeBSD 7, and CentOS
Linux 5.3.
It has been tested on Sparc, i386, and amd64 hardware
platforms.
It is planned for BIND 10 to build, install and run on
Windows and standard Unix-type platforms.
</para>
</section>
<section id="quickstart">
<title>Quick start</title>
<para>
This quickly covers the standard steps for installing
......@@ -172,6 +247,14 @@ var/
details, see the respective chapters in the BIND 10 user guide.
</para>
<note>
<simpara>
The Y1 prototype of the b10-auth server listens on
0.0.0.0 (all interfaces) port 5300. (This is not the standard
domain service port.)
</simpara>
</note>
<itemizedlist>
<listitem>
......@@ -193,7 +276,7 @@ var/
<listitem>
<para>Go into the source and run configure:
<screen>$ <userinput>cd bind10-<replaceable>VERSION</replaceable></userinput>
$ <userinput>./configure</userinput></screen>
$ <userinput>./configure</userinput></screen>
</para>
</listitem>
......@@ -217,14 +300,9 @@ $ <userinput>./configure</userinput></screen>
<listitem>
<note><simpara>The Y1 prototype of the b10-auth server listens on
0.0.0.0 (all interfaces) port 5300. (This is not the standard
domain service port.)</simpara></note>
<para>Test it; for example:
<screen>$ <userinput>dig @127.0.0.1 -p 5300 -c CH -t TXT authors.bind</userinput></screen>
</para>
</listitem>
<listitem>
......@@ -240,9 +318,9 @@ $ <userinput>./configure</userinput></screen>
</itemizedlist>
</chapter>
</section>
<chapter id="install">
<section id="install">
<title>Installation from source</title>
<para>
BIND 10 is open source software written in C++ and Python.
......@@ -252,15 +330,15 @@ $ <userinput>./configure</userinput></screen>
packages from operating system vendors.
</para>
<sect1>
<section>
<title>Download Tar File</title>
<para>The BIND 10 development snapshots and releases
are available as tarball downloads.
</para>
<!-- TODO -->
</sect1>
<!-- TODO -->
</section>
<sect1>
<section>
<title>Retrieve from Subversion</title>
<para>
The latest development code, including temporary experiments
......@@ -284,7 +362,7 @@ $ <userinput>./configure</userinput></screen>
Most users will just use the source tar file.
</para>
<sect2>
<section>
<title>Generate configuration files</title>
<para>
When checking out the code from
......@@ -305,83 +383,17 @@ $ <userinput>./configure</userinput></screen>
version 1.11 or better is needed or use the
<option>--with-pythonpath</option> configure option described
below).
</para>
<note><para>
Some operating systems do not provide these in their
default installation nor standard packages collections.
You may need to install them separately.
</para></note>
</sect2>
</sect1>
<sect1>
<title>Required Software</title>
<para>
BIND 10 requires Python 3.1.
</para>
<para>
Building from the source tarball requires the Boost
build-time headers. At least Boost version 1.34 is required.
<!-- TODO: we don't check for this version -->
<!-- NOTE: jreed has tested with 1.34, 1.38, and 1.41. -->
</para>
<para>
If the Boost System Library is detected at configure time,
BIND 10 will be built using an alternative method for
networking I/O using Boost ASIO support. This provides
asynchrony support; with ASIO the Authoritative DNS server
can handle other queries while the processing of a TCP
transaction stalls.
This dependency is not required unless you need
<!-- TODO: want --> this feature as TCP transport support is
provided using alternative code.
</para>
<note><para>
For the Y1 prototype release, the only supported data source
backend is SQLite3. The authoritative server requires
SQLite 3.3.9 or newer,
and the XFRin module requires the Python _sqlite3.so module.
</para></note>
<!-- TODO: this will change ... -->
<!-- TODO: list where to get these from -->
<note><para>
Some operating systems do not provide these dependencies
in their default installation nor standard packages
collections.
You may need to install them separately.
</para></note>
<para>
Building BIND 10 also requires a C++ compiler and
standard development headers.
BIND 10 builds have been tested with GCC g++ 3.4.3, 4.1.2,
4.2.1, 4.3.2, and 4.4.1.
</para>
</sect1>
<sect1>
<title>Supported Platforms</title>
<para>
BIND 10 builds have been tested on Debian GNU/Linux 5,
Ubuntu 9.10, NetBSD 5, Solaris 10, FreeBSD 7, and CentOS
Linux 5.3.
It has been tested on Sparc, i386, and amd64 hardware
platforms.
</section>
</section>
It is planned for BIND 10 to build, install and run on
Windows and standard Unix-type platforms.
</para>
</sect1>
<sect1>
<section>
<title>Configure before the build</title>
<para>
BIND 10 uses the GNU Build System to discover build environment
......@@ -440,7 +452,7 @@ $ <userinput>./configure</userinput></screen>
</variablelist>
</para>
<!-- TODO: gtest, lcov -->
<!-- TODO: gtest, lcov -->
<para>
For example, the following configures it to build
......@@ -458,9 +470,9 @@ $ <userinput>./configure</userinput></screen>
dependencies.
</para>
</sect1>
</section>
<sect1>
<section>
<title>Build</title>
<para>
After the configure step is complete, to build the executables
......@@ -468,9 +480,9 @@ $ <userinput>./configure</userinput></screen>
<screen>$ <userinput>make</userinput></screen>
</para>
</sect1>
</section>
<sect1>
<section>
<title>Install</title>
<para>
To install the BIND 10 executables, support files,
......@@ -480,11 +492,11 @@ $ <userinput>./configure</userinput></screen>
<note><para>The install step may require superuser
privileges.</para></note>
</sect1>
</section>
<!-- TODO: tests -->
<!-- TODO: tests -->
<sect1>
<section>
<title>Install Hierarchy</title>
<para>
The following is the layout of the complete BIND 10 installation:
......@@ -496,7 +508,7 @@ $ <userinput>./configure</userinput></screen>
<listitem>
<simpara><filename>etc/bind10/</filename> &mdash; configuration files.
</simpara>
<!-- TODO: create the etc/bind10/ directory? -->
<!-- TODO: create the etc/bind10/ directory? -->
</listitem>
<listitem>
<simpara><filename>lib/</filename> &mdash; libraries and
......@@ -527,20 +539,21 @@ $ <userinput>./configure</userinput></screen>
<listitem>
<simpara><filename>var/bind10/</filename> &mdash; data source and
configuration databases.
<!-- TODO: move the sqlite3 database there -->
<!-- TODO: move the sqlite3 database there -->
</simpara>
</listitem>
</itemizedlist>
</para>
</sect1>
</section>
</section>
<!--
<sect1 id="install.troubleshooting">
<!--
<section id="install.troubleshooting">
<title>Troubleshooting</title>
<para>
</para>
</sect1>
-->
</section>
-->
</chapter>
......@@ -577,7 +590,7 @@ $ <userinput>./configure</userinput></screen>
(These are covered in upcoming chapters.)
</para>
<sect1 id="start">
<section id="start">
<title>Starting BIND 10</title>
<para>
To start the BIND 10 service, simply run <command>bind10</command>.
......@@ -585,7 +598,7 @@ $ <userinput>./configure</userinput></screen>
get additional debugging or diagnostic output.
</para>
<!-- TODO: note it doesn't go into background -->
</sect1>
</section>
</chapter>
......@@ -840,7 +853,7 @@ or accounts database -->
redefined by using the <option>--idle-timeout</option> command line argument.
</para>
<sect1 id="cmdctl.spec">
<section id="cmdctl.spec">
<title>Configuration specification for b10-cmdctl</title>
<para>
The configuration items for <command>b10-cmdctl</command> are:
......@@ -856,7 +869,7 @@ print_settings
shutdown
</para>
<!-- TODO -->
</sect1>
</section>
<!--
TODO
......@@ -919,7 +932,7 @@ TODO
port 5300.
</simpara></note>
<sect1>
<section>
<title>Server Configurations</title>
<!-- TODO: offers command line options but not used
......@@ -970,9 +983,9 @@ This may be a temporary setting until then.
<!-- TODO: examples of setting or running above? -->
</sect1>
</section>
<sect1>
<section>
<title>Data Source Backends</title>
<note><para>
......@@ -994,9 +1007,9 @@ This may be a temporary setting until then.
<quote>database_file</quote> configuration.
</para>
</sect1>
</section>
<sect1>
<section>
<title>Loading Master Zones Files</title>
<para>
......@@ -1064,15 +1077,15 @@ This may be a temporary setting until then.
<!--TODO: permissions for xfrin or loadzone to create the file -->
</sect1>
</section>
<!--
TODO
<sect1>
<section>
<title>Troubleshooting</title>
<para>
</para>
</sect1>
</section>
-->
</chapter>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment