]>

Some operating systems or software package vendors may provide ready-to-use, pre-built software packages for Kea. Installing a pre-built package means you do not need to install build-only prerequisites and do not need to make the software. FreeBSD ports, NetBSD pkgsrc, and Debian testing package collections provide all the prerequisite packages.

The following is the directory layout of the complete Kea installation (all directories paths are relative to the installation directory): etc/kea/ — configuration files. include/ — C++ development header files. lib/ — libraries. sbin/ — server software and commands used by the system administrator. share/kea/ — configuration specifications and examples. share/doc/kea/ — this guide, other supplementary documentation, and examples. share/man/ — manual pages (online documentation). var/kea/ — server identification, lease databases, and log files.

In addition to the run-time requirements (listed in ), building Kea from source code requires various development include headers and program development tools. Some operating systems have split their distribution packages into a run-time and a development package. You will need to install the development package versions, which include header files and libraries, to build Kea from the source code. Building from source code requires the following software installed on the system: Boost build-time headers (). At least Boost version 1.35 is required. Botan (at least version 1.8) or OpenSSL. log4cplus (at least version 1.0.3) development include headers. A C++ compiler and standard development headers. Kea builds have been tested with GCC g++ 3.4.3, 4.1.2, 4.1.3, 4.2.1, 4.3.2, and 4.4.1; Clang++ 2.8; and Sun C++ 5.10. The development tools "make". Visit the user-contributed wiki at for system-specific installation tips.

Kea is open source software written in C++. It is freely available in source code form from ISC as a downloadable tar file or via Kea Git code revision control service. (It may also be available in pre-compiled ready-to-use packages from operating system vendors.)

The Kea release tarballs may be downloaded from: (using FTP or HTTP).

Downloading this "bleeding edge" code is recommended only for developers or advanced users. Using development code in a production environment is not recommended. When building from source code retrieved via Git, additional software will be required: automake (v1.11 or later), libtoolize, and autoconf (2.59 or later). These may need to be installed. The latest development code (together with temporary experiments and un-reviewed code) is available via the Kea code revision control system. This is powered by Git and all the Kea development is public. The leading development is done in the master branch. The code can be checked out from git://git.kea.isc.org/kea: $ git clone git://git.kea.isc.org/kea The code checked out from the git repository doesn't include the generated configure script, Makefile.in files, nor their related build files. They can be created by running autoreconf with the --install switch. This will run autoconf, aclocal, libtoolize, autoheader, automake, and related commands.

Kea uses the GNU Build System to discover build environment details. To generate the makefiles using the defaults, simply run: $ ./configure Run ./configure with the --help switch to view the different options. Some commonly-used options are: --prefix Define the installation location (the default is /usr/local). --with-boost-include Define the path to find the Boost headers. --with-botan-config To specific the path to the botan-config script to build with Botan for the crypto code. --with-gtest Enable the building of the C++ Unit Tests using the Google Test framework. Optionally this can define the path to the gtest header files and library. (If the framework is not already installed on your system, it can be downloaded from .) --with-log4cplus Define the path to find the Log4cplus headers and libraries. --with-openssl Replace Botan by OpenSSL for the crypto library. The default is to try to find a working Botan then OpenSSL only if Botan is not found. --without-werror Disable the default use of the -Werror compiler flag so that compiler warnings do not result in build failures. For additional instructions concerning the building and installation of Kea for various databases, see . For additional instructions concerning the configuration backends, see . For example, the following command configures Kea to find the Boost headers in /usr/pkg/include, specifies that PostgreSQL support should be enabled, and sets the installation location to /opt/kea: $ ./configure \ --with-boost-include=/usr/pkg/include \ --with-dhcp-pgsql=/usr/local/bin/pg_config \ --prefix=/opt/kea If the configure fails, it may be due to missing or old dependencies.

After the configure step is complete, build the executables from the C++ code and prepare the Python scripts by running the command: $ make

To install the Kea executables, support files, and documentation, issue the command: $ make install Do not use any form of parallel or job server options (such as GNU make's -j option) when performing this step: doing so may cause errors. The install step may require superuser privileges. If required, run ldconfig as root with /usr/local/lib (or with ${prefix}/lib if configured with --prefix) in /etc/ld.so.conf (or the relevant linker cache configuration file for your OS): $ ldconfig If you do not run ldconfig where it is required, you may see errors like the following: program: error while loading shared libraries: libkea-something.so.1: cannot open shared object file: No such file or directory

Kea 0.9 introduces configuration backends that are switchable during the compilation phase. The backend is chosen using the --with-kea-config switch when running the configure script. It currently supports two values: BUNDY and JSON. JSON is the default. BUNDY BUNDY means that Kea is linked with the Bundy configuration backend that connects to the Bundy framework and in general works exactly the same as Kea 0.8 and earlier BIND10 versions. The benefits of that backend are uniform integration with the Bundy framework, easy on-line reconfiguration using bindctl, available RESTful API. On the other hand, it requires the whole heavy Bundy framework that requires Python3 to be present. That backend is likely to go away with the release of Kea 1.0. JSON JSON is the new default configuration backend that causes Kea to read JSON configuration files from disk. It does not require any framework and thus is considered more lightweight. It will allow dynamic on-line reconfiguration, but will lack remote capabilities (i.e. no RESTful API).

Kea stores its leases in a lease database. The software has been written in a way that makes it possible to choose which database product should be used to store the lease information. At present, Kea supports three database backends: MySQL, PostgreSQL and Memfile. To limit external dependencies, both MySQL and PostgreSQL support are disabled by default and only Memfile is available. Support for the optional external database backend must be explicitly included when Kea is built. This section covers the building of Kea with MySQL and/or PostgreSQL and the creation of the lease database.

Install MySQL according to the instructions for your system. The client development libraries must be installed. Build and install Kea as described in , with the following modification. To enable the MySQL database code, at the "configure" step (see ), do: ./configure [other-options] --with-dhcp-mysql Or specify the location of the MySQL configuration program "mysql_config" if MySQL was not installed in the default location: ./configure [other-options] --with-dhcp-mysql=path-to-mysql_config

The next task is to create both the lease database and the user under which the servers will access it. A number of steps are required: 1. Log into MySQL as "root": $ mysql -u root -p Enter password: : mysql> 2. Create the database: mysql> CREATE DATABASE database-name; (database-name is the name you have chosen for the database.) 3. Create the database tables by running the dhcpdb_create.mysql script supplied as part of Kea: mysql> CONNECT database-name; mysql> SOURCE path-to-kea/share/kea/dhcpdb_create.mysql 4. Create the user under which Kea will access the database (and give it a password), then grant it access to the database tables: mysql> CREATE USER 'user-name'@'localhost' IDENTIFIED BY 'password'; mysql> GRANT ALL ON database-name.* TO 'user-name'@'localhost'; 5. Exit MySQL: mysql> quit Bye $

Install PostgreSQL according to the instructions for your system. The client development libraries must be installed. Client development libraries are often packaged as "libpq". Build and install Kea as described in , with the following modification. To enable the PostgreSQL database code, at the "configure" step (see ), do: ./configure [other-options] --with-dhcp-pgsql Or specify the location of the PostgreSQL configuration program "pg_config" if PostgreSQL was not installed in the default location: ./configure [other-options] --with-dhcp-pgsql=path-to-pg_config

The next task is to create both the lease database and the user under which the servers will access it. A number of steps are required: 1. Log into PostgreSQL as "root": $ sudo -u postgres psql postgres Enter password: : postgres=# 2. Create the database: postgres=# CREATE DATABASE database-name; CREATE DATABASE postgres=# (database-name is the name you have chosen for the database.) 3. Create the user under which Kea will access the database (and give it a password), then grant it access to the database: postgres=# CREATE USER user-name WITH PASSWORD 'password'; CREATE ROLE postgres=# postgres=# GRANT ALL PRIVILEGES ON DATABASE database-name TO user-name; GRANT postgres=# 4. Exit PostgreSQL: postgres=# \q Bye $ 5. Create the database tables using the new user's credentials and the dhcpdb_create.pgsql script supplied with Kea. After entering the following command, you will be prompted for the new user's password. When the command completes you will be returned to the shell prompt. You should see output similar to following: $ psql -d database-name -U user-name -f path-to-kea/share/kea/dhcpdb_create.pgsql Password for user user-name: CREATE TABLE CREATE INDEX CREATE INDEX CREATE TABLE CREATE INDEX CREATE TABLE START TRANSACTION INSERT 0 1 INSERT 0 1 INSERT 0 1 COMMIT CREATE TABLE START TRANSACTION INSERT 0 1 COMMIT $ If instead you encounter an error like: psql: FATAL: no pg_hba.conf entry for host "[local]", user "user-name", database "database-name", SSL off ... you will need to alter the PostgreSQL configuration. Kea uses password authentication when connecting to the database and must have the appropriate entries added to PostgreSQL's pg_hba.conf file. This file is normally located in the primary data directory for your PostgreSQL server. The precise path may vary but the default location for PostgreSQL 9.3 on Centos 6.5 is: /var/lib/pgsql/9.3/data/pg_hba.conf. Assuming Kea is running on the same host as PostgreSQL, adding lines similar to following should be sufficient to provide password-authenticated access to Kea's database: local database-name user-name password host database-name user-name 127.0.0.1/32 password host database-name user-name ::1/128 password Please consult your PostgreSQL user manual before making these changes as they may expose your other databases that you run on the same system.