[prev in list] [next in list] [prev in thread] [next in thread] 

List:       luci-commits
Subject:    [Luci-commits] [luci/pkg-update] README: partly rewritten, partly new content added
From:       jpokorny () fedoraproject ! org (Jan Pokorny)
Date:       2010-11-30 19:27:24
Message-ID: 20101130192724.174501202A9 () lists ! fedorahosted ! org
[Download RAW message or body]

commit 7637bfd3c51bfa45ce26159d4192af8a2f6123a7
Author: Jan Pokorny <jpokorny at redhat.com>
Date:   Tue Nov 30 20:26:29 2010 +0100

    README: partly rewritten, partly new content added

 README |   73 ++++++++++++++++++++++++++++++++++++++++++++++++++-------------
 1 files changed, 58 insertions(+), 15 deletions(-)
---
diff --git a/README b/README
index f7f080e..5823e0b 100644
--- a/README
+++ b/README
@@ -6,9 +6,11 @@
 on the TurboGears 2 framework.
 
 
+
 1. Installation and Setup
 =========================
 
+
 1.1 Using upstream code
 -----------------------
 
@@ -16,42 +18,73 @@ 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)::
+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 setup.py pkg_prepare --help``)
+
 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>
+       $ paste make-config luci /var/lib/luci/etc/luci.ini
 
 4. Create the database used by ``luci``::
 
-       $ paster setup-app <output configuration file>
+       $ paster setup-app /var/lib/luci/etc/luci.ini
+
+5. Start the ``paste`` http(s) server...::
+
+   a) ...using bundled initscript (recommended, but may require some tweaks)::
 
-5a. Start the paste http server directly::
+          $ service luci start
 
-       $ saslauthd -a pam
-       $ paster serve <output configuration file>
+      Note: Before the first run of this commands, its good to do following::
 
-5b. Start the paste server via initscript::
+          $ chkconfig --add luci
 
-       $ service luci start
+   b) ...directly (this should copy the initscript job, only its core shown)::
 
+          $ saslauthd -a pam
+          $ paster serve /var/lib/luci/etc/luci.ini
 
-Please note that these steps are currently rather simplified -- in fact
-the recipe is more complicated which waits to be explained in more detail.
+      Note: The former command should be replaced with equivalent (``MECH=pam``
+            is presumed in respective configuration) if applicable::
 
+          $ service start saslauthd
 
-1.2 Using package in your preferred GNU/Linux distribution
-----------------------------------------------------------
+
+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::
@@ -62,7 +95,16 @@ Using them, you can get latest ``luci`` package using::
 .. [#distros] on these distros, ``luci`` has an official status
 
 
-X. About/Contact
+
+1.3 Post-installation procedures
+--------------------------------
+
+Please refer to
+http://sources.redhat.com/cluster/wiki/Luci#Post-installation_procedures
+
+
+
+2. About/Contact
 ================
 
 :Authors/Contributors:
@@ -73,4 +115,5 @@ X. About/Contact
     Eve McGlynn
     Jeremy Perry
 
+
 :Homepage: http://sources.redhat.com/cluster/wiki/Luci

[prev in list] [next in list] [prev in thread] [next in thread]