.. -*- 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)            |                        |                                |
+----------------------------+------------------------+--------------------------------+
| python-setuptools          | Any                    |                                |
+----------------------------+------------------------+--------------------------------+


.. [#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 inotify              | Any      |                                |
+-------------------------------+----------+--------------------------------+
| python-gamin or pyinotify     | Any      | gamin or inotify, python       |
+-------------------------------+----------+--------------------------------+
| python-ssl (note              | Any      | python, backported ssl module  |
+-------------------------------+----------+--------------------------------+
| python-setuptools             | Any      |                                |
+-------------------------------+----------+--------------------------------+

Bcfg2 Reporting
---------------

A webserver capabable of running wsgi applications is required for web
reporting, such as Apache + mod_wsgi or nginx.

+-------------------------------+----------+--------------------------------+
| Software                      | Version  | Requires                       |
+===============================+==========+================================+
| django                        | 1.2.0+   |                                |
+-------------------------------+----------+--------------------------------+
| south                         | 0.7.5+   |                                |
+-------------------------------+----------+--------------------------------+