================================
 Petunial_ Documentation
================================

.. _Petunial: http://www.petunial.com/

--------------------------------
Installation
--------------------------------

:Contact: team@petunial.com
:date: $Date: 2007-02-03 22:52:58 +0100 (Sat, 03 Feb 2007) $
:status: This is a "work in progress"
:revision: $Revision: 1014 $
:copyright: BSD License

:Dedication:

    For Administrators of Petunial.

:abstract:

    This document is a describes how to install
    Petunial.

.. contents:: Table of Contents
.. section-numbering::

Requirements
============

System
------
The following system services are required to run petunial:

 * Python =2.4 - Core Language [http://www.python.org/]
 * CherryPy =2.2.x - Framework [http://www.cherrypy.org/]
 * Cheetah >0.9.18 - Template System [http://www.cheetahtemplate.org/]
 * pyOpenSSL >0.5.1 - OpenSSL Interface [http://www.sourceforge.net/projects/pyopenssl/]
 
Database-Backend
----------------
Administrator can decide which database-backend should be used by petunial:

 * MySQL: MySQL-python >1.2.0 [http://www.sourceforge.net/projects/mysql-python/]

   **or**
   
 * PostgreSQL: psycopg2 >2.0.2 [http://www.initd.org/projects/psycopg2/]

   **or**

 * SQLite: pysqlite2 >2.2.2 [http://www.pysqlite.org/]

   **or**

 * OpenLDAP: python-ldap >2.0.10 [http://python-ldap.sourceforge.net]

Servers 
-------

Petunial supports various servers via plugin system. 
 
Source Install
==============

Installation via python distutils::

    # python setup.py install

Debian
------

*All this must be done as root*

- Install working debian package versions using apt-get::

    # apt-get install python2.4 python2.4-dev sqlite3 libsqlite3-dev python-pyopenssl subversion bind9

- Download Cheetah and unpack::

    # wget http://mesh.dl.sourceforge.net/sourceforge/cheetahtemplate/Cheetah-1.0.tar.gz
    # tar xzvf Cheetah-1.0.tar.gz

- Download PySQLite and unpack::

    # wget http://initd.org/pub/software/pysqlite/releases/2.3/2.3.2/pysqlite-2.3.2.tar.gz
    # tar xzvf pysqlite-2.3.2.tar.gz

- Download CherryPy and unpack::

    # wget http://download.cherrypy.org/cherrypy/3.0RC1/CherryPy-3.0.0RC1.tar.gz
    # tar xzvf CherryPy-3.0.0RC1.tar.gz

- Change to each unpacked sub-folder an install them with the following command::

    # python setup.py install

- Checking out the source code of petunial::

    # svn co http://www.petunial.de/svn/petunial/

Packages
========
Petunial is available as package on various operating systems. 

Debian
------

Via aptidtude::
    
    # apt-get install ...

OpenBSD
-------

Via OpenBSD packages::

    # pkg_add ...

From OpenBSD ports-tree::

    # cd /usr/ports/sysutils/petunial/
    # make install clean

Windows
-------

Just run ``setup.exe`` to install petunial.

Web based installation
======================

Petunial comes with a webbased installer for configuration.
The install will run on localhost on port 10111 by default.

- Change to the checked-out sources as a normal system user::

    # cd petunial/trunk/

- Run the installer with the following command-line::

    # python petuniald -i

- Open ``http://localhost:10111/`` with a web browser
- Follow the installation steps

Starting the GUI
================
- Change to the checked-out sources as a normal system user::

    # cd petunial/trunk/

- Run the GUI with the following command-line::

    # python petuniald -g

- Open ``http://localhost:10111/`` with a web browser and login as admin

Starting the engine
===================

- Change to the checked-out sources as root::

    # cd petunial/trunk/source

- Run the engine with the following command-line::

    # python petuniald -e

- Then you will get the following error message due to missing certs::

    petunial.database.error.QueryError: sql execute error (no such table: _Petunial_ConfigurationGui) - query: SELECT "value" FROM "_Petunial_ConfigurationGui"  WHERE "name"=? ['host']

- Copy the certs directory to ``/etc/petunial``::

    # cp -R certs/ /etc/petunial/

- Run the engine again with the following command-line::

    # python petuniald -e