.. -*- mode: rst -*-

.. _installation-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.4 and greater [#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 and later 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.7  |                                |
+-------------------------------+----------+--------------------------------+
| lxml                          | 0.9+     | lxml: libxml2, libxslt, python |
+-------------------------------+----------+--------------------------------+
| gamin or fam                  | Any      |                                |
+-------------------------------+----------+--------------------------------+
| python-gamin or python-fam    | Any      | gamin or fam, python           |
+-------------------------------+----------+--------------------------------+
| M2crypto or python-ssl (note  | Any      | python, openssl                |
| that the ssl module is        |          |                                |
| included in python versions   |          |                                |
| 2.6 and later                 |          |                                |
+-------------------------------+----------+--------------------------------+