################################################################################ # # # "WEBALIZER Xtended" # # # ################################################################################ README Version: RB30 Date : April 6, 2014 Author : Patrick Frei Copyright (c) 2005-2014 Patrick Frei. All rights reserved. ================================================================================ INDEX 1. INTRODUCTION 1.1. OVERVIEW OF FEATURES 1.2. NEW CONFIGURATION KEYWORDS 1.3. COMMAND LINE PARAMETERS 2. SUPPORT 3. LICENSE ================================================================================ 1. INTRODUCTION ----------------------------------------------- The following sections attempt to provide a short introduction to using Webalizer Xtended. This document is not meant to be a comprehensive manual on understanding or using Webalizer, but should be sufficient to get you running Webalizer with some more features (Webalizer Xtended). For further information see the original README of Webalizer that can be obtained here: ftp://ftp.mrunix.net/pub/webalizer/README For information on building and installing Webalizer Xtended, see the INSTALL file. 1.1. OVERVIEW OF FEATURES ----------------------------------------------- The current release supports mainly the following features: The original features of Webalizer (of course) and... + Separate main table section that shows archived reports. + Apache mod_logio support to log the number of bytes received/sent per request on a website. The numbers reflect the actual bytes as received on the network. See http://httpd.apache.org/docs/2.3/mod/mod_logio.html for more details (Note: You can use this feature for all Apache versions). + Additional monthly statistics for all "HTTP 404 Not Found"-errors incl. hits, number of requests, percentage requests and "HTTP 404 Not Found"-error URL's. + Separate HTML page that displays all "HTTP 404 Not Found"-errors. + Automatic sorting and incremental or full logfile processing of "HTTP 404 Not Found"-errors. + Additional response code pie chart. + Fully user definable colors for all statistics (e.g. background, text, links, tables and charts). + User definable table and chart borders (3D-effects). + Human-readable transfer size (KB, MB, GB, TB, PB, EB instead of KBytes only). + Preset grouping for several well known browsers, user-agents and bots. + New configuration keywords to control all new Webalizer Xtended features. + Various (security) bug-fixes for the original Webalizer v2.23-03. 1.2. NEW CONFIGURATION KEYWORDS ----------------------------------------------- The new features in Webalizer Xtended can be controlled with new configuration keywords in your configuration file. These keywords are listed below: AllErrors The AllErrors keyword allows the display of all 404-errors on a separate HTML page. A link will be added to the bottom of the "Code 404 Monthly Statistics" table if enabled. Value can be either 'yes' or 'no', with 'yes' being the default. ChartBorder Display the chart border with size 'num'. Disable by using zero ('0'), default is 1, maximum is 5. CodeNotFound CodeNotFound defines the number of entries in the 404 error table. The default value for CodeNotFound is 20. The 404 error table may be disabled by using zero (0) for the value. Using one (1) for the value shows all 404 errors in the table. ColorBackground Sets the page's background-color to the specified html color (no '#'). ColorText Sets the page's text-color to the specified html color (no '#'). ColorLink Sets the page's link-color to the specified html color (no '#'). ColorVLink Sets the page's visited-link-color to the specified html color (no '#'). ColorALink Sets the page's activated-link-color to the specified html color (no '#'). ColorGrp Sets the table's group-color (see group* keywords) to the specified html color (no '#'). ColorHeadline Sets the table's headline-color to the specified html color (no '#'). ColorCounter Sets the table's counter-color ('Day', 'Hour', '#') to the specified html color (no '#'). ChartBackgroundColor Sets the chart's background-color to the specified html color (no '#'). ChartLegendColor Sets the chart's legend-color to the specified html color (no '#'). ChartShadowColor1 Sets the chart's frist shadow-color (left/top) to the specified html color (no '#'). ChartShadowColor2 Sets the chart's second shadow-color (bottom/right) to the specified html color (no '#'). HideInOutVolume Hide input/output volume. ResponseGraph Displays the status code response graph (yes/no) TableBorder Display the table border with size 'num'. Disable by using zero ('0'), default is 1, maximum is 5. ArchiveReports ArchiveReports defines (additionally to at most 120 index months) the number of archived reports (months) that will be shown as links in a separate table on the summary page. If a month's report is not available no link will be shown. The default number is 0 (disabled). The maximum number is 480 (40 years). For further information about all other configuration keywords of the original Webalizer see the original README of Webalizer that can be obtained here: ftp://ftp.mrunix.net/pub/webalizer/README 1.3. COMMAND LINE PARAMETERS ----------------------------------------------- Webalizer allows certain configuration options to be provided as parameters. The most common way to specify a parameter is via the command line. For further information see the original README of Webalizer that can be obtained here: ftp://ftp.mrunix.net/pub/webalizer/README ================================================================================ 2. SUPPORT For general information and support of Webalizer Xtended, please contact http://www.patrickfrei.ch/webalizer/ ================================================================================ 3. LICENSE Copyright (c) 2005-2014 Patrick Frei. All rights reserved. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. The full GNU General Public License is included in this distribution in the file called LICENSE. Contact Information: Patrick Frei (http://www.patrickfrei.ch/contact.php) ================================================================================