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://

Prerequisities for successful build/installation/deployment:

    * python (2.6, 2.7 should be also fine)
    * Cyrus SASL v2 libraries and header files
    * to use bundled initscript, check the additional requirements
      in the SPEC file (mostly common utilities that are found everywhere)

Any missing Python package might be installed with ``setuptools`` automatically
(and if even ``setuptools`` missing, ``ez_setup`` is there to handle it).

Following items describe the steps to get it running::

1. Go to the ``luci'' directory and edit ``pkg_prepare`` section in
   ``setup.cfg`` according to your needs (using ``vim``, for instance)::

       $ cd luci
       $ vim setup.cfg

   Note: Following steps use default values in ``setup.cfg`` so if you have
         changed anything there, you might have to modify commands accordingly.

   Note: It also possible to define all these options directly as command-line
         arguments prefixed with ``prepare_pkg'' which is on the whole appended
         to ``install`` command (see ``python pkg_prepare --help``)

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

       $ python install

3. Have the base configuration file generated from implicit template::

       $ paste make-config luci /var/lib/luci/etc/luci.ini

4. Similarly, create the database used by ``luci``::

       $ paster setup-app /var/lib/luci/etc/luci.ini

   Note: This step is fired automatically if you use initscript and database
         file is missing.

5. Start the ``paste`` http(s) server...::

   a) ...using bundled initscript (recommended, but may require some tweaks)::

          $ service luci start

      Note: Before the first run of this commands, its good to do following::

          $ chkconfig --add luci

   b) ...directly (this should copy the initscript job, only its core shown)::

          $ saslauthd -a pam
          $ paster serve /var/lib/luci/etc/luci.ini

      Note: The former command should be replaced with equivalent (``MECH=pam``
            is presumed in respective configuration) if applicable::

          $ service start saslauthd

Please note that these steps does not cover everything -- initscript and maybe
the SPEC file might give you a better idea.

1.2 Using package in your preferred 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

1.3 Post-installation procedures

Please refer to

2. About/Contact

    Ryan McCabe <>
    Chris Feist <>
    Jan Pokorný

    Eve McGlynn
    Jeremy Perry