Standalone Installation
Prev | Chapter 2. Installing Lire | Next

## Standalone Installation

The most common installation scenario will be where you install Lire on one system to generate daily or weekly reports from cron or by using the command line tools. This setup will install the complete software.

### Requirements

#### Minimum Requirements

To install Lire on a system, you need the following:

- GNU gzip.

- perl 5.005_03 or later. (5.00503, 5.6.0 and 5.6.1 work).

- The `XML::Parser` perl module. (This one needs the `expat` library.)

  `XML::Parser` is available from any CPAN mirror. (http://www.cpan.org/modules/by-module/XML/).

  The `expat` library is available from http://expat.sourceforge.net/.

  As a convenience for our users, you can download a version of Lire which includes those two libraries. Many systems also have prepackaged versions, you're advised to install those packages when available. (They're both packaged for Debian GNU/Linux, as well as for OpenBSD 2.9., see the Lire FAQ for complete details.)

- Standard UNIX utilities like sh, ls, grep, bc, cut, head, sort, tar, etc.

Those are the minimal requirements. With those, you will be able to generate ASCII reports only.

#### Requirements for Other Output Formats

To generate reports in other output formats than ASCII, there are additional requirements as follows:

- An XSLT processor. Currently the only supported XSLT processor is xsltproc, included with the XSLT C Library for Gnome (`libxslt`). You need version 1.0.4 or later. This XSLT C library can be used standalone and does not need the Gnome desktop environment to operate.

  You can download this library along with the `libxml2` library which it requires from http://xmlsoft.org/XSLT/.

  When Lire calls xsltproc, you'll likely see something like “Attempt to load network entity http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd” in the Lire debug messages. This message is given by xsltproc, and is somewhat misleading. A more correct message would be: “A network URL should have been loaded but wasn't because you used xsltproc's --nonet option.” Lire uses --nonet by default so that Lire doesn't hang behind firewalls. So: don't be scared by this message.

The requirements to generate charts are as follows:

- The `GD::Graph` perl module available from CPAN mirrors (http://www.cpan.org/modules/by-module/GD/).

  This module requires the `GD` and `GD::Text` perl modules as well as the `libgd` library.

  The GD Graphics Library™ is available from http://www.boutell.com/gd/.

To generate HTML or XHTML reports, there are in addition to the XSLT processor, the following requirements:

- The DTD for DocBook XML 4.1.2. This is available from http://www.docbook.org/xml/4.1.2/index.html.

- Norman Walsh's XSL stylesheets for DocBook. You can download these stylesheets from http://docbook.sourceforge.net/projects/xsl/index.html.

To generate PDF and RTF reports, there are the following additional requirements:

- Jade, James Clarks' engine for the DSSSL style language. You can also use OpenJade, the name under which Jade is currently being maintained and extended.

  You can download Jade from http://www.jclark.com/jade/. OpenJade is available from http:///openjade.sourceforge.net/.

- The DTD for DocBook XML 4.1.2. This is available from http://www.docbook.org/xml/4.1.2/index.html.

- Norman Walsh's DSSSL stylesheets for DocBook. You can download those stylesheets from http://docbook.sourceforge.net/projects/dsssl/index.html

- (For PDF output only). JadeTeX and recent TeX installation.

  JadeTeX is available from http://jadetex.sourceforge.net/.

#### Other Optional Requirements

Other optional things you may want to install:

- When available, the logger utility can be used to send Lire output to `syslog`.

- The `Time-modules` perl module (available from any CPAN mirror, http://www.cpan.org/modules/by-module/Time/. If it isn't present in the system, the required files included with Lire will be installed.

- The `MIME-Tools` perl module (available from any CPAN mirror, http://www.cpan.org/modules/by-module/MIME/.

  This module is necessary to conveniently send reports by email or to operate a responder.

### Installing

Installation of Lire is pretty straightforward:

1. Make sure that you have the requirements installed.

2. Extract the source code:

       $ gzip -dc lire-version.tar.gz | tar xf -

3. Configure the software. You may use the `--prefix` option to specify where you want to install Lire. By default, it will be installed under `/usr/local`.

       $ cd lire-version
       $ ./configure [--prefix=path]

   Make sure not to use `~` in the `path`. This is known to fail.

   It find all requirements you had installed.

   ### Note

   As for SGML/XML components (DocBook DTD, Norman Walsh's DSSSL and XSL stylesheets), configure should find them if they were installed in ‘standard’ places. (This is somewhere in an `sgml` tree as specified in the FHS and as you will find on most recent GNU/Linux distributions.) If they aren't found, you may hint configure by specifying their location through the use of environment variables:

       $ DBK_XML_DTD=path_to_docbook_dir/docbookx.dtd \
        DBK_DSSSL_STYLESHEETS=path_to_dbk_dsssl_dir \
        DBK_XSL_STYLESHEETS=path_to_dbk_xsl_dir \
        ./configure [--prefix=path]

   Similarly, you can use other environment variables to hint for other things that Lire can't find. See Chapter 18 for the complete list.

4. Compile the software (if you have `XML::Parser` installed, this will consist only of generating man pages).

       $ make

5. You may have to become `root` if you are installing in a directory where only `root` has write permissions.

6. Install Lire.

       # make install

That's it! You have a complete Lire installation and are ready to generate some reports. See Chapter 3 for information on using Lire. You can also read the section called “Configuring Lire Using lr_config” to learn how to configure Lire.

Prev | Up | Next
Chapter 2. Installing Lire | Home | Anonymized Client Installation