kea/doc/guide/quickstart.xml

<!--
 - Copyright (C) 2014-2019 Internet Systems Consortium, Inc. ("ISC")
 -
 - This Source Code Form is subject to the terms of the Mozilla Public
 - License, v. 2.0. If a copy of the MPL was not distributed with this
 - file, you can obtain one at http://mozilla.org/MPL/2.0/.
-->

<!-- need this include to make the &keaversion; macro work -->
<!DOCTYPE book [
<!ENTITY % keaversion SYSTEM "version.ent">
%keaversion;
]>

<!-- Converted by db4-upgrade version 1.1 -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
         xml: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 Administrator Reference Manual (ARM).
    </para>

    <section xml: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 the Kea source tarball from the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.isc.org/downloads/">ISC.org downloads page</link> or the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://ftp.isc.org/isc/kea/">ISC FTP server</link>.
          </para>
        </listitem>

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

        <listitem>
          <para>Go into the source directory and run the configure script:
            <screen>$ <userinput>cd kea-&keaversion;</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 the background, run the
          following command (as root):
          <screen># <userinput>keactrl start -s dhcp4</userinput></screen>
          Or run the following command to start the 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 the Kea server(s) is/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/log/kea-dhcp4.log</filename>,
          <filename>[kea-install-dir]/var/log/kea-dhcp6.log</filename>,
          <filename>[kea-install-dir]/var/log/kea-ddns.log</filename> or
          <filename>[kea-install-dir]/var/log/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 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.isc.org/downloads/DHCP/">ISC DHCP client</link>.
          </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
        <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://kb.isc.org/docs/installing-kea">system-specific notes</link>,
        available in the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://kb.isc.org/docs">Kea section of ISC's Knowledgebase</link>.
      </para>

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

    <section xml: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>