Menu
▾
▴
[Lxr-commits] CVS: html/prototype/1-0-InstallSteps 1-0-install.shtml, 1.2, 1.3 1-0-install1tools.shtml, 1.4, 1.5 1-0-install2LXR.shtml, 1.2, 1.3 1-0-install3config.shtml, 1.8, 1.9 1-0-install4genxref.shtml, 1.3, 1.4 1-0-install5server.shtml, 1.3, 1.4 1-0-installNavbar.shtml, 1.2, 1.3
|
From: Andre-Littoz <ajl...@us...> - 2014-01-18 09:54:21
|
Update of /cvsroot/lxr/html/prototype/1-0-InstallSteps In directory sfp-cvs-1.v30.ch3.sourceforge.com:/tmp/cvs-serv25121/prototype/1-0-InstallSteps Modified Files: 1-0-install.shtml 1-0-install1tools.shtml 1-0-install2LXR.shtml 1-0-install3config.shtml 1-0-install4genxref.shtml 1-0-install5server.shtml 1-0-installNavbar.shtml Log Message: Switching to HTML5: directory prototype/ for translation in any language Index: 1-0-install.shtml =================================================================== RCS file: /cvsroot/lxr/html/prototype/1-0-InstallSteps/1-0-install.shtml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- 1-0-install.shtml 27 Aug 2012 07:50:49 -0000 1.2 +++ 1-0-install.shtml 18 Jan 2014 09:54:17 -0000 1.3 @@ -1,125 +1,100 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> -<!-- $Id$ --> -<html> <!--#set var="pageLang" value="en" --> -<head> - <meta http-equiv="content-type" content="text/html; charset=UTF-8"> - <meta http-equiv="Content-Language" content="<!--#echo var="pageLang" -->"> - <title>LXR 1.0 Installation Overview</title> - <link rel="stylesheet" type="text/css" href="/backstore/LXRweb.css"> - <link rel="icon" type="image/x-icon" href="/backstore/LXRlogo2.ico"> - <meta name="keywords" - content="howto install LXR, how to install LXR, lxr install" - > - <meta name="description" - content="step by step guide to install LXR" - > -</head> - -<body> - <!--#set var="pageHeaderTitle" value="LXR 1.0+ Installation Instructions" --> - <!--#set var="homePageHeader" value="0" --> - <!--#include virtual="/backstore/header.shtml" --> -<table> - <tr> - <td class="navbar"> +<!--#set var="pageMetaTitle" value="LXR 1.0 Installation Overview" --> +<!--#set var="pageHeaderTitle" value="LXR 1.0+ Installation Instructions" --> +<!--#set var="homePageHeader" value="0" --> +<!--#include virtual="/backstore5/header.shtml" --> +<!-- $Id$ --> +<section> <!--#set var="installStep" value="0" --><!--#include virtual="1-0-installNavbar.shtml" --> - </td> - <td class="instr"> - <p class="comment"> -This page covers installation instructions for <strong>LXR 1.0+</strong>. - </p> - <p class="comment"> -For 0.11 version, -read these <a href="/<!--#echo var="langPrefix" -->0-11-InstallSteps/0-11-install.shtml">instructions</a>; -for 0.9.x and 0.10.x, -see <a href="/<!--#echo var="langPrefix" -->InstallSteps/install.shtml">here</a>. -For prior versions, -consult the <strong>INSTALL</strong> -document that ships with each release. - </p> + <section class="instr"> + <p class="comment"> +This page covers installation instructions for <strong>LXR 1.0</strong> and higher. + </p> + <p class="comment"> +For earlier releases, +select the appropriate case from the +<a href="/<!--#echo var="langPrefix" -->index.shtml">home page</a>. + </p> - <p class="normal"> + <p class="normal"> To successfully install your copy of LXR, go through the following steps: - </p> - <ol> - <li> - <a href="1-0-install1tools.shtml" title="Install tools" rev="index"> + </p> + <ol> + <li> + <a href="1-0-install1tools.shtml" title="Install tools" rev="index"> Install the running environment - </a> - <p class="normal"> + </a> + <p class="normal"> Check and/or install all the required tools needed to run LXR - </p> - </li> - <li> - <a href="1-0-install2LXR.shtml" title="Install LXR itself"> + </p> + </li> + <li> + <a href="1-0-install2LXR.shtml" title="Install LXR itself"> Install LXR source - </a> - <p class="normal"> + </a> + <p class="normal"> Instructions to unpack and install the tarball downloaded from the site - </p> - </li> - <li> - <a href="1-0-install3config.shtml" title="Pre-configure your copy"> + </p> + </li> + <li> + <a href="1-0-install3config.shtml" title="Pre-configure your copy"> Configure LXR and database - </a> - <p class="normal"> + </a> + <p class="normal"> Create the master configuration file from a template and a database to store the cross-references. - </p> - <div class="boxed"> - <p class="normal"> + </p> + <div class="boxed"> + <p class="normal"> <span class="caution">CAUTION!</span> Directory containing user-customized data changed its name from <em>lxrconf.d/</em> to <em>custom.d/</em> between previous releases and release 1.0. - </p> - </div> - </li> - <li> - <a href="1-0-install4genxref.shtml" title="Populate database"> + </p> + </div> + </li> + <li> + <a href="1-0-install4genxref.shtml" title="Populate database"> Populate the database - </a> - <p class="normal"> + </a> + <p class="normal"> Load it with the data about your tree - </p> - </li> - <li> - <a href="1-0-install5server.shtml" title="Configure web server"> - Configure your web server - </a> - </li> - </ol> + </p> + </li> + <li> + <a href="1-0-install5server.shtml" title="Configure web server"> +Configure your web server + </a> + </li> + </ol> - <p class="normal"> + <p class="normal"> Once you've got LXR working on this simple case, you might consider customising its operation for your personal taste. Read the following: - </p> - <ul> - <li> - <a href="http://sourceforge.net/projects/lxr/files/doc/" title="Download"> -LXR User's Manual</a> - <br> - <p class="comment"> + </p> + <ul> + <li> + <a href="http://sourceforge.net/projects/lxr/files/doc/" title="Download"> +<cite>LXR User's Manual</cite></a> + <br> + <p class="comment"> Covers in depth all topics (usage, configuration, customisation, …). - </p> - </li> - <li> - <a href="/<!--#echo var="langPrefix" -->advancedconfig.shtml" title="Advanced config"> - Advanced configuration - </a> - <br> - <p class="comment"> + </p> + </li> + <li> + <a href="/<!--#echo var="langPrefix" -->advancedconfig.shtml" title="Advanced config"> +Advanced configuration + </a> + <br> + <p class="comment"> Tune LXR (multiple trees, customisation, etc.) - </p> - </li> - </ul> - </td> - </tr> -</table> - -<!--#include virtual="/backstore/footer.shtml" --> + </p> + </li> + </ul> + </section> +</section> +<!--#include virtual="/backstore5/footer.shtml" --> Index: 1-0-install1tools.shtml =================================================================== RCS file: /cvsroot/lxr/html/prototype/1-0-InstallSteps/1-0-install1tools.shtml,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- 1-0-install1tools.shtml 23 Sep 2012 16:48:10 -0000 1.4 +++ 1-0-install1tools.shtml 18 Jan 2014 09:54:17 -0000 1.5 @@ -1,104 +1,89 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> -<!-- $Id$ --> -<html> <!--#set var="pageLang" value="en" --> +<!--#set var="pageMetaTitle" value="LXR 1.0 Tools Installation" --> <!--#set var="indxPage" value="1-0-install.shtml" --> <!--#set var="nextPage" value="1-0-install2LXR.shtml" --> -<head> - <meta http-equiv="content-type" content="text/html; charset=UTF-8"> - <meta http-equiv="Content-Language" content="<!--#echo var="pageLang" -->"> - <title>LXR 1.0 Tools Installation</title> - <link rel="stylesheet" type="text/css" href="/backstore/LXRweb.css"> - <link rel="icon" type="image/x-icon" href="/backstore/LXRlogo2.ico"> - <link rel="index" href="<!--#echo var='indxPage' -->"> - <link rel="next" href="<!--#echo var='nextPage' -->"> -</head> - -<body> - <!--#set var="pageHeaderTitle" value="Step 1: LXR Tools Installation" --> - <!--#set var="homePageHeader" value="0" --> - <!--#include virtual="/backstore/header.shtml" --> -<table> - <tr> - <td class="navbar"> +<!--#set var="pageHeaderTitle" value="Step 1: LXR Tools Installation" --> +<!--#set var="homePageHeader" value="0" --> +<!--#include virtual="/backstore5/header.shtml" --> +<!-- $Id$ --> +<section> <!--#set var="installStep" value="1" --><!--#include virtual="1-0-installNavbar.shtml" --> - </td> - <td class="instr"> - <p class="normal"> + <section class="instr"> + <p class="normal"> The current version of LXR depends on the software tools enumerated below. Instructions are given for Linux, but similar steps can be inferred for Windows or other OSes. - </p> - <p class="comment"> + </p> + <p class="comment"> In all cases, the preferred method of installation of these tools is a package download of your favourite distribution, so that you do not bother with compiling and configuring the tool, which may require expertise beyond the need of using LXR. - </p> - <p class="comment"> + </p> + <p class="comment"> If you really must compile and configure, refer to the appropriate documentation for installing each tool. There is usually a fairly automated procedure. - </p> - <ol> - <li>A <strong>Perl</strong> interpreter - <p class="normal"> + </p> + <ul> + <li>A <strong>Perl</strong> interpreter + <p class="normal"> Installed by default in nearly every distribution. - </p> - <p class="comment"> + </p> + <p class="comment"> Check it is version 5.10 or higher, because LXR relies on features introduced in this version. Type the following in a terminal: - </p> + </p> <pre class="shell"> <samp>$ </samp><kbd>perl -v</kbd> <samp>This is perl 5, version 14, subversion 2 (v5.14.2) built for …</samp> </pre> - <p class="comment"> + <p class="comment"> If you can't upgrade to 5.10 (released in December 2007, so this is not really bleeding edge), install LXR 0.11.1 which is the last compatible version, but new features will not be available. - </p> - </li> - <li>A recent version of the <strong>exuberant ctags</strong> program - <p class="normal"> + </p> + </li> + <li>A recent version of the <strong>exuberant ctags</strong> program + <p class="normal"> Usually installed from a package of your distribution. As a last resort, it is available from <a href="http://ctags.sourceforge.net" - title="ctags Web Site">SourceForge</a>. - </p> - <p class="comment"> +title="ctags Web Site">SourceForge</a>. + </p> + <p class="comment"> For "recent", read version 5 or higher. Type this in a terminal: - </p> + </p> <pre class="shell"> <samp>$ </samp><kbd>ctags --version</kbd> <samp>Exuberant Ctags 5.8, Copyright (C) 1996-2009 Darren Hiebert …</samp> </pre> - <p class="comment"> + <p class="comment"> You can launch automatically these two tests once you have installed LXR and before you start the configuration step. See <a href="1-0-install2LXR.shtml#install2autotest" title="Install LXR"> next page</a>. - </p> - </li> - <li>A relational database - <p class="normal"> + </p> + </li> + <li>A relational database + <p class="normal"> <a href="http://www.mysql.com" title="MySQL Web Site">MySQL</a> 4.x/5.x, <a href="http://www.oracle.com" title="Oracle Web Site">Oracle</a>, <a href="http://www.postgresql.org" title="Postgresql Web Site"> - Postgresql</a> +Postgresql</a> and <a href="http://www.sqlite.org" title="SQLite Web Site">SQLite</a> are supported. You will also need the right <strong>Perl DBI</strong> drivers for your particular database, usually available from CPAN (if not in your distribution). - </p> - </li> - <li>A webserver - <p class="normal"> + </p> + </li> + <li>A webserver + <p class="normal"> <a href="http://httpd.apache.org" title="Apache Web Site"> Apache httpd</a> with @@ -106,61 +91,63 @@ mod_perl</a> is recommended. <a href="http://www.lighttpd.net" title="lighttpd Web Site">lighttpd</a> is an alternate choice. +Starting with <em>LXR 2.0</em>, +<a href="http://cherokee-project.com" title="Cherokee Web Site">Cherokee</a>, +<a href="http://nginx.org" title="Nginx Web Site">Nginx</a> and +<a href="http://www.acme.com/software/thttpd" title="thttpd Web Site">thttpd</a> +may also be used. All may be installed from a package. - </p> - </li> - <li>For free-text searching, either - <a href="http://glimpse.cs.arizona.edu" title="Glimpse Web Site"> - Glimpse</a> - or - <a href="http://swish-e.org" title="Swish-e Web Site"> - Swish-e</a> - version 2.1 or later - <p class="comment"> + </p> + </li> + <li>For free-text searching, either +<a href="http://glimpse.cs.arizona.edu" title="Glimpse Web Site"> + Glimpse</a> +or +<a href="http://swish-e.org" title="Swish-e Web Site"> + Swish-e</a> +version 2.1 or later + <p class="comment"> Swish-e is fully GPL'ed while Glimpse is only free for non-commercial use. Thus you have little chance to find it among your distribution packages, but installing it is quite automated. - </p> - <div class="normal"> + </p> + <div class="normal"> How do you choose between them? - <ul> - <li class="classics"> - <strong>Glimpse</strong> gives you access to the - <strong>line</strong> of the occurrence and can distinguish - multiple occurrences within a file. - </li> - <li class="classics"> - <strong>Swish-e</strong> gives you access to the - <strong>file</strong> containing occurrences, - merging all occurrences into a single reference. - But it can index CVS repositories - (through file copy, which cancels the size advantage of a CVS repository). - </li> - </ul> - </div> - </li> - <li>The Perl database driver interface <strong>DBI</strong> - and the relevant <strong>DBD</strong> driver for the database - you are using - <p class="comment"> + <ul> + <li class="classics"> +<strong>Glimpse</strong> gives you access to the +<strong>line</strong> of the occurrence and can distinguish +multiple occurrences within a file. + </li> + <li class="classics"> +<strong>Swish-e</strong> gives you access to the +<strong>file</strong> containing occurrences, +merging all occurrences into a single reference. +But it can index CVS repositories +(through file copy, which cancels the size advantage of a CVS repository). + </li> + </ul> + </div> + </li> + <li>The Perl database driver interface <strong>DBI</strong> + and the relevant <strong>DBD</strong> driver for the database + you are using + <p class="comment"> If they are not already installed, you can get them from CPAN. More info <a href="http://dbi.perl.org/index.html" title="Perl DBI Info"> here</a>. - </p> - </li> - <li>The Perl <strong>File::MMagic</strong> module - <p class="comment"> + </p> + </li> + <li>The Perl <strong>File::MMagic</strong> module + <p class="comment"> First, try package <em>perl-file-mmagic</em>. If that fails, available from CPAN. - </p> - </li> - </ol> - </td> - </tr> -</table> - + </p> + </li> + </ul> + </section> +</section> <!--#include virtual="/${langPrefix}installNavBtn.shtml" --> - -<!--#include virtual="/backstore/footer.shtml" --> +<!--#include virtual="/backstore5/footer.shtml" --> Index: 1-0-install2LXR.shtml =================================================================== RCS file: /cvsroot/lxr/html/prototype/1-0-InstallSteps/1-0-install2LXR.shtml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- 1-0-install2LXR.shtml 14 Sep 2012 07:41:26 -0000 1.2 +++ 1-0-install2LXR.shtml 18 Jan 2014 09:54:17 -0000 1.3 @@ -1,108 +1,92 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> -<!-- $Id$ --> -<html> <!--#set var="pageLang" value="en" --> +<!--#set var="pageMetaTitle" value="LXR 1.0 Core Installation" --> <!--#set var="indxPage" value="1-0-install.shtml" --> <!--#set var="prevPage" value="1-0-install1tools.shtml" --> <!--#set var="nextPage" value="1-0-install3config.shtml" --> -<head> - <meta http-equiv="content-type" content="text/html; charset=UTF-8"> - <meta http-equiv="Content-Language" content="<!--#echo var="pageLang" -->"> - <title>LXR 1.0 Core Installation</title> - <link rel="stylesheet" type="text/css" href="/backstore/LXRweb.css"> - <link rel="icon" type="image/x-icon" href="/backstore/LXRlogo2.ico"> - <link rel="index" href="<!--#echo var='indxPage' -->"> - <link rel="prev" href="<!--#echo var='prevPage' -->"> - <link rel="next" href="<!--#echo var='nextPage' -->"> -</head> - -<body> - <!--#set var="pageHeaderTitle" value="Step 2: LXR Core Installation" --> - <!--#set var="homePageHeader" value="0" --> - <!--#include virtual="/backstore/header.shtml" --> -<table> - <tr> - <td class="navbar"> +<!--#set var="pageHeaderTitle" value="Step 2: LXR Core Installation" --> +<!--#set var="homePageHeader" value="0" --> +<!--#include virtual="/backstore5/header.shtml" --> +<!-- $Id$ --> +<section> <!--#set var="installStep" value="2" --><!--#include virtual="1-0-installNavbar.shtml" --> - </td> - <td class="instr"> - <p class="normal"> + <section class="instr"> + <p class="normal"> Download the <a href="http://sourceforge.net/projects/lxr/files/stable/">LXR tarball</a> if you haven't already done that. - </p> - <ol> - <li>Decide where you want LXR installed. - <ul> - <li> - <p class="comment"> + </p> + <ol> + <li>Decide where you want LXR installed. + <ul> + <li> + <p class="comment"> If you just want to see how LXR behaves against your user-private tree, you might as well install LXR in your home directory at <code>~/lxr/</code>. - </p> - </li> - <li> - <p class="comment"> + </p> + </li> + <li> + <p class="comment"> If you want to offer LXR service system-wide, you must install it in a public directory. In this guide, we will use <code>/usr/local/share/lxr/</code>. - </p> - <p class="normal caution"> + </p> + <p class="normal caution"> Access to this directory may require <em>root</em> privilege. - </p> - </li> - </ul> - <p class="normal"> + </p> + </li> + </ul> + <p class="normal"> This directory will be called <em class="defn">LXR root directory</em>. - </p> - </li> - <li>Expand the tarball - <p class="comment"> + </p> + </li> + <li>Expand the tarball + <p class="comment"> We will suppose the tarball has been downloaded in your <code>Download</code> directory: - </p> - <ul> - <li>Private installation: + </p> + <ul> + <li>Private installation: <pre class="shell"> <samp>$ </samp><kbd>cd</kbd> <samp>$ </samp><kbd>tar -zxf ~/Download/lxr-x.y.z.tgz</kbd> </pre> - </li> - <li>System-wide installation: + </li> + <li>System-wide installation: <pre class="shell"> <samp>$ </samp><kbd>cd /usr/local/share</kbd> <samp>$ </samp><kbd>tar -zxf ~/Download/lxr-x.y.z.tgz</kbd> </pre> - </li> - </ul> - </li> - <li>Enter the LXR root directory - <p class="comment"> + </li> + </ul> + </li> + <li>Enter the LXR root directory + <p class="comment"> You might want to rename this directory to get rid of the release version in its name. - </p> + </p> <pre class="shell"> <samp>$ </samp><kbd>mv lxr-x.y.z lxr</kbd> </pre> - <p class="comment"> + <p class="comment"> From the commands above, you are one level above the LXR directory. To enter: - </p> + </p> <pre class="shell"> <samp>$ </samp><kbd>cd lxr</kbd> </pre> - </li> - </ol> - <p class="normal" id="install2autotest"> + </li> + </ol> + <p class="normal" id="install2autotest"> The <a href="1-0-install1tools.shtml">tools installation page</a> mentioned version requirements for the auxiliary tools needed by LXR. Now that LXR has been copied, you can test them for <strong>Perl</strong> and <strong>ctags</strong> with: - </p> + </p> <pre class="shell"> <samp>$ </samp><kbd>./genxref --checkonly</kbd> <samp>ERROR: could not open configuration file lxr.conf @@ -120,30 +104,27 @@ swish-e not found, `command -v swish-e` returned a null string genxref stopped without indexing by --checkonly option</samp> </pre> - <ul> - <li class="comment"> + <ul> + <li class="comment"> Since LXR is not yet configured, you get various <em>Parameter </em>xxx<em> not defined</em> warnings. Ignore them. - </li> - <li class="comment"> + </li> + <li class="comment"> This command blindly checks the existence of both <strong>Glimpse</strong> and <strong>Swish-e</strong>. One of the tests should return a <em>not found</em> result. - </li> - <li class="comment"> + </li> + <li class="comment"> Read carefully the lines about the version levels and tool locations. - </li> - </ul> - <p class="normal"> + </li> + </ul> + <p class="normal"> You're done. You must now configure your copy. - </p> - </td> - </tr> -</table> - + </p> + </section> +</section> <!--#include virtual="/${langPrefix}installNavBtn.shtml" --> - -<!--#include virtual="/backstore/footer.shtml" --> +<!--#include virtual="/backstore5/footer.shtml" --> Index: 1-0-install3config.shtml =================================================================== RCS file: /cvsroot/lxr/html/prototype/1-0-InstallSteps/1-0-install3config.shtml,v retrieving revision 1.8 retrieving revision 1.9 diff -u -d -r1.8 -r1.9 --- 1-0-install3config.shtml 14 Mar 2013 18:21:54 -0000 1.8 +++ 1-0-install3config.shtml 18 Jan 2014 09:54:17 -0000 1.9 @@ -1,138 +1,120 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> -<!-- $Id$ --> -<html> <!--#set var="pageLang" value="en" --> +<!--#set var="pageMetaTitle" value="LXR 1.0 Configuration" --> <!--#set var="indxPage" value="1-0-install.shtml" --> <!--#set var="prevPage" value="1-0-install2LXR.shtml" --> <!--#set var="nextPage" value="1-0-install4genxref.shtml" --> -<head> - <meta http-equiv="content-type" content="text/html; charset=UTF-8"> - <meta http-equiv="Content-Language" content="<!--#echo var="pageLang" -->"> - <title>LXR 1.0 Configuration</title> - <link rel="stylesheet" type="text/css" href="/backstore/LXRweb.css"> - <link rel="icon" type="image/x-icon" href="/backstore/LXRlogo2.ico"> - <link rel="index" href="<!--#echo var='indxPage' -->"> - <link rel="prev" href="<!--#echo var='prevPage' -->"> - <link rel="next" href="<!--#echo var='nextPage' -->"> -</head> - -<body> - - <!--#set var="pageHeaderTitle" value="Step 3: LXR and Database Configuration" --> - <!--#set var="homePageHeader" value="0" --> - <!--#include virtual="/backstore/header.shtml" --> - -<table> - <tr> - <td class="navbar"> - <!--#set var="installStep" value="3" --> - <!--#include virtual="1-0-installNavbar.shtml" --> - </td> - <td class="instr"> - <p class="normal boxed"> +<!--#set var="pageHeaderTitle" value="Step 3: LXR and Database Configuration" --> +<!--#set var="homePageHeader" value="0" --> +<!--#include virtual="/backstore5/header.shtml" --> +<!-- $Id$ --> +<section> +<!--#set var="installStep" value="3" --><!--#include virtual="1-0-installNavbar.shtml" --> + <section class="instr"> + <p class="normal boxed"> Instructions below are given for a <span class="caution">simple project tree</span>. The <span class="caution">Linux kernel</span> is a complex case if you want to enable all the hyperlink possibilities. Refer to this <a href="../Tips/tipkernel.shtml" title="Configuring for Linux kernel">tip</a> once you have setup LXR at least on an easy case. - </p> - <p class="comment"> + </p> + <p class="comment"> The heart of LXR configuration is a file named <em>lxr.conf</em> which MUST be located in the <em>LXR root directory</em>. - </p> - <p class="comment"> + </p> + <p class="comment"> Script <em>configure-lxr.pl</em> builds a tailored copy from a template located in the <em>templates/</em> subdirectory and stores it in the <em>custom.d/</em> directory. - </p> - <ul> - <li>Create both LXR and database configurations with script - <code>configure-lxr.pl</code> + </p> + <ol> + <li>Create both LXR and database configurations with script + <code>configure-lxr.pl</code> <pre class="shell"> <samp>$ </samp><kbd>./scripts/configure-lxr.pl -vv</kbd> </pre> - <p class="comment"> + <p class="comment"> This launches the configuration script with default options, <em>i.e.</em> output of <em>lxr.conf</em> configuration file and <em>init-db.sh</em> database creation script into <em>custom.d/</em> directory based on template <em>lxr.conf</em>. - </p> + </p> <pre class="shell"> <samp>*** LXR configurator (version: 1.0) *** LXR root directory is /home/myself/lxr Configuration will be stored in custom.d/</samp> </pre> - <p class="normal"> + <p class="normal"> The configuration script builds a custom <em>lxr.conf</em> file from the answers to a few questions. Default answer (the one selected when you just hit "return") is shown in uppercase. You do not need to fully write the selected choice, type enough characters to make the answer unambiguous. - </p> - <ul class="version"> - <li>Release 1.1 and higher - <p class="comment"> + </p> + <ul class="version"> + <li>Release 1.1 and higher + <p class="comment"> Since configuring the web server is a bit tricky, the following questions are intended to ease this task. - </p> + </p> <pre class="shell"> <samp>Configure for single/multiple trees? [S/m] ></samp> </pre> - <p class="normal caution"> + <p class="normal caution"> Important! This is the only choice which cannot be changed later because it configures the web server in a non trivial way. - </p> - <p class="normal"> + </p> + <p class="normal"> Answer <code>S</code> if you'll serve only a single tree for ever (if you change your mind about it, you'll have to start over from scratch, erasing the existing database). This is a perfect choice for a first trial. - </p> - <p class="normal"> + </p> + <p class="normal"> Answer <code>M</code> if you intend to add another tree some time in an undefined future. - </p> + </p> <pre class="shell"> <samp>Do you intend to add other trees later? [yes/NO] ></samp> </pre> - <p class="comment"> + <p class="comment"> This question offers the possibility to correct a mistake. Let's assume the default <code>S</code> choice was correct. - </p> - <p class="normal"> + </p> + <p class="normal"> Correctly managing the target tree in the URL means coding the URL in a specific way. The LXR design is to have LXR service designated after the host name, then the desired tree. - </p> - <p class="normal"> + </p> + <p class="normal"> If the only pages offered on the server come from LXR, service name (usually <code>/lxr</code>) can be omitted. - </p> - <p class="comment"> + </p> + <p class="comment"> This corresponds to the case of a site dedicated to LXR only (cases 1 and 3 below). - </p> - <p class="normal"> + </p> + <p class="normal"> In single tree context, there is no need to designate this unique tree. - </p> - <p class="comment"> + </p> + <p class="comment"> This suppresses later the question about the virtual root. - </p> + </p> <pre class="shell"> <samp>*** LXR web server configuration *** -LXR can be configured as the default server (the only service in your computer), -a section of this default server or an independent server (with its own -host name). +LXR can be configured as the default server +(the only service in your computer), +a section of this default server +or an independent server (with its own host name). Refer to the User's Manual for a description of the differences. Web server type? [1.DEFAULT /2.section in default @@ -140,177 +122,178 @@ /4.section in indepedent ] > </samp><kbd>2</kbd> </pre> - <p class="normal"> + <p class="normal"> Choose <code>1</code> (default answer) for the simplest case or <code>2</code> in order not to overwrite an existing local server. - </p> + </p> <pre class="shell"> <samp>The computer hosting the server is described by an URL. The form is scheme://host_name:port where: - - scheme is either http or https (http: can be omitted), - - host_name can be given as an IP address such as 123.45.67.89 - or a domain name like localhost or lxr.url.example, - - port may be omitted if standard for the scheme. +- scheme is either http or https (http: can be omitted), +- host_name can be given as an IP address such as 123.45.67.89 + or a domain name like localhost or lxr.url.example, +- port may be omitted if standard for the scheme. The following question asks for a primary URL. Later, you'll have the opportunity to give aliases to this primary URL. --- Host name or IP? [//localhost] ></samp> </pre> - <p class="normal"> + <p class="normal"> The default local server is usually <code>//localhost</code>, so just hit return. - </p> + </p> <pre class="shell"> <samp>URL section name for LXR in your server? [/lxr] ></samp> </pre> - <p class="normal"> + <p class="normal"> This is the name under which LXR service will be accessed through the URL. - </p> - <p class="comment"> + </p> + <p class="comment"> <span class="attention">CAUTION!</span><br> If you answer <code>/</code>, you revert to cases 1 or 3 without warning. This may cause serious malfunction in your existing web server. - </p> - </li> - </ul> + </p> + </li> + </ul> <pre class="shell"> -<samp>The choice of the database engine can make a difference in indexing performance, -but resource consumption is also an important factor. - * For a small personal project, try SQLite which do not - need a server and is free from configuration burden. - * For medium to large projects, choice is between MySQL, - PostgreSQL and Oracle. - Oracle is not a free software, its interface has not been - tested for a long time. - * PostgreSQL databases are smaller than MySQL's - and performance is roughly equivalent. - * MySQL is at its best with marge-sized projects (such as kernel - cross-referencing) where it is fastest at the cost of bigger - databases. - * Take also in consideration the number of connected users.</samp> +<samp>The choice of the database engine can make a difference +in indexing performance, but resource consumption is also +an important factor. +* For a small personal project, try SQLite which do not +need a server and is free from configuration burden. +* For medium to large projects, choice is between MySQL, +PostgreSQL and Oracle. +Oracle is not a free software, its interface has not been +tested for a long time. +* PostgreSQL databases are smaller than MySQL's +and performance is roughly equivalent. +* MySQL is at its best with marge-sized projects (such as kernel +cross-referencing) where it is fastest at the cost of bigger +databases. +* Take also in consideration the number of connected users.</samp> <samp>Database engine? [MYSQL/oracle/postgres/sqlite] ></samp> </pre> - <p class="normal"> + <p class="normal"> Select the database engine according to your site policy or to its availability. - </p> - <ul class="version"> - <li>Release 1.0 + </p> + <ul class="version"> + <li>Release 1.0 <pre class="shell"> <samp>Configure for single/multiple trees? [S/m] ></samp> </pre> - <p class="normal caution"> + <p class="normal caution"> Important! This is the only choice which cannot be changed later because it configures the web server in a non trivial way. - </p> - <p class="normal"> + </p> + <p class="normal"> Answer <code>S</code> if you'll serve only a single tree for ever (if you change your mind about it, you'll have to start over from scratch, erasing the presently created database). This is a perfect choice for a first trial. - </p> - <p class="normal"> + </p> + <p class="normal"> Answer <code>M</code> if you intend to add another tree some time in an undefined future. - </p> + </p> <pre class="shell"> <samp>Do you intend to add other trees later? [yes/NO] ></samp> </pre> - <p class="comment"> + <p class="comment"> This question offers the possibility to correct a mistake. Let's assume the default <code>S</code> choice was correct. - </p> - </li> - </ul> + </p> + </li> + </ul> <pre class="shell"> <samp>--- Directory for glimpse databases? ></samp><kbd>/home/myself/glimpse_DB</kbd> </pre> - <p class="normal"> + <p class="normal"> The configuration script detected the installed search engine and requests a directory for its auxiliary files. This directory will be created later by LXR if it does not exist. - </p> - <p class="normal caution"> + </p> + <p class="normal caution"> CAUTION! If you provide this directory yourself, make sure it is <em>"world-readable"</em>. - </p> + </p> <pre class="shell"> <samp>templates directory templates/ now protected read-only</samp> </pre> - <ul class="version"> - <li>Release 1.1 and higher + <ul class="version"> + <li>Release 1.1 and higher <pre class="shell"> <samp>Is your Apache version 2.4 or higher? [YES/no] ></samp> </pre> - <p class="normal"> + <p class="normal"> Since access controls changed between Apache 2.2 and 2.4, it is necessary to know which version is used on your computer to configure adequately Apache-related control files. - </p> - <p class="comment"> + </p> + <p class="comment"> Any answer is valid if you do not use Apache. - </p> - </li> - </ul> + </p> + </li> + </ul> <pre class="shell"> <samp>file .htaccess written into LXR root directory file apache2-require.pl written into configuration directory file apache-lxrserver.conf written into configuration directory file lighttpd-lxrserver.conf written into configuration directory</samp> </pre> - <p class="comment"> + <p class="comment"> This concludes the general purpose configuration part. The script opens the master configuration file. - </p> + </p> <pre class="shell"> <samp>*** LXR master configuration file setup *** - Global section part +Global section part *** Configuring auxiliary tool paths *** Configuring host name or IP (as http://...)</samp> </pre> - <ul class="version"> - <li>Release 1.1 or higher + <ul class="version"> + <li>Release 1.1 or higher <pre class="shell"> <samp>*** Host name previously defined as //localhost</samp> </pre> - <p class="comment"> + <p class="comment"> This line echoes the hostname you defined during web server configuration above. - </p> - </li> - <li>Release 1.0 + </p> + </li> + <li>Release 1.0 <pre class="shell"> <samp>--- Host name? ></samp><kbd>//localhost</kbd> </pre> - <p class="normal"> + <p class="normal"> Give the primary host name. - </p> - </li> - </ul> + </p> + </li> + </ul> <pre class="shell"> <samp>--- Alias name ? (hit return to stop) ></samp><kbd>//mycomputer.example.com</kbd> <samp>--- Alias name ? (hit return to stop) ></samp> </pre> - <p class="normal"> + <p class="normal"> Give as many aliases (eventually none) as you need. - </p> + </p> <pre class="shell"> <samp>*** Configuring HTML parameters</samp> </pre> - <ul class="version"> - <li>Release 1.1 or higher + <ul class="version"> + <li>Release 1.1 or higher <pre class="shell"> <samp>'Buttons-and-menus' interface is recommended for the kernel *** to avoid screen cluttering. --- Use 'buttons-and-menus' instead of 'link' interface? [YES/no] ></samp> </pre> - <p class="normal"> + <p class="normal"> <em>buttons-and-menus</em> interface offers a denser layout than the traditional <em>link</em> interface. It is highly recommended in situations where the source tree @@ -318,94 +301,97 @@ as is the case with the Linux kernel, where some kind of configuration control is implemented through many auxiliary LXR variables. - </p> - </li> - </ul> + </p> + </li> + </ul> <pre class="shell"> <samp>*** Configuring file subsection *** Configuring "common factors" *** Marking tree section</samp> </pre> - <p class="comment"> + <p class="comment"> The tree-independent part is now configured. - </p> + </p> <pre class="shell"> <samp>*** LXR master configuration file setup *** - Tree section part - SQL script for database initialisation +Tree section part +SQL script for database initialisation *** Configuring LXR server parameters *** The virtual root is the fixed URL part after the hostname.</samp> </pre> - <ul class="version"> - <li>Release 1.1 or higher + <ul class="version"> + <li>Release 1.1 or higher <pre class="shell"> <samp>*** You previously defined the virtual root as /lxr</samp> </pre> - <p class="comment"> + <p class="comment"> This line echoes the virtual root implied or defined during web server configuration above. - </p> - </li> - <li>Release 1.0 + </p> + </li> + <li>Release 1.0 <pre class="shell"> <samp>--- Virtual root? (i.e. URL part after host) [/lxr] ></samp> </pre> - <p class="normal"> + <p class="normal"> The default answer builds an URL <code>http://localhost/lxr</code>. If you store your LXR server at the root of your site, to be accessed as <code>http://localhost</code>, the answer must be <code>/</code>, not an empty one (which would select the <code>/lxr</code> default). - </p> - </li> - </ul> + </p> + </li> + </ul> <pre class="shell"> -<samp>--- Caption in page header? (e.g. Project XYZZY displayed by LXR) ></samp><kbd>LXR first trial</kbd> +<samp>--- Caption in page header? +(e.g. Project XYZZY displayed by LXR) ></samp><kbd>LXR first trial</kbd> </pre> - <p class="normal"> + <p class="normal"> This defines the title in the header area of every page. - </p> + </p> <pre class="shell"> <samp>Do you need a specific encoding for this tree ? [yes/NO] ></samp> </pre> - <p class="normal"> + <p class="normal"> The default encoding is <code>UTF-8</code>. If your tree uses another encoding, answer <code>Y</code> and enter an IANA-registered encoding, such as <code>iso-8859-1</code>. - </p> + </p> <pre class="shell"> <samp>*** Describing tree location How is your tree stored? [FILES/cvs/git/subversion/bitkeeper] *** A source directory contains one sub-directory for every version.</samp> -<samp>--- Source directory? (e.g. /home/myself/project-tree) ></samp><kbd>/home/myself/my-project</kbd> +<samp>--- Source directory? +(e.g. /home/myself/project-tree) ></samp><kbd>/home/myself/my-project</kbd> </pre> - <p class="normal"> + <p class="normal"> Make your first trial on a tree composed of real files and directories (<em>i.e.</em> not stored in a VCS repository). Note that the path to the project directory is in <strong>OS-absolute</strong> form. - </p> - <p class="comment"> + </p> + <p class="comment"> <span class="caution">REMINDER!</span> LXR is aimed at browsing among different versions of a project. Consequently, it expects to find version directories in the designated source directory, such as <em>/home/myself/my-project/v1</em>, …, even if you have only one version. - </p> + </p> <pre class="shell"> -<samp>Name to display for the path root? (e.g. Project or $v for version) [$v] ></samp> +<samp>Name to display for the path root? +(e.g. Project or $v for version) [$v] ></samp> </pre> - <p class="normal"> + <p class="normal"> This is a replacement for the source directory part of a file path to be displayed in the page header. The default <code>$v</code> answer dynamically inserts the version name. - </p> + </p> <pre class="shell"> <samp>*** Enumerating versions -Label for version selection menu? [Version] +Label for version selection menu? [Version] *** Versions can be explicitly enumerated, be read from a file or computed *** by a function. The latter case is recommended for VCS-stored trees. Version enumeration method? [LIST/file/function] ></samp> @@ -415,31 +401,31 @@ *** a prefered version.</samp> <samp>--- Default displayed version is first in 'range'? [YES/no] ></samp> </pre> - <p class="normal"> + <p class="normal"> Tell LXR how many versions there are in the source directory. To stop version request, answer with an empty name (just hit "return"). - </p> - <p class="comment"> + </p> + <p class="comment"> <strong>Tip:</strong><br> To have the latest version displayed by default, list them in reverse chronological order, latest first, oldest last. - </p> + </p> <pre class="shell"> -<samp>*** Setting directory lists -*** Some directories may contain non-public project data (binaries, +<samp>*** Setting directory lists</samp> +<samp>*** Some directories may contain non-public project data (binaries, *** compilers caches, SCM control data, ...). They can be hidden from LXR. --- Directory to ignore, e.g. CVSROOT or .git? (hit return to stop) *** If your source code uses "include" statements (#include, require, ...) *** LXR needs hints to resolve the destination file. --- Include directory, e.g. /include? (hit return to stop) ></samp> </pre> - <p class="normal"> + <p class="normal"> Leave aside these questions for simple user source tree. They allow to "hide" some subdirectories from LXR and to resolve the <em>include</em> directives in the source. - </p> + </p> <pre class="shell"> <samp>*** Configuring data storage</samp> <samp>--- Database name? ></samp><kbd>lxr_myproject</kbd> @@ -450,48 +436,48 @@ <samp>configuration saved in custom.d/lxr.conf DB initialisation sript is custom.d/initdb.sh</samp> </pre> - <p class="normal"> + <p class="normal"> Give a name to the database according to your site rules. Anyway, it is a good idea to have it unique, unless you define this database as a specific set of tables in an existing one. In this case, give a unique table prefix instead of the default <code>lxr_</code>. - </p> - <p class="comment"> + </p> + <p class="comment"> The tree-specific part is now configured and you're done. - </p> - </li> - <li>Check the database environment - <p class="normal"> + </p> + </li> + <li>Check the database environment + <p class="normal"> The database initialisation script does its job under the master user (by default <code>root</code> for <strong>MySQL</strong> and <code>postgres</code> for <strong>PostgreSQL</strong>). If it has been changed on your computer, edit <em>initdb.sh</em>. - </p> - </li> - <li><a name="createdb">Create the database</a> - <p class="normal"> + </p> + </li> + <li>Create the database + <p class="normal"> Launch the script generated in the previous step. - </p> + </p> <pre class="shell"> <samp>$ </samp><kbd>./custom.d/initdb.sh</kbd> </pre> - <p class="comment"> + <p class="comment"> <strong>Note:</strong> Under <strong>MySQL</strong>, the master passsword is requested several times. - </p> - <p class="comment"> + </p> + <p class="comment"> Ignore the errors about inexistent objects (user, database, tables, …). This script proceeds by tentatively deleting the objects before creating them, so that it can be used anytime to restart in a consistent state. - </p> - <p class="comment caution"> + </p> + <p class="comment caution"> CAVEAT!<br> It is safer to delete this script as soon as it has been run since script <em>configure-lxr.pl</em> always adds at the end @@ -502,35 +488,32 @@ Failing to delete keeps all previous database creations. When the script is run again, new databases are created and older ones are recreated, thus losing their content. - </p> - </li> - <li>Copy <code>lxr.conf</code> to its final location - <p class="normal"> + </p> + </li> + <li>Copy <code>lxr.conf</code> to its final location + <p class="normal"> Eventually, manually tune the configuration parameters before the copy. - </p> + </p> <pre class="shell"> <samp>$ </samp><kbd>cp custom.d/lxr.conf .</kbd> </pre> - <p class="comment"> + <p class="comment"> Use of <code>cp</code> instead of <code>mv</code> allows to add other trees later without reconfiguring everything. - </p> - </li> - </ul> - <div class="boxed"> - <p class="normal"> -For an example of parameter values -for the demo trees on SourceForge, -see <a href="/cgi-bin/showconfig">here</a>. </p> - </div> + </li> + </ol> + <div class="boxed"> <p class="normal"> - You're now ready to load the database with your data. +For an example of parameter values +for the demo trees on SourceForge, +see <a href="/demo/showconfig">here</a>. </p> - </td> - </tr> -</table> - + </div> + <p class="normal"> +You're now ready to load the database with your data. + </p> + </section> +</section> <!--#include virtual="/${langPrefix}installNavBtn.shtml" --> - -<!--#include virtual="/backstore/footer.shtml" --> +<!--#include virtual="/backstore5/footer.shtml" --> Index: 1-0-install4genxref.shtml =================================================================== RCS file: /cvsroot/lxr/html/prototype/1-0-InstallSteps/1-0-install4genxref.shtml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- 1-0-install4genxref.shtml 23 Sep 2012 16:48:10 -0000 1.3 +++ 1-0-install4genxref.shtml 18 Jan 2014 09:54:17 -0000 1.4 @@ -1,83 +1,75 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> -<!-- $Id$ --> -<html> +<!--#set var="pageMetaTitle" value="LXR 1.0 Populate Database" --> <!--#set var="pageLang" value="en" --> <!--#set var="indxPage" value="1-0-install.shtml" --> <!--#set var="prevPage" value="1-0-install3config.shtml" --> <!--#set var="nextPage" value="1-0-install5server.shtml" --> -<head> - <meta http-equiv="content-type" content="text/html; charset=UTF-8"> - <meta http-equiv="Content-Language" content="<!--#echo var="pageLang" -->"> - <title>LXR 1.0 Populate Database</title> - <link rel="stylesheet" type="text/css" href="/backstore/LXRweb.css"> - <link rel="icon" type="image/x-icon" href="/backstore/LXRlogo2.ico"> - <link rel="index" href="<!--#echo var='indxPage' -->"> - <link rel="prev" href="<!--#echo var='prevPage' -->"> - <link rel="next" href="<!--#echo var='nextPage' -->"> -</head> - -<body> - <!--#set var="pageHeaderTitle" value="Step 4: Populate LXR Database" --> - <!--#set var="homePageHeader" value="0" --> - <!--#include virtual="/backstore/header.shtml" --> -<table> - <tr> - <td class="navbar"> +<!--#set var="pageHeaderTitle" value="Step 4: Populate LXR Database" --> +<!--#set var="homePageHeader" value="0" --> +<!--#include virtual="/backstore5/header.shtml" --> +<!-- $Id$ --> +<section> <!--#set var="installStep" value="4" --><!--#include virtual="1-0-installNavbar.shtml" --> - </td> - <td class="instr"> - <p class="normal"> + <section class="instr"> + <p class="normal"> It is time to generate the index. This is a job for script <strong><code>genxref</code></strong>. -<code>genxref</code> is driven by two arguments: - </p> - <ul> - <li><code>--url=</code><em>URL_of_your_source_tree</em> - <p class="normal"> +<code>genxref</code> is driven by two or three arguments: + </p> + <ul> + <li><code>--url=</code><em>URL_of_your_source_tree</em> + <p class="normal"> The URL is made of a <code>'host_names'</code> followed by <code>'virtroot'</code>. <br> The purpose of this argument is to locate inside <em>lxr.conf</em> which tree to work on. - </p> - </li> - <li><code>--version=</code><em>name_of_version_to_index</em> - <p class="normal"> + </p> + </li> + <li><code>--version=</code><em>name_of_version_to_index</em> + <p class="normal"> This instructs <code>genxref</code> to index ONLY the designated version. It is interesting for trees with numerous versions to limit the time consumed in indexing when only one version was modified since last indexing. - </p> - <p class="comment"> + </p> + <p class="comment"> The version must match one defined in the <code>'range'</code> parameter. - </p> - </li> - </ul> - <p class="normal"> - With the previous configuration, this gives: - </p> + </p> + </li> + <li><code>--treename=</code><em>name_of_tree_to_index</em> + <p class="normal"> +<span class="comment">(Starting with LXR 2.0)</span> +This selects a tree if tree is designated through URL argument. + </li> + </ul> + <p class="normal"> +With the previous configuration, this gives: + </p> <pre class="shell"> <samp>$ </samp><kbd>./genxref --url=http://localhost/lxr --version=v1</kbd> </pre> - <p class="normal caution"> - Depending on the size of your source, indexing may be very - lengthy. - If you intend to index the kernel tree, think of launching - <code>genxref</code> for at least an overnight job (YMMV). - Test before on a simple case if this is your first - installation. - </p> - <p class="comment"> + <p class="normal caution"> +Depending on the size of your source, indexing may be very +lengthy. +If you intend to index the kernel tree, think of launching +<code>genxref</code> for at least an overnight job (YMMV). +Test before on a simple case if this is your first +installation. + </p> + <p class="comment"> As an example, -indexing the single 3.1 kernel took 2 hours 39 minutes on a high-end computer +indexing the single 3.1 kernel with <em>LXR 1.0</em> took +2 hours 39 minutes on a high-end computer (Intel i5 3.3GHz processor and 4GB memory under Fedora 17, MySQL and Glimpse). - </p> - <p class="normal"> +This time drops slightly below one hour with <em>LXR 2.0</em> +on the same carefully tuned computer. + </p> + <p class="normal"> Before launching this time-consuming job, you have a last opportunity to check your configuration for trivial errors with argument <code>--checkonly</code>: - </p> + </p> <pre class="shell"> <samp>$ </samp><kbd>./genxref --url=http://localhost/lxr --version=v4 --checkonly</kbd> <samp>[ OK ] Perl version ... 5.14.2 @@ -89,21 +81,18 @@ genxref stopped without indexing by --checkonly option </samp> </pre> - <p class="comment"> + <p class="comment"> Of course, not all errors are found, but this test eliminates typo errors on critical parameters. - </p> - <p class="normal"> - You can also ask <code>genxref</code> to index every version - in your tree with argument <code>--allversions</code> as in: </p> + <p class="normal"> +You can also ask <code>genxref</code> to index every version +in your tree with argument <code>--allversions</code> as in: + </p> <pre class="shell"> <samp>$ </samp><kbd>./genxref --url=http://localhost/lxr --allversions</kbd> </pre> - </td> - </tr> -</table> - + </section> +</section> <!--#include virtual="/${langPrefix}installNavBtn.shtml" --> - -<!--#include virtual="/backstore/footer.shtml" --> +<!--#include virtual="/backstore5/footer.shtml" --> Index: 1-0-install5server.shtml =================================================================== RCS file: /cvsroot/lxr/html/prototype/1-0-InstallSteps/1-0-install5server.shtml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- 1-0-install5server.shtml 23 Sep 2012 16:48:10 -0000 1.3 +++ 1-0-install5server.shtml 18 Jan 2014 09:54:17 -0000 1.4 @@ -1,37 +1,23 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> -<!-- $Id$ --> -<html> +<!--#set var="pageMetaTitle" value="LXR 1.0 Configure Web Server" --> <!--#set var="pageLang" value="en" --> <!--#set var="indxPage" value="1-0-install.shtml" --> <!--#set var="prevPage" value="1-0-install4genxref.shtml" --> -<head> - <meta http-equiv="content-type" content="text/html; charset=UTF-8"> - <meta http-equiv="Content-Language" content="<!--#echo var="pageLang" -->"> - <title>LXR 0.11 Configure Web Server</title> - <link rel="stylesheet" type="text/css" href="/backstore/LXRweb.css"> - <link rel="icon" type="image/x-icon" href="/backstore/LXRlogo2.ico"> - <link rel="index" href="<!--#echo var='indxPage' -->"> - <link rel="prev" href="<!--#echo var='prevPage' -->"> -</head> - -<body> - <!--#set var="pageHeaderTitle" value="Step 5: Configure the Web Server" --> - <!--#set var="homePageHeader" value="0" --> - <!--#include virtual="/backstore/header.shtml" --> -<table> - <tr> - <td class="navbar"> +<!--#set var="pageHeaderTitle" value="Step 5: Configure the Web Server" --> +<!--#set var="homePageHeader" value="0" --> +<!--#include virtual="/backstore5/header.shtml" --> +<!-- $Id$ --> +<section> <!--#set var="installStep" value="5" --><!--#include virtual="1-0-installNavbar.shtml" --> - </td> - <td class=instr> - <p class="normal"> + <section class=instr> + <p class="normal"> The last task is to configure your web server. Instructions below are given for <strong>Apache</strong> and <strong>lighttpd</strong> servers. - </p> - <ul> - <li><strong>Apache</strong> web server - <p class="comment"> +Read the <cite>User's Manual</cite> for other servers. + </p> + <ul> + <li><strong>Apache</strong> web server + <p class="comment"> The <a href="1-0-install3config.shtml">configuration step</a> created a <em>custom.d/apache-lxrserver.conf</em> to be copied into <em>/etc/httpd/conf.d/</em>. @@ -40,49 +26,49 @@ Whenever the server software is updated, all you have to do is store again this file in the <em>/etc/httpd/conf.d/</em> directory. - </p> - <p class="normal caution"> + </p> + <p class="normal caution"> Access to the <em>/etc/httpd/conf.d/</em> directory requires <em>root</em> privileges. - </p> - <p class="normal"> + </p> + <p class="normal"> Copy the file to the Apache configuration directory: - </p> + </p> <pre class="shell"> <samp>$ </samp><kbd>cp custom.d/apache-lxrserver.conf /etc/httpd/conf.d</kbd> </pre> - <p class="comment"> + <p class="comment"> This file is valid both for <strong>Apache</strong> version <span class="attention">1.x</span> and version <span class="attention">2.x</span>. - </p> - <p class="normal"> + </p> + <p class="normal"> The "per-directory" configuration file <em>.htaccess</em> has been created by the pre-configuration step and is already stored in the LXR root directory. Edit it to enable directory listing or apply other personal preferences. - </p> - <ul> - <li>Apache version 1.x - <p class="normal"> + </p> + <ul> + <li>Apache version 1.x + <p class="normal"> <strong>mod_perl</strong> for Apache 1.x accesses only the system Perl library. Consequently, you must copy LXR private library there: - </p> + </p> <pre class="shell"> <samp>$ </samp><kbd>cp -r lib/LXR/* /usr/lib/perl5/site_perl/</kbd> <samp>$ </samp><kbd>cp lib/Local.pm /usr/lib/perl5/site_perl/</kbd> </pre> - </li> - </ul> - <li><strong>lighttpd</strong> web server - <p class="comment"> + </li> + </ul> + <li><strong>lighttpd</strong> web server + <p class="comment"> Pre-configuration step created a <em>custom.d/lighttpd-lxrserver.conf</em> to be used as the configuration file basis for LXR. Review and edit this file. - </p> - <p class="normal"> + </p> + <p class="normal"> lighttpd operation is module-oriented: the needed modules must be loaded by the configuration file. A minimal set of modules is listed in file @@ -92,87 +78,84 @@ directory, edit it and change a directive in the configuration file. Scroll down to section <em>Load the modules</em> to check the <code>include</code> directive. - </p> + </p> <pre class="example"> include "/<em>LXR_root_directory</em>/custom.d/lighttpd-lxr-modules.conf" </pre> - <p class="normal"> - LXR-specific configuration is located at the end of the file in - <em>LXR section</em>. - </p> - <p class="normal"> - Uncomment <code>$HTTP</code> directive. - Duplicate it for as many host names you defined. - Replace string <code>host_name</code> by your host names. - Example: - </p> + <p class="normal"> +LXR-specific configuration is located at the end of the file in +<em>LXR section</em>. + </p> + <p class="normal"> +Uncomment <code>$HTTP</code> directive. +Duplicate it for as many host names you defined. +Replace string <code>host_name</code> by your host names. +Example: + </p> <pre class="example"> $HTTP["host"] == "192.168.1.1" { - server.document-root = "/usr/local/share/lxr/" +server.document-root = "/usr/local/share/lxr/" } </pre> - <p class="normal"> - Check the configuration file: - </p> + <p class="normal"> +Check the configuration file: + </p> <pre class="shell"> <samp>$ </samp><kbd>lighttpd -t -f custom.d/lighttpd-lxrserver.conf</kbd> </pre> - <p class="normal"> - Launch lighttpd web server. - </p> - <ul> - <li>for single user service + <p class="normal"> +Launch lighttpd web server. + </p> + <ul> + <li>for single user service <pre class="shell"> <samp>$ </samp><kbd>lighttpd -D -f custom.d/lighttpd-lxrserver.conf</kbd> </pre> - <p class="normal"> - Type ctl-C to stop lighttpd. - </p> - </li> - <li>for system-wide service - <span class="comment">(on a single line)</span> + <p class="normal"> +Type ctl-C to stop lighttpd. + </p> + </li> + <li>for system-wide service + <span class="comment">(on a single line)</span> <pre class="shell"> <samp>$ </samp><kbd>LIGHTTPD_CONF_PATH="/path/to/lxr/custom.d/lighttpd-lxrserver.conf" \ - ./scripts/lighttpd-init start</kbd> + ./scripts/lighttpd-init start</kbd> </pre> - <p class="normal"> - To stop lighttpd, type: - </p> + <p class="normal"> +To stop lighttpd, type: + </p> <pre class="shell"> <samp>$ </samp><kbd>./scripts/lighttpd-init stop</kbd> </pre> - </li> - </ul> - <p class="comment"> - If you already operate a lighttpd server, - merging LXR with global configuration is left to you as an exercice. - </p> - </li> - <li>In case you later encounter difficulties with SELinux - (security alerts related to the <em>LXR root directory</em>) - <p class="normal"> - Scripts and their directories must be specifically labeled to identify them - as executing code as a "normal" context. - This is routinely done - when they are located in <em>/var/www/cgi-bin/</em>. - To eliminate alerts, the most reliable method is to clone - <em>/var/www/cgi-bin/</em> context with the following command: - </p> + </li> + </ul> + <p class="comment"> +If you already operate a lighttpd server, +merging LXR with global configuration is left to you as an exercice. + </p> + </li> + <li>In case you later encounter difficulties with SELinux +(security alerts related to the <em>LXR root directory</em>) + <p class="normal"> +Scripts and their directories must be specifically labeled to identify them +as executing code as a "normal" context. +This is routinely done +when they are located in <em>/var/www/cgi-bin/</em>. +To eliminate alerts, the most reliable method is to clone + <em>/var/www/cgi-bin/</em> context with the following command: + </p> <pre class="shell"> $ <kbd>chcon --reference /var/www/cgi-bin -R LXR_root_directory/</kbd> </pre> - </li> - </ul> - - <p class="normal"> - Fire up your webbrowser and go to <code>http://localhost/lxr/source</code>. - You should see the content of the directory of the default version - for your tree. - </p> - </td> - </tr> -</table> + </li> + </ul> + <p class="normal"> +Fire up your webbrowser and go to <code>http://localhost/lxr/source</code>. +You should see the content of the directory of the default version +for your tree. + </p> + </section> +</section> <!--#include virtual="/${langPrefix}installNavBtn.shtml" --> - -<!--#include virtual="/backstore/footer.shtml" --> +<!--#include virtual="/backstore5/footer.shtml" --> Index: 1-0-installNavbar.shtml =================================================================== RCS file: /cvsroot/lxr/html/prototype/1-0-InstallSteps/1-0-installNavbar.shtml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- 1-0-installNavbar.shtml 27 Aug 2012 07:50:49 -0000 1.2 +++ 1-0-installNavbar.shtml 18 Jan 2014 09:54:17 -00... [truncated message content] |
