$Id: README,v 1.106 2002/10/27 22:02:40 vanbaal Exp $


(If you are interested in running Lire as a client only, i.e. you
want to be able to anonymize your logfiles before you send them to the
LogReport online responder, read README.lire-client.)

* Quickstart for the brave and impatient

version is e.g. 20001213.

 $ wget http://www.logreport.org/pub/lire-version-full.tar.gz
 $ gunzip lire-version-full.tar.gz
 $ tar -xf lire-version.tar.gz
 $ cd lire-version

 $ ./configure

(or, if you want to install as a non-root user:

 $ ./configure --prefix=$HOME/logreport 

)

 $ make && make install

(You might want to refer to INSTALL for details.)

Now you can invoke Lire by running e.g.:

 $ zcat /var/log/maillog.2.gz | \
  lr_run lr_log2report sendmail > /tmp/report.txt

The script lr_log2report is the main Lire interface.  lr_run is a wrapper
script, which takes care of the debug and logging output, generated by
lr_log2report.  The lr_log2report script needs to know what kind of logfile its
processing; therefore it needs an argument like e.g. `sendmail'.  This argument
is what's called a `service'.

A list of `Lire services' gets printed by

 $ lr_run lr_check_service -l

.  This will learn you which log file types are supported.  Some popular
services are `postfix', `common' (for webserver logs), and `bind9_query'.

One could also invoke Lire as:

 $ zcat /var/log/apache/combined.log.gz | \
  lr_run lr_log2report -o html -i combined | \
  tar -xf -

.  The service argument is `combined' here, for webserver's combined, aka
extended common log format, as first implemented by NSCA.  In this case, a
report in HTML format is generated in a newly created subdirectory ./report/.
You'll need xsltproc, GD::Graph and jade for this.  PDF output is supported
also.

Read the lr_log2report manpage for more details.

Read the INSTALL file for an introduction to fancier ways of integrating Lire
with your system.

Read the lire(7) manpage for an overview of all available documentation.

If you'd like to see more exhaustive reports, please let us know at the public
mailinglist questions@logreport.org: we're very curious about what people would
like to see, and we're willing to implement extra reports.

If you want to use the software in a fancier way, if something didn't work out
as expected, or if you're curious by now, refer to the Lire User Manual.  You
can find this document in the doc directory in the Lire tarball, it gets
installed in /usr/local/share/doc/lire/ per default.



