"Fossies" - the Fresh Open Source Software Archive

Member "squidanalyzer-6.6/INSTALL" (7 May 2017, 6811 Bytes) of package /linux/privat/squidanalyzer-6.6.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "INSTALL": 6.5_vs_6.6.

    1 NAME
    2     SquidAnalyzer - Squid access log report generation tool
    3 
    4 REQUIREMENT
    5     Nothing is required than a modern perl version 5.8 or higher. Graphics
    6     are based on the Flotr2 Javascript library so they are drawn at your
    7     browser side without extra installation required.
    8 
    9 INSTALLATION
   10   Generic install
   11     If you want the package to be intalled into the Perl distribution just
   12     do the following:
   13 
   14         perl Makefile.PL
   15         make
   16         make install
   17 
   18     Follow the instruction given at the end of install. With this default
   19     install everything configurable will be installed under
   20     /etc/squidanalyzer. The Perl library SquidAnalyzer.pm will be installed
   21     under your site_perl directory and the squid-analyzer Perl script will
   22     be copied under /usr/local/bin.
   23 
   24     The default output directory for html reports will be
   25     /var/www/squidanalyzer/.
   26 
   27     On FreeBSD, if make install is freezing and you have the following
   28     messages:
   29 
   30             FreeBSD: Registering installation in the package database
   31             FreeBSD: Cannot determine short module description
   32             FreeBSD: Cannot determine module description
   33 
   34     please proceed as follow:
   35 
   36             perl Makefile.PL INSTALLDIRS=site
   37             make
   38             make install
   39 
   40     as the issue is related to an install into the default Perl vendor
   41     installdirs it will then use Perl site installdirs.
   42 
   43   Custom install
   44     You can create your fully customized SquidAnalyzer installation by using
   45     the Makefile.PL Perl script. Here is a sample:
   46 
   47             perl Makefile.PL \
   48                     LOGFILE=/var/log/squid3/access.log \
   49                     BINDIR=/usr/bin \
   50                     CONFDIR=/etc \
   51                     HTMLDIR=/var/www/squidreport \
   52                     BASEURL=/squidreport \
   53                     MANDIR=/usr/share/man/man3 \
   54                     DOCDIR=/usr/share/doc/squidanalyzer
   55 
   56     If you want to build a distro package, there are two other options that
   57     you may use. The QUIET option is to tell to Makefile.PL to not show the
   58     default post install README. The DESTDIR is to create and install all
   59     files in a package build base directory. For example for Fedora RPM,
   60     thing may look like that:
   61 
   62             # Make Perl and SendmailAnalyzer distrib files
   63             %{__perl} Makefile.PL \
   64                 INSTALLDIRS=vendor \
   65                 QUIET=1 \
   66                 LOGFILE=/var/log/squid/access.log \
   67                 BINDIR=%{_bindir} \
   68                 CONFDIR=%{_sysconfdir} \
   69                 BASEDIR=%{_localstatedir}/lib/%{uname} \
   70                 HTMLDIR=%{webdir} \
   71                 MANDIR=%{_mandir}/man3 \
   72                 DOCDIR=%{_docdir}/%{uname}-%{version} \
   73                 DESTDIR=%{buildroot} < /dev/null
   74 
   75     See spec file in packaging/RPM for full RPM build script.
   76 
   77   Local install
   78     You can also have a custom installation. Just copy the SquidAnalyzer.pm
   79     and the squid-analyzer perl script into a directory, copy and modify the
   80     configuration file and run the script from here with the -c option.
   81 
   82     Then copy files sorttable.js, squidanalyzer.css and
   83     logo-squidanalyzer.png into the output directory.
   84 
   85   Post installation
   86     1. Modify your httpd.conf to allow access to HTML output like follow:
   87 
   88             Alias /squidreport /var/www/squidanalyzer
   89             <Directory /var/www/squidanalyzer>
   90                 Options -Indexes FollowSymLinks MultiViews
   91                 AllowOverride None
   92                 Order deny,allow
   93                 Deny from all
   94                 Allow from 127.0.0.1
   95             </Directory>
   96 
   97     2. If necessary, give additional host access to SquidAnalyzer in
   98     httpd.conf. Restart and ensure that httpd is running.
   99 
  100     3. Browse to http://my.host.dom/squidreport/ to ensure that things are
  101     working properly.
  102 
  103     4. Setup a cronjob to run squid-analyzer daily or more often:
  104 
  105          # SquidAnalyzer log reporting daily
  106          0 2 * * * /usr/local/bin/squid-analyzer > /dev/null 2>&1
  107 
  108     or run it manually. For more information, see README file.
  109 
  110     You can use network name instead of network ip addresses by using the
  111     network-aliases file. Also if you don't have authentication enable and
  112     want to replace client ip addresses by some know user or computer you
  113     can use the user-aliases file to do so.
  114 
  115     See the file squidanalyzer.conf to customized your output statistics and
  116     match your network and file system configuration.
  117 
  118 USAGE
  119     SquidAnalyzer can be run manually or by cron job using the
  120     squid-analyzer Perl script. Here are authorized usage:
  121 
  122         Usage: squid-analyzer [ -c squidanalyzer.conf ] [-l logfile]
  123 
  124             -c | --configfile filename : path to the SquidAnalyzer configuration file.
  125                                          By default: /etc/squidanalyzer.conf
  126             -b | --build_date date     : set the day to be rebuilt, format: yyyy-mm-dd,
  127                                          yyyy-mm or yyyy. Used with -r or --rebuild.
  128             -d | --debug               : show debug information.
  129             -h | --help                : show this message and exit.
  130             -l | --logfile filename    : path to the Squid logfile to parse.
  131                                          By default: /var/log/squid/access.log
  132             -p | --preserve number     : used to set the statistic obsolescence in
  133                                          number of month. Older stats will be removed.
  134             -r | --rebuild             : use this option to rebuild all html and graphs
  135                                          output from all data files.
  136             -v | version               : show version and exit.
  137             --no-year-stat             : disable years statistics, reports will
  138                                          start from month level only.
  139 
  140     There is special options like --rebuild that force SquidAnalyzer to
  141     rebuild all HTML reports, useful after an new feature or a bug fix. If
  142     you want to limit the rebuild to a single day, a single month or year,
  143     you can use the --build_date option by specifying the date part to
  144     rebuild, format: yyyy-mm-dd, yyyy-mm or yyyy.
  145 
  146     The --preserve option should be used if you want to rotate your
  147     statistics and data. The value is the number of months to keep, older
  148     reports and data will be removed from the filesystem. Useful to preserve
  149     space, for example:
  150 
  151             squid-analyzer -p 6 -c /etc/squidanalyzer/squidanalyzer.conf
  152 
  153     will only preserve six month of statistics from the last run of
  154     squidanalyzer.
  155 
  156 CONFIGURATION
  157     See README file.
  158 
  159 AUTHOR
  160     Gilles DAROLD <gilles@darold.net>
  161 
  162 COPYRIGHT
  163     Copyright (c) 2001-2017 Gilles DAROLD
  164 
  165     This package is free software and published under the GPL v3 or above
  166     license.
  167