kea-guide.xml 6.46 KB
Newer Older
1
<?xml version="1.0"?>
2
<!--
3
 - Copyright (C) 2014-2019 Internet Systems Consortium, Inc. ("ISC")
4
 -
5 6
 - 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
Suzanne Goldlust's avatar
Suzanne Goldlust committed
7
 - file, you can obtain one at http://mozilla.org/MPL/2.0/.
8 9
-->

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

16
<!-- Converted by db4-upgrade version 1.1 -->
17
<book xmlns="http://docbook.org/ns/docbook" version="5.0">
18
  <?xml-stylesheet href="kea-guide.css" type="text/css"?>
19

20
  <info>
21 22 23 24 25 26 27

    <title>
    <inlinemediaobject>
        <imageobject>
            <imagedata fileref="kea-logo-100x70.png" align="left"/>
        </imageobject>
    </inlinemediaobject>
28
    Kea Administrator Reference Manual
29 30
    </title>

31
    <releaseinfo>This is the reference guide for Kea version &keaversion;.</releaseinfo>
32 33

    <copyright>
34
      <year>2010-2018</year>
35
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
36 37
    </copyright>

38
    <abstract>
39

40
      <para>
41 42
        Kea is an open source implementation of the Dynamic Host Configuration
        Protocol (DHCP) servers, developed and maintained by Internet Systems
43
        Consortium (ISC).
44
      </para>
45

46
      <para>
47
        This is the reference guide for Kea version &keaversion;.
Suzanne Goldlust's avatar
Suzanne Goldlust committed
48
        Links to the most up-to-date version of this document (in PDF, HTML,
49
        and plain text formats), along with other documents for
Suzanne Goldlust's avatar
Suzanne Goldlust committed
50
        Kea, can be found in ISC's <uri xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://kb.isc.org/docs/kea-administrator-reference-manual">Knowledgebase</uri>.
51
        </para> </abstract>
52

53
  </info>
54

55
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="intro.xml"/>
56

57
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="quickstart.xml"/>
58

59
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="install.xml"/>
60

61
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="admin.xml"/>
62

63
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="config.xml"/>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
64

65
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="keactrl.xml"/>
66

67
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="agent.xml"/>
68

69
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="dhcp4-srv.xml"/>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
70

71
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="dhcp6-srv.xml"/>
72

73
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="lease-expiration.xml"/>
74

75 76
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="congestion-handling.xml"/>

77
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ddns.xml"/>
78

79
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="lfc.xml"/>
80

81
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="classify.xml"/>
82

83
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="hooks.xml"/>
84

85
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="stats.xml"/>
86

87
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ctrl-channel.xml"/>
88

89
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="logging.xml"/>
90

91
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="shell.xml"/>
92

Tomek Mrugalski's avatar
Tomek Mrugalski committed
93 94
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="netconf.xml"/>

95 96 97
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="api.xml"/>

  <appendix xml:id="acknowledgments">
98
      <title>Acknowledgments</title>
99

100 101
      <para>Kea is an open source project designed, developed, and maintained by Internet Systems
      Consortium, Inc, a 501(c)3 non-profit organization. ISC is primarily funded by revenues from
Suzanne Goldlust's avatar
Suzanne Goldlust committed
102
      support subscriptions for our open source, and we encourage all professional users to consider
103 104
      this option. To learn more, see ​<ulink
      url="https://www.isc.org/support/">https://www.isc.org/support/</ulink>.</para>
105

106 107
      <para>If you would like to contribute to ISC to assist us in continuing to make quality open
      source software, please visit our donations page at ​<ulink
Suzanne Goldlust's avatar
Suzanne Goldlust committed
108
      url="https://www.isc.org/donate/">https://www.isc.org/donate/</ulink>.</para>
109

110
      <para>We thank all the organizations and individuals who have helped to make Kea
111 112 113
      possible. <link xmlns:xlink="http://www.w3.org/1999/xlink"
      xlink:href="http://www.comcast.com/">Comcast</link>
       and the Comcast Innovation Fund provided major support for the development
Suzanne Goldlust's avatar
Suzanne Goldlust committed
114
      of Kea's DHCPv4, DHCPv6, and DDNS modules. Mozilla funded initial work on the REST API via a
115
      MOSS award.</para>
116

117
      <para>Kea was initially implemented as a collection of applications
Suzanne Goldlust's avatar
Suzanne Goldlust committed
118
      within the BIND 10 framework. We thank the founding sponsors of the BIND 10 project:
119 120
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.afilias.info/">Afilias</link>,
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.iis.se/">IIS.SE</link>,
121
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.nominet.org.uk/">Nominet</link>,
122 123 124 125
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.sidn.nl/">SIDN</link>,
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://jprs.co.jp/">JPRS</link>,
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://cira.ca/">CIRA</link>; and additional sponsors
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.afnic.fr/">AFNIC</link>,
126 127 128 129 130 131 132 133
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.cnnic.net.cn/">CNNIC</link>,
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.nic.cz/">CZ.NIC</link>,
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.denic.de/">DENIC eG</link>,
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.google.com/">Google</link>,
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.ripe.net/">RIPE NCC</link>,
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://registro.br/">Registro.br</link>,
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://nzrs.net.nz/">.nz Registry Services</link>, and
      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.tcinet.ru/">Technical Center of Internet</link>
134
      .</para>
135

136
    </appendix>
137

138 139 140
<!-- TODO: Add bibliography section (mostly RFCs, probably) -->


141 142 143 144 145
<!-- TODO: how to help: run unit tests, join lists, review trac tickets -->

  <!-- <index>    <title>Index</title> </index> -->

</book>