summaryrefslogtreecommitdiffstats
path: root/doc/installation/prerequisites.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/installation/prerequisites.txt')
-rw-r--r--doc/installation/prerequisites.txt58
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/installation/prerequisites.txt b/doc/installation/prerequisites.txt
new file mode 100644
index 000000000..758ee4a21
--- /dev/null
+++ b/doc/installation/prerequisites.txt
@@ -0,0 +1,58 @@
+.. -*- mode: rst -*-
+
+.. _prerequisites:
+
+Prerequisites
+=============
+
+Bcfg2 has several server side prerequisites and a minimal set of
+client side requirements. This page describes the prerequisite
+software situation on all supported platforms. The table describes
+what software is needed on the client and server side.
+
+
+Bcfg2 Client
+------------
+
++----------------------------+---------------+--------------------------------+
+| Software | Version | Requires |
++============================+===============+================================+
+| libxml2 (if lxml is used) | Any | |
++----------------------------+---------------+--------------------------------+
+| libxslt (if lxml is used) | Any | libxml2 |
++----------------------------+---------------+--------------------------------+
+| python | >= 2.3 [#f1]_ | |
++----------------------------+---------------+--------------------------------+
+| lxml or elementtree [#f2]_ | Any | lxml: libxml2, libxslt, python |
++----------------------------+---------------+--------------------------------+
+| python-apt [#f3]_ | Any | python |
++----------------------------+---------------+--------------------------------+
+| debsums (if APT tool | Any | |
+| driver is used) | | |
++----------------------------+---------------+--------------------------------+
+
+
+.. [#f1] python 2.5 works with elementtree.
+.. [#f2] elementtree is included in python 2.5 and later.
+.. [#f3] python-apt is only required on platforms that use apt, such as Debian and Ubuntu.
+
+Bcfg2 Server
+------------
+
++----------------------------+----------+--------------------------------+
+| Software | Version | Requires |
++============================+==========+================================+
+| libxml2 | 2.6.24+ | |
++----------------------------+----------+--------------------------------+
+| libxslt | Any | libxml2 |
++----------------------------+----------+--------------------------------+
+| python | 2.2-2.5 | |
++----------------------------+----------+--------------------------------+
+| lxml | 0.9+ | lxml: libxml2, libxslt, python |
++----------------------------+----------+--------------------------------+
+| gamin or fam | Any | |
++----------------------------+----------+--------------------------------+
+| python-gamin or python-fam | Any | gamin or fam, python |
++----------------------------+----------+--------------------------------+
+| M2crypto | Any | python, openssl |
++----------------------------+----------+--------------------------------+