Last edited: $Date: 2002/10/28 09:55:37 $

Basic Installation Instructions
===============================

1. Preparations
---------------
The following libraries are used by modlogan:

Required libs
- 1. libz
- 2. libpcre >= 3.1
- 3. expat

Highly Recommend libs
- 4. libgd >= 1.7.x (2.0.1 is ok, too)
- 5. libpng

Optional libs
- 6. libadns 
- 7. dmalloc (optional for debugging purposes only)

Required software
- 1. gmake

NOTE: the configure script will check for all those libraries and will 
notify you if neccasary.

If no packages are available for your platform you have to compile the
libraries by yourself:
- 1. libz (??)
- 2. libpcre from ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/
- 3. libgd from http://www.boutell.com/gd/
   (if generated libgd is shared use the patched libgd from
    http://www.kneschke.de/projekte/modlogan/download/)
- 4. expat (http://expat.sf.net/)
- 5. libpng (ftp://ftp.libpng.org/pub/png/src/)
- 6. libadns (http://www.chiark.greenend.org.uk/~ian/adns/)
- 7. dmalloc (optional for debugging purposes only)


1.1 Introduction
----------------

The 'Mod' in the word ModLogAn stands for 'modular' which means that the
input section, processing section and the output section are seperated 
in modules which can be loaded at runtime. The modules are selected by 
the config-file and are working transparently for the user.

To compile the 'dynamic' version you have pass some special requirements.
EVERY library that is used by modlogan and its plugins has to be available
in a SHARED version (<libname>.so). Most important are libgd and libpcre.
If you install both packages on a Linux system make sure that they are
available in a shared version. Some distribution are only providing static
versions of these libraries. 

1.1.1 Extracting the sources
----------------------------
If all the libraries are installed, you have to check if you have everything
in place which is required by modlogan itself:

required:
- modlogan-<version>.tar.gz (the sources of this package)

optional
- modlogan-themes-<version>.tar.gz (the themes for the output plugin
                                    "output_template")
				    
- modlogan-config-<version>.tar.gz (a configfile wizzard)

If yes, unpackage everthing:

$ gzip -cd modlogan-<version>.tar.gz | tar xf -
$ gzip -cd modlogan-themes-<version>.tar.gz | tar xf -
$ gzip -cd modlogan-config-<version>.tar.gz | tar xf -

1.1.2 Preparing compilation
---------------------------
This step is handled by the configure script.
Type:

$ cd modlogan-<version>
$ ./configure 

Please note:

The output modules will only be build with graphics support if you have 
shared version of libgd !! 

2. compilation
--------------

configure modlogan according to the step 1.1.2 and type the
following:

$ make
$ make install

3. configuration
----------------

Either you use the configfile-wizzard 'modlogan-config' or you setup
modlogan yourself based on the config-file in ./doc/modlogan.conf-dist.

4. Running modlogan
-------------------
- execute modlogan:
  $ ... ./modlogan -c <configfilename>
  
In most cases modlogan is started the following way:

$ bzip2 -cd access.log.<current-date>.bz2 | /usr/local/bin/modlogan -c \
  <configfile-host>
  
------------------------------------------------------------------------------
If you've found a bug, need a special feature or just want to tell me how
you like this piece of software, send your mail to:

Jan Kneschke <jan@kneschke.de> || modlogan@lists.netuse.de 
                                  (subscribtion required)
------------------------------------------------------------------------------