Update installation guide

svn path=/rpkid/Doxyfile; revision=2833

1 files changed, 22 insertions, 3 deletions

diff --git a/rpkid/doc/Installation b/rpkid/doc/Installation
index 31ed3b70..a9aafeff 100644
--- a/rpkid/doc/Installation
+++ b/rpkid/doc/Installation
@@ -24,22 +24,34 @@ Installation Guide
    rpkid et al are mostly self-contained, but do require a small number of
    external packages to run.
 
+     * If your Python installation does not already include the sources
+       files needed to compile new Python extension modules, you will need
+       to install whatever package does include those source files. The
+       need for and name of this package varies from system to system. On
+       FreeBSD, the base Python interpreter package includes the
+       development sources; on at least some Linux distributions, you have
+       to install a separate "python-devel" package or something similar.
+       If you get compilation errors trying to build the POW code (below)
+       and the error message says something about the file "Python.h"
+       being missing, this is almost certainly your problem.
      * http://codespeak.net/lxml/. lxml in turn requires the Gnome LibXML2
        C libraries.
           + FreeBSD: /usr/ports/devel/py-lxml
           + Fedora: python-lxml.i386
+          + Ubuntu: python-lxml
      * http://sourceforge.net/projects/mysql-python/. MySQLdb in turn
        requires MySQL client and server. rpkid et al have been tested with
        MySQL 5.0 and 5.1.
           + FreeBSD: /usr/ports/databases/py-MySQLdb
           + Fedora: MySQL-python.i386
+          + Ubuntu: python-mysqldb
 
    rpkid et al also make heavy use of a modified copy of the Python
    OpenSSL Wrappers (POW) package, but this copy has enough modifications
    and additions that it's included in the subversion tree.
 
    The next step is to build the OpenSSL and POW binaries. At present the
-   OpenSSL code is just a copy of the stock OpenSSL 0.9.8g release,
+   OpenSSL code is just a snapshot of the OpenSSL development sources,
    compiled with special options to enable RFC 3779 support that ISC wrote
    under previous contract to ARIN. The POW (Python OpenSSL Wrapper)
    library is an extended copy of the stock POW release.
@@ -52,7 +64,8 @@ Installation Guide
 
    This should automatically build everything, in the right order,
    including staticly linking the POW extension module with the OpenSSL
-   library to provide RFC 3779 support.
+   library to provide RFC 3779 support. If you get errors building POW,
+   see the above discussion of Python development sources.
 
    You will also need a MySQL installation. This code was developed using
    MySQL 5.1 and has been tested with MySQL 5.0 and 5.1.
@@ -68,14 +81,17 @@ Installation Guide
      * http://pyyaml.org/. testpoke.py (an up-down protocol command line
        test client) and testbed.py (a test harness) use PyYAML.
           + FreeBSD: /usr/ports/devel/py-yaml
+          + Ubuntu: python-yaml
      * http://xmlsoft.org/XSLT/. Some of the test code uses xsltproc, from
        the Gnome LibXSLT package.
           + FreeBSD: /usr/ports/textproc/libxslt
+          + Ubuntu: xsltproc
      * http://w3m.sourceforge.net/. testbed.py uses w3m to display the
        summary output from rcynic. Nothing terrible will happen if w3m
        isn't available, testbed.py will just complain about it being
        missing and won't display rcynic's output.
           + FreeBSD: /usr/ports/www/w3m
+          + Ubuntu: w3m
 
    Some of the tests require MySQL databases to store their data. To set
    up all the databases that the tests will need, run the SQL commands in
@@ -100,10 +116,12 @@ Installation Guide
      * http://www.doxygen.org/. Doxygen in turn pulls in several other
        tools, notably Graphviz, pdfLaTeX, and Ghostscript.
           + FreeBSD: /usr/ports/devel/doxygen
+          + Ubuntu: doxygen
      * http://lynx.isc.org/current/. The documentation build process uses
        xsltproc and Lynx to dump flat text versions of a few critical
        documentation pages.
           + FreeBSD: /usr/ports/www/lynx
+          + Ubuntu: lynx
      * http://www.thaiopensource.com/relaxng/trang.html. Trang is used to
        convert RelaxNG schemas from the human-readable "compact" form to
        the XML form that LibXML2 understands. Trang in turn requires Java.
@@ -112,8 +130,9 @@ Installation Guide
        known as "SQL Fairy", includes code to parse an SQL schema and dump
        a description of it as Graphviz input. SQL Fairy in turn requires
        Perl.
+          + FreeBSD: /usr/ports/databases/p5-SQL-Translator
      __________________________________________________________________
 
 
-    Generated on Tue Jul 7 16:04:39 2009 for RPKI Engine by  doxygen
+    Generated on Fri Oct 23 00:02:29 2009 for RPKI Engine by  doxygen
     1.5.9