Parcourir la source

[4502] Updated User's Guide.

Updated:
- Supported OSes
- Packages required at runtime to run Kea,
- Packages required to build Kea
Marcin Siodelski il y a 8 ans
Parent
commit
89a2408cdf
2 fichiers modifiés avec 57 ajouts et 22 suppressions
  1. 44 9
      doc/guide/install.xml
  2. 13 13
      doc/guide/intro.xml

+ 44 - 9
doc/guide/install.xml

@@ -106,9 +106,7 @@
             <listitem>
             <listitem>
                 <para>Boost build-time headers
                 <para>Boost build-time headers
           (<ulink url="http://www.boost.org/"/>).
           (<ulink url="http://www.boost.org/"/>).
-          At least Boost version 1.35 is required.
-  <!-- TODO: we don't check for this version -->
-  <!-- NOTE: jreed has tested with 1.34, 1.38, and 1.41. -->
+          At least Boost version 1.41 is required.
           When header-only Boost error code is not available or wanted, the
           When header-only Boost error code is not available or wanted, the
           Boost system library is required too.
           Boost system library is required too.
         </para>
         </para>
@@ -116,7 +114,7 @@
 
 
             <listitem>
             <listitem>
         <para>
         <para>
-          Botan (at least version 1.8) or OpenSSL.</para>
+          Botan (version 1.8, 1.9 or 1.10) or OpenSSL (versions 1.0.*).</para>
           </listitem>
           </listitem>
 
 
           <listitem>
           <listitem>
@@ -134,20 +132,57 @@ Debian and Ubuntu:
 
 
         <listitem>
         <listitem>
         <para>
         <para>
-          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.
+          A C++ compiler and standard development headers.
+          Kea 1.1.0 builds have been tested with GCC g++ 4.2.1,
+          4.4.7, 4.6.3, 4.8.3, 4.8.4, 4.8.5, 5.4.0; Clang++ 3.4.1;
+          and Apple Clang++ 703.0.31.
 	  <!-- @todo update this list -->
 	  <!-- @todo update this list -->
         </para>
         </para>
         </listitem>
         </listitem>
 
 
         <listitem>
         <listitem>
         <para>
         <para>
-          The development tools "make".
+          The development tools: automake, libtool, pkg-config.
         </para>
         </para>
         </listitem>
         </listitem>
 
 
+        <listitem>
+        <para>
+          MySQL client development libraries, when using --with-dhcp-mysql
+          configuration flag to build the Kea MySQL database backend.
+          In this case an instance of the MySQL server running
+          locally or on some other machine, reachable over the network
+          from the machine running Kea, is required. Though, running
+          unit tests requires that the MySQL server is local.
+        </para>
+        </listitem>
+
+        <listitem>
+        <para>
+          PostgreSQL client development libraries, when using
+          --with-dhcp-pgsql configuration flag to build the Kea PostgreSQL
+          database backend. In this case an instance of the PostgreSQL
+          server running locally or on some other machine, reachable over
+          the network from the machine running Kea, is required. Though,
+          running unit tests requires that the PostgreSQL server is
+          local.
+        </para>
+        </listitem>
+
+        <listitem>
+        <para>
+          googletest (version 1.6 or later), when using --with-gtest configuration option.
+        </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            Documentation generating tools: elinks, docbook-xsl, libxslt and Doxygen,
+            when generating documentation using --enable-generate-docs configuration
+            option.
+          </para>
+        </listitem>
+
         </itemizedlist>
         </itemizedlist>
 
 
         <para>
         <para>

+ 13 - 13
doc/guide/intro.xml

@@ -29,13 +29,12 @@
       <title>Supported Platforms</title>
       <title>Supported Platforms</title>
       <para>
       <para>
         Kea is officially supported on Red Hat Enterprise Linux,
         Kea is officially supported on Red Hat Enterprise Linux,
-	CentOS, Fedora and FreeBSD systems. It is also likely to work on many
-	other platforms: builds have been tested on (in no particular order)
-        Debian GNU/Linux 6 and unstable, Ubuntu 9.10, NetBSD 5,
-        Solaris 10 and 11, FreeBSD 7 and 8, CentOS Linux 5.3,
-        MacOS 10.6 and 10.7, and OpenBSD 5.1. Non supported systems
-	(especially non-Linux) are likely to have issues with directly
-	connected DHCPv4 clients.
+	    CentOS, Fedora and FreeBSD systems. It is also likely to work on many
+	    other platforms: builds have been tested on (in no particular order)
+        Red Hat Enteprise Linux 6.4, Debian GNU/Linux 7, Ubuntu 12.04,
+        Ubuntu 14.04, Ubuntu 16.04, Fedora Linux 19, Fedora 20, Fedora 22,
+        CentOS Linux 7, NetBSD 6, FreeBSD 10.3, OpenBSD 5.7, OpenBSD 6.0,
+        OS X 10.10, OS X 10.11.
       </para>
       </para>
       <para>There are currently no plans to port Kea to Windows platforms.</para>
       <para>There are currently no plans to port Kea to Windows platforms.</para>
     </section>
     </section>
@@ -59,9 +58,10 @@
         Kea supports two crypto libraries: Botan and OpenSSL. Only one of them
         Kea supports two crypto libraries: Botan and OpenSSL. Only one of them
         is required to be installed during compilation. Kea uses the Botan
         is required to be installed during compilation. Kea uses the Botan
         crypto library for C++ (<ulink url="http://botan.randombit.net/"/>),
         crypto library for C++ (<ulink url="http://botan.randombit.net/"/>),
-        version 1.8 or later. As an alternative to Botan, Kea can use the
-        OpenSSL crypto library (<ulink url="http://www.openssl.org/"/>).
-        It requires a version with SHA-2 support.
+        version 1.8, 1.9 or 1.10. As an alternative to Botan, Kea can use the
+        OpenSSL crypto library (<ulink url="http://www.openssl.org/"/>),
+        version 1.0.*. Support for later versions of Botan and OpenSSL will
+        be added with later releases of Kea.
             </simpara>
             </simpara>
         </listitem>
         </listitem>
 
 
@@ -91,9 +91,9 @@
 
 
         <listitem>
         <listitem>
             <simpara>
             <simpara>
-	In order to store lease information in a CQL database, Kea requires CQL
-    headers and libraries. This is an optional dependency in that Kea can be
-    built without CQL support.
+	In order to store lease information in a Cassandra  database (CQL), Kea
+    requires Cassandra headers and libraries. This is an optional dependency
+    in that Kea can be built without Cassandra support.
             </simpara>
             </simpara>
         </listitem>
         </listitem>
       </itemizedlist>
       </itemizedlist>