Stone Steps Inc.

Article ID: Q20041210-01

Q: Can you list new configuration parameters that are not desribed in README?

A:This page describes new and updated configuration parameters supported by the latest version of Stone Steps Webalizer.

AllDownloads

If this configuration parameter is set to yes and the number of downloads is greater than the number of lines in the download report (i.e. greater than the value of TopDownloads), Stone Steps Webalizer will generate a standalone downloads report, listing all downloads for the current month. Default value: no

AllErrors

If this configuration parameter is set to yes and the number of HTTP errors is greater than the number of lines in the HTTP error report (i.e. greater than the value of TopErrors), Stone Steps Webalizer will generate a standalone HTTP error report, listing all HTTP errors for the current month. Default value: no

ApacheLogFormat

Defines the format Stone Steps Webalizer will use when parsing custom Apache log files. This configuration parameter will only be evaluated when the current log file type is Apache. See Q20041208-01 for details. Default value: none

BundleGroups

Controls whether grouped items in the reports should be bundled together at the beginning of the report or not. Bundling groups together makes it easier to stack them up against each other. Default value: yes

ConvURLsLowerCase

Controls whether URL characters will be converted to lower case (yes) or not (no). See Q20040930-01 for details. This option is evaluated only when Stone Steps Webalizer is processing IIS or Apache custom log files. Default value: no

DNSCache (updated)

Specifies fully-qualified path to the DNS cache file. See Q20041126-02 for details. Default value: none

DNSCacheTTL

Specifies Time To Live (TTL) in days for DNS cache entries. See Q20041126-02 for details. In most cases it is reasonable to set this value to 30 days. Default value: 3

DNSDynamicNames

Controls whether DNS entries will be re-resolved (yes) when Stone Steps Webalizer reads the webalizer.current file or not (no). See Q20041126-02 for details. Default value: no

DownloadPath

Lists a URL path that Stone Steps Webalizer will use to detect file downloads for the downloads report. For example, if you would like to track downloads of a file called util.zip located in the /downloads/ directory, add the following entry to webalizer.conf:

DownloadPath    /downloads/util.zip    Utility Download

Wildcard characters (*) may be used at the beginning and the end of the path to list partial paths. Note that query strings are ignored when logged URL's are compared with DownloadPath entries. Multiple DownloadPath entries may be used to track more than one path. Default value: none

DownloadTimeout

Maximum number of seconds between consecutive partial download requests that are counted towards the same download job. See Q20050728-01 for details about partial download requests. Default value: 180

DumpDownloads

If this configuration parameter is set to yes, Stone Steps Webalizer will generate a tab-delimited file listing all downloads for the current month. Default value: no

DumpErrors

If this configuration parameter is set to yes, Stone Steps Webalizer will generate a tab-delimited file listing all HTTP errors for the current month. Default value: no

EnablePhraseValues

If this configuration parameter is set to yes, Stone Steps Webalizer will treat the tab character as a name/value separator when parsing two-part configuration entries, such as GroupAgent or SearchEngine and will ignore spaces embedded in the values. See Q20051003 for details. Default value: no

GeoIPDBPath

This configuration parameter is expected to be a fully-qualified path to the MaxMind's GeoIP Country database file in the binary format. The database may be downloaded at the following URL:

http://www.maxmind.com/app/geoip_country

Setting GeoIPDBPath will instruct Stone Steps Webalizer to use the information in the GeoIP database to generate the country report. If this parameter is not set or if it points to a non-existent or invalid GeoIP database, Stone Steps Webalizer will use domain name suffixes, such as .ca or .jp, to generate the country report.

Default value: none

GMTTime (updated)

If GMTTime is set to yes, Stone Steps Webalizer will use the UTC offset value reported in Apache and CLF log files to convert each log record's time stamp from local time to Universal Coordinated Time (UTC). Squid time stamps will also be reported in UTC time in this case. Default value: no

GraphBackgroundAlpha

Sets the transparency of the background of graph images, in percent. The value of 100 makes background completely transparent, while the value of 0 makes it completely opaque. Making graph backgrounds transparent makes it possible to use another image, such as a logo, a gradient or a pattern as a graph background. GraphTrueColor must be set to yes in order for GraphBackgroundAlpha to work. Default value: 0

Note that v6 of Internet Explorer does not render properly PNG images with transparency.

GraphBorderWidth

Defines the width of the 3D border around image graphs in pixels. If set to zero, graph images are generated without a border. This value cannot be greater than 8. Default value: 0

GraphFontNormal, GraphFontBold

Define fully-qualified paths to TrueType font files that Stone Steps Webalizer will use when creating graphs. If these paths are not specified, Stone Steps Webalizer will use default raster fonts. See Q20041214-01 for details. Default value: none

GraphBackgroundColor

Defines the background color for all graphs generated by Stone Steps Webalizer. The value must be specified as six hexadecimal digits, two for each color - red, green and blue. Default value: C0C0C0

GraphFontMedium

Specifies the size, in points, of the small and medium fonts used in graphs. The medium font is used for graph titles and country names in the country report. See Q20041214-01 for details. Default value: 9.5

GraphFontSmall

Specifies the size, in points, of the small font used in graphs. The small font is used for graph legends (e.g. Hits, Visits, etc) and axis markers. See Q20041214-01 for details. Default value: 8

GraphFontSmoothing

Specifies whether Stone Steps Webalizer will create graphs using smoothed TrueType fonts. This value is ignored if default raster fonts are used. See Q20041214-01 for details. Default value: yes

GraphGridlineColor

Defines the color of graph gridlines. The value must be specified as six hexadecimal digits, two for each color - red, green and blue. Default value: 808080

GraphHitsColor

Defines the color of the graph and legend associated with Hits. The value must be specified as six hexadecimal digits, two for each color - red, green and blue. Default value: 00805C

GraphHostsColor

Defines the color of the graph and legend associated with Hosts. The value must be specified as six hexadecimal digits, two for each color - red, green and blue. Default value: FF8000

GraphLegendColor

Defines the base color of the X-axis legend. The value must be specified as six hexadecimal digits, two for each color - red, green and blue. Default value: 000000

GraphOutlineColor

Defines the color of the graph bar outlines. The value must be specified as six hexadecimal digits, two for each color - red, green and blue. Default value: 000000

GraphPagesColor

Defines the color of the graph and legend associated with Pages. The value must be specified as six hexadecimal digits, two for each color - red, green and blue. Default value: 00C0FF

GraphTitleColor

Defines the color of the graph title. The value must be specified as six hexadecimal digits, two for each color - red, green and blue. Default value: 0000FF

GraphVisitsColor

Defines the color of the graph and legend associated with Visits. The value must be specified as six hexadecimal digits, two for each color - red, green and blue. Default value: FFFF00

GraphVolumeColor

Defines the color of the graph and legend associated with KBytes. The value must be specified as six hexadecimal digits, two for each color - red, green and blue. Default value: FF0000

GraphWeekendColor

Defines the color of the weekend days in the monthly traffic report. The value must be specified as six hexadecimal digits, two for each color - red, green and blue. Default value: 00805C

GraphShadowColor

Defines the color of the legend shadow for all graphs generated by Stone Steps Webalizer. The value must be specified as six hexadecimal digits, two for each color - red, green and blue. Default value: 333333

GraphTitleColor

Defines the color of graph titles. The value must be specified as six hexadecimal digits, two for each color - red, green and blue. Default value: 0000FF

GraphTrueColor

Specifies whether Stone Steps Webalizer will create TrueColor or palette-based graph images. TrueColor images are larger in size, but are of better quality, especially if font smoothing is turned on. Default value: no

GroupURLDomains

Squid log files contain absolute URLs, along with fully-qualified domain names. GroupURLDomains may be used to group these domains in the URL report. The value of this configuration parameter is the number of domain labels, past the top-level one, to report. For example, if GroupURLDomains is set to 1, two labels will be reports (e.g. stonesteps.ca); if this parameter is set to 2, three labels will be reported (e.g. forums.stonesteps.ca); and so on. If GroupURLDomains is set to 0, no this type of grouping will not be performed. Default value: 0

HistoryLength

Defines the maximum number of months reported on the main index page. The minimum number of months in the history is 12. Default value: 12

HTMLCharset

Specifies the character set for the reports. See Q20041214-01 for details. Default value: utf-8

HTMLCssPath

Specifies a URL path to the webalizer.css file, not including the file name. The path must be in the URL format, even if it refers to a local file. See the article Q20040929-01 for details. Default value: none

HTMLMetaNoIndex

Controls whether Stone Steps Webalizer will generate HTML reports that may be indexed by robots or not. Default value: yes

HttpPort

Defines the TCP/IP port used by the web server to serve HTTP requests. See Q20041213-01 for details. Default value: 80

HttpsPort

Defines the TCP/IP port used by the web server to serve HTTPS requests. See Q20041213-01 for details. Default value: 443

IgnoreHost, IgnoreSite (updated)

These configuration parameters may be used to instruct Stone Steps Webalizer to ignore hosts identified either by an IP address or by a domain name. Multiple entries may be added to the configuration file if more than one host needs to be ignored. Default value: none

Please, note that if a domain name pattern is specified, it will prevent Stone Steps Webalizer from being able to look up multiple domain names simultaneously and will result in significant performance degradation.

IgnoreReferrerRedirect

Instructs Stone Steps Webalizer which paths should be ignored when counting referrers and referrer search strings. Each parameter may be used to list one path. Multiple parameters can be specified if more than one path should be ignored. See Q20050701-01 for details. Default value: none

IgnoreReferrerPartial

Internet browsers may use partial HTTP requests, which result in responses with the status code 206, to retrieve parts of a large file. If this large file was referred to by some other page (e.g. a search engine, etc), then each partial request will be counted as a separate referrer, distorting website usage analysis results. IgnoreReferrerPartial instructs Stone Steps Webalizer to ignore partial HTTP requests when counting referrers. Default value: yes

Include

Instructs Stone Steps Webalizer to process the specified configuration file after the main configuration file has been processed. See Q20060108-01 for details. Default value: none

IncludeSearchArg, ExcludeSearchArg

Define include and exclude search arguments filters. Each configuration parameter is expected to be either a complete or a partial name of a search argument to include or exclude. A single asterisk may be used to include or exclude all search arguments. Multiple include/exclude directives may be used if more than one search argument is to be included or excluded. The include filter takes precedence over the exclude filter. See Q20050201-01 for details. Default value: none

LanguageFile

Specifies fully-qualified path to the language file. See Q20041007-01 for details. Default value: none

LogType (updated)

New log formats have been added - IIS and Apache. Note that v2.1.10.8 and older treat this value as a lower case string (i.e. use apache, not Apache). Newer versions ignore character case in this value. If you specify log type as Apache, you must also properly configure ApacheLogFormat. See Q20041208-01 for details. Default value: iis

MonthlyTotals

Specifies whether Stone Steps Webalizer should generate the monthly totals report or not. Default value: yes

NoDefaultIndexAlias

Many web servers make it possible to configure a default document for each directory. If a user requests a URL that is a directory (e.g. http://127.0.0.1/books/), the default document from that directory will be served. For example, IIS is usually configured with default.htm as a default document; Apache, as well as many other Unix-originated web servers, is configured to serve index.html as a default document. Stone Steps Webalizer, by default, adds index. to the list of default documents. When processing a URL, Stone Steps Webalizer checks if the requested file matches any entries in the default document list and if it does, strips off the file name from the URL.

This feature allows Stone Steps Webalizer to avoid fragmenting default document statistics if the same document was requested using multiple aliases (e.g. index.html, index.php, etc). However, in some cases, it is undesirable to use index. as a default alias (e.g. if there is a directory named index.ext). Setting NoDefaultIndexAlias to yes prevents Stone Steps Webalizer from adding index. to the default document list. Default value: no

SearchEngine (updated)

SearchEngine has been updated to include a search type qualifier. For example, the following entry designates the as_eq as a search query that should only return pages not containing any of the listed words:

SearchEngine google.  as_eq=Without Words

See Q20050122-01 for details about this parameter and the default list of search engines.

SortSearchArgs

Controls whether search arguments will be sorted alphabetically or not. Default value: yes

SpamReferrer

Each entry lists a keyword identifying the visitor as a spammer. Multiple values may be used to specify more than one keyword. See Q20060703-01 for details. Default value: none

TopDownloads

Defines the maximum number of lines in the downloads report. If the number of actual downloads is greater than this value, the rest of the downloads will either be discarded or generated as a separate downloads report, depending on the value of AllDownloads. Default value: 20

TopErrors

Defines the maximum number of lines in the HTTP error report. If the number of actual errors is greater than this value, the rest of the errors will either be discarded or generated as a separate HTTP error report, depending on the value of AllErrors. Default value: 20

UpstreamTraffic

Indicates whether to track upstream data transfers (i.e. uploads) or not. Note that upstream and downstream transfer amounts are not tracked separately - their values are added together and shown as KBytes. Default value: no

UseHTTPS (updated)

Defines how to form links of URLs that were served over an unknown or a mixed connection type. URLs served over a secure connection will be always formed using the prefix based on the logged port number. See Q20041213-01 for details. Default value: no