======================= Collagen INSTALL =========================


Dependencies:
 * common   - Python 2.5+
 * Matchbox - Django 1.x (with psycopg2 support)
            - Working PostgreSQL database
 * Tinderbox - running as root

Easiest way to install collagen is by using python setup.py script:

 # python setup.py install

This will install collagen python files, data and wrapper scrips.

Alternatively you can use ebuild file included with distribution.


  ==================== Configuring Matchbox ====================

First we need to setup database connection. This is done by setting
variables in configuration module for django (example file can be
found at /usr/share/doc/collagen-1.0/db_config.py). Now initialization
of db schema is in order. We use django tools to create it for us from
model description. For initialization do this:

 $ django-admin.py syncdb --settings=db_config --pythonpath=.
 $ django-admin.py loaddata /usr/share/collagen-1.0/initial_data.json \
                --settings=db_config --pythonpath=.

If the database schema exists and you need to fix it, drop the tables
beforehand, because django-admin.py will skip tables that exist
already.

All we need to do now is start the server (can be run as regular user)

 $ matchbox.py


  ==================== Configuring Tinderbox ====================

This is a little bit easier than Matchbox. We need to set path of
mktinderboxchroot.sh script and few other settings in tinderbox
configuration file (example can be found at
/usr/share/doc/collagen-1.0/tinderbox_config.py).

Other variables that need to be setup are:
MATCHBOX_HOST - ip or hostname of matchbox host
MATCHBOX_PORT - port where matchbox is listening
STAGE_TARBALL - tarball used to create basic chroot environment (which
                you can modify afterwards)

WORKDIR - work directory. Usually someplace where you have enough
          space to store another installation (I'd recommend at least
          6 GB, probably more)

CHROOT_LOGS - this is directory inside WORK_CHROOT where logging and
              similar files will be stored temporarily.

LOG_LEVEL - you can leave this to log.DEBUG until collagen is
            rock-solid :-)

Now we need to run tinderbox with tinderbox_config.py in current dir
(as root):

 # tinderbox.py