kea/doc/guide/quickstart.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY mdash  "&#x2014;" >
<!ENTITY % version SYSTEM "version.ent">
%version;
]>

  <chapter id="quickstart">
    <title>Quick Start</title>

    <para>
        This section describes the basic steps needed to get Kea up and running.
        For further details, full customizations, and troubleshooting, see the
        respective chapters in the Kea guide.
    </para>

    <section id="quick-start">
      <title>Quick Start Guide for DHCPv4 and DHCPv6 Services</title>

      <orderedlist>

        <listitem>
          <simpara>
            Install required run-time and build dependencies. See <xref
	    linkend="build-requirements"/> for details.
          </simpara>
        </listitem>

        <listitem>
          <para>
            Download Kea source tarball from <ulink url="https://www.isc.org/downloads/">ISC.org downloads page</ulink> or <ulink url="http://ftp.isc.org/isc/kea/">ISC ftp server</ulink>.
          </para>
        </listitem>

        <listitem>
          <para>
            Extract the tarball. For example:
            <screen>$ <userinput>tar xvzf kea-&__VERSION__;.tar.gz</userinput></screen>
          </para>
        </listitem>

        <listitem>
          <para>Go into the source directory and run the configure script:
            <screen>$ <userinput>cd kea-&__VERSION__;</userinput>
$ <userinput>./configure [your extra parameters]</userinput></screen>
          </para>
        </listitem>

        <listitem>
          <para>Build it:
            <screen>$ <userinput>make</userinput></screen>
          </para>
        </listitem>

        <listitem>
          <para>Install it (by default it will be placed in
          <filename>/usr/local/</filename>,
          so it is likely that you will need root privileges for this step):
            <screen># <userinput>make install</userinput></screen>
          </para>
        </listitem>

        <listitem>
          <para>Edit the Kea configuration files which by default are installed in
          the <filename>[kea-install-dir]/etc/kea/</filename> directory. These are:
          <filename>kea-dhcp4.conf</filename>, <filename>kea-dhcp6.conf</filename>,
          <filename>kea-dhcp-ddns.conf</filename> and
          <filename>kea-ctrl-agent.conf</filename>, for DHCPv4 server, DHCPv6 server,
          D2 and Control Agent respectively.
          </para>
        </listitem>

        <listitem>
          <para>In order to start the DHCPv4 server in background, run the
          following command (as root):
          <screen># <userinput>keactrl start -s dhcp4</userinput></screen>
          Or run the following command to start DHCPv6 server instead:
          <screen># <userinput>keactrl start -s dhcp6</userinput></screen>
          Note that it is also possible to start all servers simultaneously:
          <screen>$ <userinput>keactrl start</userinput></screen>
          </para>
        </listitem>

        <listitem>
          <para>Verify that Kea server(s) are running:
          <screen># <userinput>keactrl status</userinput></screen>
          A server status of "inactive" may indicate a configuration
          error. Please check the log file (by default named
          <filename>[kea-install-dir]/var/kea/kea-dhcp4.log</filename>,
          <filename>[kea-install-dir]/var/kea/kea-dhcp6.log</filename>,
          <filename>[kea-install-dir]/var/kea/kea-ddns.log</filename> or
          <filename>[kea-install-dir]/var/kea/kea-ctrl-agent.log</filename>) 
          for the details of the error.
          </para>
        </listitem>

        <listitem>
          <para>
            If the server has been started successfully, test that it is
            responding to DHCP queries and that the client
            receives a configuration from the server; for example, use
            the <ulink url="http://www.isc.org/downloads/DHCP/">ISC DHCP client</ulink>.
          </para>
        </listitem>

        <listitem>
          <para>
            Stop running the server(s):
            <screen># <userinput>keactrl stop</userinput></screen>
          </para>
        </listitem>
      </orderedlist>
      <para>
        For instructions specific to your system, please read the
        <ulink url="http://kea.isc.org/wiki/SystemSpecificNotes">system specific notes</ulink>,
        available on the <ulink url="http://kea.isc.org/">Kea web site</ulink>.
      </para>

      <para>The details of <command>keactrl</command> script usage can be found
      in <xref linkend="keactrl"/>.</para>
    </section>

    <section id="quick-start-direct-run">
      <title>Running the Kea Servers Directly</title>
      <para>The Kea servers can be started directly, without the need to use the
      <command>keactrl</command>. To start the DHCPv4 server run the following
      command:
      <screen># <userinput>kea-dhcp4 -c /path/to/your/kea4/config/file.json</userinput></screen>
      Similarly, to start the DHCPv6 server run the following command:
      <screen># <userinput>kea-dhcp6 -c /path/to/your/kea6/config/file.json</userinput></screen>
    </para>
    </section>

  </chapter>