source: main/waeup.diazo/trunk/README.rst @ 17545

waeup.diazo
===========

Diazo support for waeup.kofa.

Diazo 'masquerades' running sites. In our case it gives nearly
unstyled Kofa sites a nice look, injects twitter bootstrap and more.

Prerequisites:

  You need git installed locally. Also libxslt-dev, libxml-dev, a C
  compiler like gcc, etc.  No Windows(tm) support.

In short:

1) Create a virtual environment (Python 2.6 or 2.7) and activate it::

    $ virtualenv sandbox27
    $ source sandbox27/bin/activate

2) Build diazo and all the stuff in here::

    (sandbox27)$ python bootstrap.py

   If you get an error message about::

     AttributeError: 'NoneType' object has no attribute 'location'

   then you have to install the Python `distribute` package. This is
   not a big thing, when operating in a virtual environment::

    (sandbox27)$ pip install --upgrade distribute

   Finally, fetch packages and configure everything by::

    (sandbox27)$ ./bin/buildout

   This also creates a runnable Grok instance in src/waeup.kofa.


3) Start some grok instance on port 8080 and create a kofa instance
   named `app`. You can use, for instance, the stuff in src/::

    (sandbox27)$ cd src/waeup.kofa
    (sandbox27)$ python bootstrap.py
    (sandbox27)$ ./bin/buildout
    (sandbox27)$ ./bin/kofactl start

   Now login on http://localhost:8080/ (grok/grok) and create an
   instance called `app`.

4) Start diazo::

    (sandbox27)$ cd ../../
    (sandbox27)$ ./bin/paster serve --reload kofaproxy.ini

  Watch the results on http://localhost:8000/.

The results shown can be modified in kofa/base.xml and
kofa/theme.html. Changes should be reflected immediately, if you
started the diazo paster process with the ``--reload`` option.

The machine whose output we want to filter is set in
`kofaproxy.ini`. In this file we also tell where twitter bootstrap and
static resources reside (and many more things).

To shutdown Diazo press CTRL-D, to stop Grok change to the
src/waeup.kofa dir and run::

  (sandbox27)$ ./bin/kofactl stop

Serving Content As-is
---------------------

The local `raw.ini` paster configuration sets up a Diazo server that
doesn't actually use Diazo::

    $ ./bin/paster serve raw.ini

This might make sense during migration of an existing site to Diazo.


Have fun.