README
==============================================================
 luci: Web-based high availability administration application
==============================================================

``luci`` is a web-based high availability administration application built
on the TurboGears 2 framework.


1. Installation and Setup
=========================

1.1 Using upstream code
-----------------------

You can get newest luci code using::

    $ git clone git://git.fedorahosted.org/luci.git

Following items describe the step to get it running::

1. Go to the ``luci'' directory and edit ``setup.cfg`` according to your
   needs (using ``vim`` as an example)::

       $ cd luci
       $ vim setup.cfg

2. Install ``luci`` using the ``setup.py`` script::

       $ python setup.py install

3. Prepare the base configuration file::

       $ paste make-config luci <output configuration file>

4. Create the database used by ``luci``::

       $ paster setup-app <output configuration file>

5a. Start the paste http server directly::

       $ saslauthd -a pam
       $ paster serve <output configuration file>

5b. Start the paste server via initscript::

       $ service luci start


Please note that these steps are currently rather simplified -- in fact
the recipe is more complicated which waits to be explained in more detail.


1.2 Using package in your preferred GNU/Linux distribution
----------------------------------------------------------

Currently, this project is recognized only in RHEL 6 and Fedora [#distros]_.
Using them, you can get latest ``luci`` package using::

    $ yum install luci


.. [#distros] on these distros, ``luci`` has an official status


X. About/Contact
================

:Authors/Contributors:
    Ryan McCabe <rmccabe@redhat.com>
    Chris Feist <cfeist@redhat.com>
    Jan Pokorný

    Eve McGlynn
    Jeremy Perry

:Homepage: http://sources.redhat.com/cluster/wiki/Luci