Google


AWStats logfile analyzer 5.3 Documentation

  


AWStats configuration directives/options


Each directives available in the AWStats config file (.conf) is listed here.
They are described using a consistent format.

Notes To include an environment variable in any parameter (AWStats will replace it with its value when reading it), follow the example:
Parameter="__ENVNAME__"



MAIN SETUP SECTION (Required to make AWStats work)

OPTIONAL SETUP SECTION (Not required but increase AWStats features)

OPTIONAL ACCURACY SETUP SECTION (Not required but increase AWStats features)

OPTIONAL APPEARANCE SETUP SECTION (Not required but increase AWStats features)

PLUGINS

EXTRA

INLUDES


LogFile
Version : 1.0 +
3.1+ for tags %YYYY-n,%YY-n,%MM-n,%DD-n,%HH-n
3.2+ for tag %WM-n
4.0+ for tag %DW-n
4.1+ for tag %NS-n
5.0+ for tag %WY-n
5.1+ for tag %Wm-n, %Wy-n, %Dw-n

# "LogFile" contains the web server logfile to analyze.
# You can use a full path or relative path from awstats.pl directory.
# Example: "/var/log/apache/access.log"
# Example: "../logs/mycombinedlog.log"
# You can also use tags in this filename if you need a dynamic file name
# depending on date or time (Replacement is made by AWStats at the beginning
# of its execution). This is available tags :
# %YYYY-n is replaced with 4 digits year we were n hours ago
# %YY-n is replaced with 2 digits year we were n hours ago
# %MM-n is replaced with month we were n hours ago
# %DD-n is replaced with day we were n hours ago
# %HH-n is replaced with hour we were n hours ago
# %NS-n is replaced with number of seconds at 00:00 since 1970
# %WM-n is replaced with the week number in month (1-5)
# %Wm-n is replaced with the week number in month (0-4)
# %WY-n is replaced with the week number in year (1-52)
# %Wy-n is replaced with the week number in year (0-51)
# %DW-n is replaced with the day number in week (1-7, 1=sunday)
# use n=24 if you need (1-7, 1=monday)
# %Dw-n is replaced with the day number in week (0-6, 0=sunday)
# use n=24 if you need (0-6, 0=monday)
# Use 0 for n if you need current year, month, day, hour...
# Example: "/var/log/access_log.%YYYY-0%MM-0%DD-0.log"
# Example: "C:/WINNT/system32/LogFiles/W3SVC1/ex%YY-24%MM-24%DD-24.log"
# You can also use a pipe if log file come from a pipe.
# Example: "gzip -d </var/log/apache/access.log.gz |"
#
LogFile="/var/log/httpd/mylog.log"

LogFormat
Version : 2.1 +
3.1+ for tags %host,%logname,%time1,%time2,%methodurl,%methodurlnoprot,%method,%url, %query,%code,%bytesd,%refererquot,%referer,%uaquot,%ua,%other
3.2+ for tags %gzipin,%gzipout
4.0+ for tags %gzipratio,%syslog
4.1+ for tag %virtualname

# Enter here your log format (Must agree with your web server. See setup
# instructions in README.txt to know how to configure your web server to have
# the required log format).
# Possible values: 1,2,3,4,5,6 or "your_own_personalized_log_format"
# 1 - Apache native combined log format (NCSA combined/XLF/ELF log format)
# 2 - IIS log format (W3C log format)
# 3 - Webstar native log format
# 4 - Apache or Squid native common log format (NCSA common log format)
# With LogFormat=4, some features (browsers, os, keywords...) can't work.
# 5 - ISA server standard log format
# 6 - Lotus Notes combined log format
# "your_own_personalized_log_format" = If your log is a personalized format,
# you must use the following syntax keys to define the log format string:
# %host Host client name or IP address
# %logname Authenticated login/user used on protected pages
# %time1 Date and time with format: [dd/mmm/yyyy:hh:mm:ss +0000]
# %time1b Date and time with format: [dd/mmm/yyyy:hh:mm:ss]
# %time2 Date and time with format: yyyy-mm-dd hh-mm-ss
# %methodurl Method and URL with format: "GET /index.html HTTP/x.x"
# %methodurlnoprot Method and URL with format: "GET /index.html"
# %method Method with format: GET
# %url URL only with format: /index.html
# %query Query string (used by URLWithQuery option)
# %code Return code status (with format for web log: 999)
# %bytesd Size of document in bytes
# %refererquot Referer page with format: "http://from.com/from.htm"
# %referer Referer page with format: http://from.com/from.htm
# %uaquot User agent with format: "Mozilla/4.0 (compatible, ...)"
# %ua User agent with format: Mozilla/4.0_(compatible...)
# %gzipin Mod_gzip compression input bytes: In:XXX
# %gzipout Mod_gzip compression output bytes & ratio: Out:YYY:ZZZpct.
# %gzipratio Mod_gzip compression ratio: ZZZpct.
# %email EMail sender (for mail log)
# %email_r EMail receiver (for mail log)
# %syslog Syslog-specific time and host stamp with format: Mon dd hh:mm:ss hostname
# %virtualname Web sever virtual hostname. Use this tag when same log
# file contains data of several virtual web servers. The
# SiteDomain will be used to filter the one you want.
# If your log format has some fields not included in this list, use
# %other Means another field
#
# Examples for Apache combined logs (following two examples are equivalent):
# LogFormat = 1
# LogFormat = "%host %other %logname %time1 %methodurl %code %bytesd %refererquot %uaquot"
#
# Examples for IIS (following two examples are equivalent):
# LogFormat = 2
# LogFormat = "%time2 %host %logname %method %url %code %bytesd %other %ua %referer"
#
LogFormat=1

LogSeparator
Version : 5.0 +

# If your log field's separator is not a space, you can change this parameter.
# This parameter is not used if LogFormat is a predefined value (1,2,3,4,5,6)
# Example: " "
# Example: "\t"
# Example: "|"
# Default: " "
#

DNSLookup
Version : 1.0 + (5.0 + for value 2)

# If you want to have hosts reported by name instead of ip address, AWStats
# need to make reverse DNS lookups (if not already done in your log file).
# With DNSLookup to 0, all hosts will be reported by their IP addresses and
# not by the full hostname of visitors.
# If you want to set DNSLookup to 1, don't forget that this will reduce
# dramatically AWStats update process speed. Do not use on large web sites.
# Note: Country detection can works without reverse DNS lookup if plugin
# 'geoip' is enabled (faster and more accurate than reverse DNS lookup).
# Possible values:
# 0 - No DNS Lookup
# 1 - DNS Lookup is fully enabled
# 2 - DNS Lookup is made only from DNS cache files (if exist)
# Default: 2
#
DNSLookup=2

DirData
Version : 1.0 +

# When AWStats updates its statistics, it stores results of its analysis in
# files (AWStats database). All those files are written in the directory
# defined by the "DirData" parameter. Set this value to the directory where
# you want AWStats to save its database and working files into.
# Warning: If you want to be able to use the "AllowToUpdateStatsFromBrowser"
# feature (see later), you need write permissions by webserver user on this
# directory.
# Example: "/var/cache/awstats"
# Example: "../data"
# Example: "C:/awstats_data_dir"
# Default: "." (means same directory as awstats.pl)
#
DirData="."

DirCgi
Version : 1.0 +

# Relative or absolute web URL of your awstats.pl directory.
# This parameter is used only when AWStats is ran from command line
# with -output option (to generate links in HTML reported page).
# Default: "/cgi-bin" (means awstats.pl is in "/mywwwroot/cgi-bin")
#
DirCgi="/cgi-bin"

DirIcons
Version : 1.0 +

# If AWStats used as a CGI, enter relative or absolute web URL of all icons
# subdirectories.
# If you build static reports ("... -output > outputpath/output.html"), enter
# path of icon directory relative to the directory outputpath.
# Example: "/icon"
# Example: "../icon"
# Default: "/icon" (means you must copy icon directories in "/mywwwroot/icon")
#
DirIcons="/icon"

SiteDomain
Version : 3.2 +

# "SiteDomain" must contain the main domain name or the main intranet web
# server name used to reach the web site.
# If you share the same log file for several virtual web servers, this
# parameter is used to tell AWStats to filter record that contains records for
# this virtual host name only (So check that this virtual hostname can be
# found in your log file and use a personalized log format that include the
# %virtualname tag).
# But for multi hosting a better solution is to have one log file for each
# virtual web server. In this case, this parameter is only used to generate
# full URL's links when ShowLinksOnUrl option is set to 1.
# Example: "www.mysite.com"
# Example: "user.mydomain.com"
# Example: "myintranetserver"
#
SiteDomain=""

HostAliases
Version : 1.0 +

# Enter here all other possible domain names, addresses or virtual host
# aliases someone can use to access your site. Try to keep only the minimum
# number of possible names/adresses to have the best performances.
# You can repeat the "SiteDomain" value in this list.
# Use space between each value and put a backslash before each dot.
# This parameter is used to analyze referer field in log file and to help
# AWStats to know if a referer URL is a local URL of same site or an URL of
# another site.
# Example: "www.myserver.com x.y.z.w localhost 127.0.0.1"
#
HostAliases="www.myserver.com x.y.z.w localhost 127.0.0.1"

AllowToUpdateStatsFromBrowser
Version : 3.0 +

# When this parameter is set to 1, AWStats add a button on report page to
# allow to "update" statistics from a web browser. Warning, when "update" is
# made from a browser, AWStats is ran as a CGI by the web server user
# defined in your web server (user "nobody" by default with Apache, "IUSR_XXX"
# with IIS), so the "DirData" directory and all already existing history files
# (awstatsMMYYYY[.xxx].txt) must be writable by this user. Change permissions
# if required.
# Warning: Update process can be long so you might experience "time out"
# browser errors if you don't launch AWStats enough frequently.
# When set to 0, update is only made when AWStats is ran from the command
# line interface (or a task scheduler).
# Possible values: 0 or 1
# Default: 0
#
AllowToUpdateStatsFromBrowser=0

EnableLockForUpdate
Version : 5.0 +

# When the update process run, AWStats can set a lock file in TEMP or TMP
# directory. This lock is to avoid to have 2 update processes running at the
# same time to prevent unknown conflicts problems and avoid DoS attacks when
# AllowToUpdateStatsFromBrowser is set to 1.
# Because, when you use lock file, you can experience sometimes problems in
# lock file not correctly removed (when process is killed for example, this
# requires that you remove the file manualy), this option is not enabled by
# default (Do not enable this option with no consol server access).
# Possible values: 0 or 1
# Default: 0
#
EnableLockForUpdate=0

DNSStaticCacheFile
Version : 5.0 +

# AWStats can do reverse DNS lookups through a static DNS cache file that was
# previously created manually. If no path is given in static DNS cache file
# name, AWStats will search DirData directory. This file is never changed.
# This option is not used if DNSLookup=0.
# Note: DNS cache file format is 'minsince1970 ipaddress resolved_hostname'
# or just 'ipaddress resolved_hostname'
# Example: "/mydnscachedir/dnscache"
# Default: "dnscache.txt"
#
DNSStaticCacheFile="dnscache.txt"

DNSLastUpdateCacheFile
Version : 5.0 +

# AWStats can do reverse DNS lookups through a DNS cache file that was created
# by a previous run of AWStats. This file is erased and recreated after each
# statistics update process. You don't need to create and/or edit it.
# AWStats will read and save this file in DirData directory.
# This option is not used if DNSLookup=0.
# Example: "/mydnscachedir/dnscachelastupdate"
# Default: "dnscachelastupdate.txt"
#
DNSLastUpdateCacheFile="dnscachelastupdate.txt"

SkipDNSLookupFor
Version : 3.0 +

# You can specify specific IP addresses that should NOT be looked up in
# the DNS. You may specify partial addresses (ie 163.85. for everything
# behind the usual firewall setup, etc)...
# This option is used only if DNSLookup=1.
# Note: Use space between each value.
# Example: "163.85. 201.101.51.2"
# Default: ""
#
SkipDNSLookupFor=""

AllowAccessFromWebToAuthenticatedUsersOnly
Version : 4.0 +

# The following two parameters allow you to protect a config file to be used
# by your AWStats program called from a browser only if web user has been
# authenticated. Your AWStats program must be in a web protected "realm" (With
# Apache, you can use .htaccess files to do so. With other web servers, see
# your server setup manual).
# Possible values: 0 or 1
# Default: 0
#
AllowAccessFromWebToAuthenticatedUsersOnly=0

AllowAccessFromWebToFollowingAuthenticatedUsers
Version : 4.0 +

# This parameter gives the list of all authorized authenticated users to view
# statistics for this domain/config file. This parameter is used only if
# AllowAccessToAuthenticatedUsersOnly is set to 1.
# Example: "user1 user2"
# Default: ""
#
AllowAccessFromWebToFollowingAuthenticatedUsers=""

AllowAccessFromWebToFollowingIPAddresses
Version : 5.0 +

# When this parameter is define to something, the IP address of the user that
# read its statistics from a browser (when AWStats is used as a CGI) is
# checked and must match the IP address range defined by this parameter.
# Example: "123.123.123.10-123.123.123.255"
# Default: ""
#
AllowAccessFromWebToFollowingIPAddresses=""

CreateDirDataIfNotExists
Version : 4.0 +

# If the "DirData" directory (see above) does not exists, AWStats return an
# error. However, you can ask AWStats to create it. This option can be used by
# some Web Hosting Providers that has defined a dynamic value for DirData (for
# example DirData="/home/__REMOTE_USER__").
# Possible values: 0 or 1
# Default: 0
#
CreateDirDataIfNotExists=1

SaveDatabaseFilesWithPermissionsForEveryone
Version : 4.0 +

# In most case, AWStats is used as a cgi program. So AWStats process is ran
# by default web server user (nobody for Unix, IUSR_xxx for IIS/Windows,...).
# To make use easier and avoid permission problems between update process
# (run by an admin user) and CGI process (ran by a low level user), AWStats
# save its database files with read and write for everyone.
# If you have experience on managing security policies (Web Hosting Provider),
# you should set this parameter to 0. AWStats will keep default process user
# permissions on its files.
# Possible values: 0 or 1
# Default: 1
#
SaveDatabaseFilesWithPermissionsForEveryone=1

PurgeLogFile
Version : 2.23 +

# AWStats can purge log after processing it. By this way, the next time you
# launch AWStats, log file will be smaller and processing time will be better.
# IMPORTANT !!!
# AWStats is able to detect new lines in log file, to process only them, so
# you can launch AWStats as soon as you want, even with this parameter to 0.
# With 0, no purge is made, so you must use a scheduled task or a web server
# that make this purge frequently.
# With 1, the purge of the log file is made each time AWStats is ran.
# This parameter doesn't work with IIS (This web server doesn't let its log
# file to be purged).
# Possible values: 0 or 1
# Default: 0
#
PurgeLogFile=0

ArchiveLogRecords
Version : 2.1 +

# When PurgeLogFile is setup to 1, AWStats will clean your log file after
# processing it. You can however keep an archive file (saved in "DirData") of
# all processed log records by setting this to 1 (For example if you want to
# use another log analyzer).
# This parameter is not used if PurgeLogFile=0
# Possible values: 0 or 1
# Default: 0
#
ArchiveLogRecords=0

KeepBackupOfHistoricFiles
Version : 3.2 +

# Each time you run the update process, AWStats overwrite the 'historic file'
# for the month (awstatsMMYYYY[.*].txt) with the updated one.
# When write errors occurs (IO, disk full,...), this historic file can be
# corrupted and must be deleted. Because this file contains information of all
# past processed log files, you will loose old stats if removed. So you can
# ask AWStats to save last non corrupted file in a .bak file. This file is
# stored in "DirData" directory with other 'historic files'.
# Possible values: 0 or 1
# Default: 0
#
KeepBackupOfHistoricFiles=0

DefaultFile
Version : 1.0 + (5.0 + can accept several values)

# Default index page name for your web server.
# Example: "default.htm default.html"
# Default: "index.html"
#
DefaultFile="index.html"

SkipHosts
Version : 1.0 +

# Do not include access from clients that match following criteria.
# If your log file contains IP adresses in host field, you must enter here
# matching IP adresses criteria.
# If DNS lookup is already done in your log file, you must enter here hostname
# criteria, else enter ip address criteria.
# The opposite parameter of "SkipHosts" is "OnlyHosts".
# Note: Use space between each value.
# Note: ^xxx means hosts starting with xxx.
# Note: xxx$ means hosts ending with xxx.
# Example: "^127.0.0.1$ ^163.84."
# Example: "localhost abcxyz"
# Default: ""
#
SkipHosts=""

SkipUserAgents
Version : 5.1 +

# Do not include access from clients with a user agent that match following
# criteria. If you want to exclude a robot, you should update the robots.pm
# file instead of this parameter.
# Note: Use space between each value. This parameter is not case sensitive.
# Example: "konqueror"
# Default: ""
#
SkipUserAgents=""

SkipFiles
Version : 1.0 +

# Use SkipFiles to ignore access to URLs that match one of following entries.
# You can, with this option, add a list of not important frame pages (like
# menus, etc...) to exclude them from statistics.
# For example, to ignore a whole directory tree, just add "directorytoignore",
# to ignore "users" pages in your stats, you can add "/~".
# The opposite parameter of "SkipFiles" is "OnlyFiles".
# Note: This parameter is not case sensitive.
# Note: Use space between each value and do not remove default values.
# Note: ^xxx means url starting with xxx.
# Note: xxx$ means url ending with xxx.
# Example: "robots.txt$ favicon.ico$ badpage.html /~"
# Default: "robots.txt$ favicon.ico$"
#
SkipFiles="robots.txt$ favicon.ico$"

OnlyHosts
Version : 5.2 +

# Include in stats, only accesses from hosts that match one of following
# entries. For example, if you want AWStats to filter access to keep only
# stats for visits from particular hosts, you can add thoose hosts names
# in this parameter.
# If DNS lookup is already done in your log file, you must enter here hostname
# criteria, else enter ip address criteria.
# The opposite parameter of "OnlyHosts" is "SkipHosts".
# Note: This parameter is not case sensitive.
# Note: Use space between each value.
# Note: ^xxx means hosts starting with xxx.
# Note: xxx$ means hosts ending with xxx.
# Example: "^123.123.123.123$ ^10.0."
# Default: ""
#
OnlyHosts=""

OnlyFiles
Version : 3.0 +

# Include in stats, only accesses to URLs that match one of following entries.
# For example, if you want AWStats to filter access to keep only stats that
# match a particular string, like a particular directory, you can add this
# directory name in this parameter.
# The opposite parameter of "OnlyFiles" is "SkipFiles".
# Note: This parameter is not case sensitive.
# Note: Use space between each value and do not remove default values
# Note: ^xxx means url starting with xxx.
# Note: xxx$ means url ending with xxx.
# Example: "marketing_directory"
# Default: ""
#
OnlyFiles=""

NotPageList
Version : 3.2 +

# Add here a list of kind of url (file extension) that must be counted as
# "Hit only" and not as a "Hit" and "Page/Download". You can set here all
# images extensions as they are hit downloaded that must be counted but they
# are not viewed pages. URLs with such extensions are not included in the TOP
# Pages/URL report.
# Note: If you want to exclude your own URLs from stats (No Pages and no Hits
# reported), you should use SkipFiles parameter instead.
# Example: ""
# Example: "css js class gif jpg jpeg png bmp zip arj gz z wav mp3 wma mpg"
# Default: "css js class gif jpg jpeg png bmp"
#
NotPageList="css js class gif jpg jpeg png bmp"

ValidHTTPCodes
Version : 4.0 +

# By default, AWStats considers that records found in log file are successful
# hits if HTTP code returned by server is a valid HTTP code (200 and 304).
# Any other code are reported in HTTP error chart.
# However in some specific environment, with web server HTTP redirection,
# you can choose to also accept other codes.
# Example: "200 304 302 305"
# Default: "200 304"
#
ValidHTTPCodes="200 304"

This is examples of current HTTP codes

#[Miscellaneous successes]
"2xx", "[Miscellaneous successes]",
"200", "OK", # HTTP request OK
"201", "Created",
"202", "Request recorded, will be executed later",
"203", "Non-authoritative information",
"204", "Request executed",
"205", "Reset document",
"206", "Partial Content",
#[Miscellaneous redirections]
"3xx", "[Miscellaneous redirections]",
"300", "Multiple documents available",
"301", "Moved Permanently",
"302", "Found",
"303", "See other document",
"304", "Not Modified since last retrieval", # HTTP request OK
"305", "Use proxy",
"306", "Switch proxy",
"307", "Document moved temporarily",
#[Miscellaneous client/user errors]
"4xx", "[Miscellaneous client/user errors]",
"400", "Bad Request",
"401", "Unauthorized",
"402", "Payment required",
"403", "Forbidden",
"404", "Document Not Found",
"405", "Method not allowed",
"406", "ocument not acceptable to client",
"407", "Proxy authentication required",
"408", "Request Timeout",
"409", "Request conflicts with state of resource",
"410", "Document gone permanently",
"411", "Length required",
"412", "Precondition failed",
"413", "Request too long",
"414", "Requested filename too long",
"415", "Unsupported media type",
"416", "Requested range not valid",
"417", "Failed",
#[Miscellaneous server errors]
"5xx", "[Miscellaneous server errors]",
"500", "Internal server Error",
"501", "Not implemented",
"502", "Received bad response from real server",
"503", "Server busy",
"504", "Gateway timeout",
"505", "HTTP version not supported",
"506", "Redirection failed",
#[Unknown]
"xxx" ,"[Unknown]"

ValidSMTPCodes
Version : 5.0 +

# By default, AWStats considers that records found in mail log file are
# successful mail transfers if code saved in log file is a valid code (1 for
# sendmail, 0 for postfix).
# Example: "1"
# Example: "0"
# Default: "1"
#
ValidSMTPCodes="1"

AuthenticatedUsersNotCaseSensitive
Version : 5.3 +

# Some web servers on some Operating systems (IIS-Windows) considers that a
# login with same value but different case are the same login. To tell AWStats
# to also considers them as one, set this parameter to 1.
# Possible values: 0 or 1
# Default: 0
#
AuthenticatedUsersNotCaseSensitive=0

URLNotCaseSensitive
Version : 5.1 +

# Some web servers on some Operating systems (IIS-Windows) considers that two
# URLs with same value but different case are the same URL. To tell AWStats to
# also considers them as one, set this parameter to 1.
# Possible values: 0 or 1
# Default: 0
#
URLNotCaseSensitive=0

URLQuerySeparators
Version : 5.2 +

# In URL links, "?" char is used to add parameter's list in URLs. Syntax is:
# /mypage.html?param1=value1
# However, some servers/sites have also others chars to isolate dynamic part of
# their URLs. You can complete this list with all such characters.
# Example: "?;,"
# Default: "?;"
#
URLQuerySeparators="?;"

URLWithQuery
Version : 3.2 +

# Keep or remove the query string to the URL in the statistics for individual
# pages. This is primarily used to differentiate between the URLs of dynamic
# pages. If set to 1, mypage.html?id=x and mypage.html?id=y are counted as two
# different pages.
# Warning, when set to 1, memory required to run AWStats is dramatically
# increased if you have a lot of changing URLs (for example URLs with a random
# id inside). Such web sites should not set this option to 1 or use seriously
# the next parameter URLWithQueryWithoutFollowingParameters.
# Possible values:
# 0 - URLs are cleaned from the query string (ie: "/mypage.html")
# 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y")
# Default: 0
#
URLWithQuery=0

URLWithQueryWithoutFollowingParameters
Version : 5.1 +

# When URLWithQuery is on, you will get the full URL with all parameters in
# URL reports. But among thoose parameters, sometimes you don't need a
# particular parameter because it does not identify the page or because it's
# a random ID changing for each access even if URL points to same page. In
# such cases, it is higly recommanded to ask AWStats to remove such parameters
# from the URL before counting, manipulating and storing it. Enter here list
# of all non wanted parameters. For example if you enter "id", one hit on
# /mypage.cgi?p=abc&id=Yo4UomP9d and /mypage.cgi?p=abc&id=Mu8fdxl3r
# will be reported as 2 hits on /mypage.cgi?p=abc
# This parameter is not used when URLWithQuery is 0.
# Example: "PHPSESSID jsessionid"
# Default: ""
#
URLWithQueryWithoutFollowingParameters=""

URLReferrerWithQuery
Version : 5.1 +

# Keep or remove the query string to the referrer URL in the statistics for
# external referrer pages. This is used to differentiate between the URLs of
# dynamic referrer pages. If set to 1, mypage.html?id=x and mypage.html?id=y
# are counted as two different referrer pages.
# Possible values:
# 0 - Referrer URLs are cleaned from the query string (ie: "/mypage.html")
# 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y")
# Default: 0
#
URLReferrerWithQuery=0

WarningMessages
Version : 1.0 +

# AWStats can detect setup problems or show you important informations to have
# a better use. Keep this to 1, except if AWStats says you can change it.
# Possible values: 0 or 1
# Default: 1
#
WarningMessages=1

ErrorMessages
Version : 5.2 +

# When an error occurs, AWStats output a message related to errors. If you
# want (in most cases for security reasons) to have no error messages, you
# can set this parameter to your personalized generic message.
# Example: "An error occured. Contact your Administrator"
# Default: ""
#
ErrorMessages=""

DebugMessages
Version : 5.2 +

# AWStat can be run with debug=x parameter to ouput various informations
# to help in debugging or solving troubles. If you wand (in most cases for
# security reasons) to disable debugging, set this parameter to 0.
# Possible values: 0 or 1
# Default: 1
#
DebugMessages=1

NbOfLinesForCorruptedLog
Version : 3.2 +

# To help you to detect if your log format is good, AWStats report an error
# if all the first NbOfLinesForCorruptedLog lines have a format that does not
# match the LogFormat parameter.
# However, some worm virus attack on your web server can result in a very high
# number of corrupted lines in your log. So if you experience awstats stop
# because of bad virus records at the beginning of your log file, you can
# increase this parameter (very rare).
# Default: 50
#
NbOfLinesForCorruptedLog=50

SplitSearchString
Version : 2.24 - 4.0 (deprecated since 4.1)
AWStats 4.1+ supports both keywords AND keyphrases by default with no need of any parameter.

# Search engines keywords reported are full search string or separate keywords
# Possible values:
# 0 - Search keywords reported are full search string (ie: "town maps")
# 1 - Search keywords reported are separated words (ie: "town" and "maps")
# Default: 0
#
SplitSearchString=0

WrapperScript
Version : 4.0 +

# For some particular integration needs, you may want to have CGI links to
# point to another script than awstats.pl.
# Use the name of this script in WrapperScript parameter.
# Example: "awstatslauncher.pl"
# Default: ""
#
WrapperScript=""

DecodeUA
Version : 5.0 +

# DecodeUA must be set to 1 if you use Roxen web server. This server converts
# all spaces in user agent field into %20. This make the AWStats robots, os
# and browsers detection fail in some cases. Just change it to 1 if and only
# if your web server is Roxen.
# Possible values: 0 or 1
# Default: 0
#
DecodeUA=0

LevelFor
Version : 4.0 +

# Following values allows you to disable/enable some AWStats features.
# Possible values: 0, 1 (or 2 for LevelForRobotsDetection)
# Default: 1 (2 for LevelForRobotsDetection)
#
LevelForRobotsDetection=2 # 0 will increase AWStats speed by 1%.
LevelForBrowsersDetection=1 # 0 disables Browsers detection. No speed gain.
LevelForOSDetection=1 # 0 disables OS detection. No speed gain.
LevelForRefererAnalyze=1 # 0 will increase AWStats speed by 5%.

UseFramesWhenCGI
Version : 5.0 +

# When you use AWStats as a CGI, you can have the reports shown in HTML views.
# Frames are only available for report viewed dynamically. When you build
# pages from command line, this option is not used and no frames are built.
# Possible values: 0 or 1
# Default: 1
#
UseFramesWhenCGI=1

DetailedReportsOnNewWindows
Version : 4.1 + (5.0 + for value 2)

# This parameter ask your browser to open detailed reports into a different
# window than the main page.
# Possible values:
# 0 - Open all in same browser window
# 1 - Open detailed reports in another window except if using frames
# 2 - Open always in a different window even if reports are framed
# Default: 1
#
DetailedReportsOnNewWindows=1

Expires
Version : 3.1 +

# You can add in the HTML report page a delay to force browsers to not use cache
# if page is loaded a second time after this delay (in seconds).
# This parameter is not used when report are built with -staticlinks option.
# Example: 3600
# Default: 0
#
Expires=0

MaxRowsInHTMLOutput
Version : 4.0 +

# To avoid too large web pages, you can ask AWStats to limit number of rows of
# all reported charts to this number when no other limit apply.
# Default: 1000
#
MaxRowsInHTMLOutput=1000

Lang
Version : 2.1 +

# Set your primary language.
# Possible value:
# Albanian=al, Bosnian=ba, Bulgarian=bg,
# Chinese (Taiwan)=tw, Chinese (Traditional)=cn, Czech=cz,
# Danish=dk, Dutch=nl, English=en, Finnish=fi, French=fr, German=de,
# Greek=gr, Hungarian=hu, Indonesian=id, Italian=it, Japanese=jp, Korean=kr,
# Latvian=lv, Norwegian (Nynorsk)=nn, Norwegian (Bokmal)=nb, Polish=pl,
# Portuguese=pt, Portuguese (Brazilian)=br, Romanian=ro, Russian=ru,
# Slovak=sk, Spanish=es, Spanish (Catalan)=es_cat, Swedish=se, Turkish=tr,
# Ukrainian=ua, Welsh=wlk
# Default: "en"
#
Lang="en"

DirLang
Version : 2.1 +

# Set the location of language files.
# Example: "/opt/awstats/lang"
# Default: "./lang" (means lang directory is in same location than awstats.pl)
#
DirLang="./lang"

Show...
Version :
3.2 for ShowHeader,ShowMenu,ShowMonthDayStats,ShowDaysOfWeekStats,ShowHoursStats, ShowDomainsStats,ShowHostsStats,ShowAuthenticatedUsers,ShowRobotsStats, ShowPagesStats,ShowFileTypesStats,ShowFileSizesStats,ShowBrowsersStats, ShowOSStats,ShowOriginStats,ShowKeyphrasesStats,ShowKeywordsStats,ShowHTTPErrorsStats
3.2 - 5.0 for ShowCompressionStats (deprecated since 5.1, use code C with ShowFileTypesStats instead)
4.1 for ShowSessionsStats, ShowKeywordsStats
5.1 for all letters codes

# You choose here which reports you want to see in the main page and what you
# want to see in those reports.
# Possible values:
# 0 - Topic is not shown at all
# 1 - Report is shown with default informations
# XYZ - Report is shown with only informations defined by code X,Y,Z
# X,Y,Z are code letters among the following:
# U = Unique visitors
# V = Visits
# P = Number of pages
# H = Number of hits
# B = Bandwith
# L = Last access date
# E = Entry pages
# X = Exit pages
# C = Web compression (mod_gzip)
# M = Average mail size (mail logs)
#
# Show AWStats head title and icon
# Default: 1, Possible codes: None
ShowHeader=1
# Show menu header with links on detailed reports
# Default: 1, Possible codes: None
ShowMenu=1
# Show monthly and daily chart
# Default: UVPHB, Possible codes: UVPHB
ShowMonthDayStats=UVPHB
# Show days of week chart
# Default: PHB, Possible codes: PHB
ShowDaysOfWeekStats=PHB
# Show hourly chart
# Default: PHB, Possible codes: PHB
ShowHoursStats=PHB
# Show domains/country chart
# Default: PHB, Possible codes: PHB
ShowDomainsStats=PHB
# Show hosts chart
# Default: PHBL, Possible codes: PHBL
ShowHostsStats=PHBL
# Show authenticated users chart
# Default: 0, Possible codes: PHBL
ShowAuthenticatedUsers=0
# Show robots chart
# Default: HBL, Possible codes: HBL
ShowRobotsStats=HBL
# Show EMail senders chart (For use when analyzing mail log files)
# Default: 0, Possible codes: HBML
ShowEMailSenders=0
# Show EMail receiver chart (For use when analyzing mail log files)
# Default: 0, Possible codes: HBML
ShowEMailReceivers=0
# Show session chart
# Default: 1, Possible codes: None
ShowSessionsStats=1
# Show pages-url chart.
# Default: PBEX, Possible codes: PBEX
ShowPagesStats=PBEX
# Show file types chart.
# Default: HB, Possible codes: HBC
ShowFileTypesStats=HB
# Show file size chart (Not yet available)
# Default: 1, Possible codes: None
ShowFileSizesStats=0
# Show browsers chart
# Default: 1, Possible codes: None
ShowBrowsersStats=1
# Show Operating systems chart
# Default: 1, Possible codes: None
ShowOSStats=1
# Show Origin chart
# Default: PH, Possible codes: HB
ShowOriginStats=PH
# Show keyphrases chart
# Default: 1, Possible codes: None
ShowKeyphrasesStats=1
# Show keywords chart
# Default: 1, Possible codes: None
ShowKeywordsStats=1
# Show HTTP errors chart
# Default: 1, Possible codes: None
ShowHTTPErrorsStats=1

Max...
Version : 1.0 +

# This value can be used to choose maximum number of lines shown for each
# particular reporting.
#
# Stats by domains
MaxNbOfDomain = 10
# Stats by hosts
MaxNbOfHostsShown = 10
MinHitHost = 1
# Stats by authenticated users
MaxNbOfLoginShown = 10
MinHitLogin = 1
# Stats by robots
MaxNbOfRobotShown = 10
MinHitRobot = 1
# Stats by pages
MaxNbOfPageShown = 10
MinHitFile = 1
# Stats by referers
MaxNbOfRefererShown = 10
MinHitRefer = 1
# Stats for keywords
MaxNbOfKeywordsShown = 10
MinHitKeyword = 1
# Stats for emails
MaxNbOfEMailsShown = 20
MinHitEMail = 1

FirstDayOfWeek
Version : 3.2 +

# Choose if you want week to start on sunday or monday
# Possible values:
# 0 - Week start on sunday
# 1 - Week start on monday
# Default: 1
#
FirstDayOfWeek=1

ShowFlagLinks
Version : 3.2 +

# List of visible flags with link to other language translations.
# See Lang parameter for list of allowed flag/language codes.
# If you don't want any flag link, set ShowFlagLinks to "".
# This parameter is used only if ShowHeader parameter is set to 1.
# Possible values: "" or "language_codes_separated_by_space"
# Default: "en es fr it nl es"
#
ShowFlagLinks="en fr de it nl es"

ShowLinksOnUrl
Version : 3.1 +

# Each URL shown in stats report views are links you can click.
# Possible values: 0 or 1
# Default: 1
#
ShowLinksOnUrl=1

MaxLengthOfURL
Version : 1.0 +

# Maximum length of URL shown on stats page (number of characters). This
# affects only URL visible text, larger links still work.
# Default: 72
#
MaxLengthOfURL=72

ShowLinksToWhoIs
Version : 4.0 +

# AWStats can include a link to WhoIs database on all hostnames/ip. For this, you
# must set ShowLinksToWhoIs to 1. Warning, a such feature depends on two next
# parameter (LinksToWhoIs and LinksToIPWhoIs) and on WhoIs server
# exhaustivity and availability.
# For this reason, this feature can't be a reliable feature.
# Possible values: 0 or 1
# Default: 0
#
ShowLinksToWhoIs=0

LinksToWhoIs
Version : 4.0 +

# Set here the link used to point to Internet WhoIs database for hostnames.
# This parameter is not used if ShowLinksToWhoIs is 0.
# Default: "http://www.whois.net/search.cgi2?str="
# Example: "http://www.netsol.com/cgi-bin/whois/whois?SearchType=all&STRING="
# Example: "http://www.ripe.net/perl/whois?form_type=simple&searchtext="
# Example: "http://www.arin.net/cgi-bin/whois.pl?queryinput="
#
LinksToWhoIs="http://www.whois.net/search.cgi2?str="

LinksToIPWhoIs
Version : 5.0 +

# Set here the link used to point to Internet WhoIs database for ip addresses.
# This parameter is not used if ShowLinksToWhoIs is 0.
# Default: "http://ws.arin.net/cgi-bin/whois.pl?queryinput="
# Example: "http://ws.arin.net/cgi-bin/whois.pl?queryinput="
#
LinksToIPWhoIs="http://ws.arin.net/cgi-bin/whois.pl?queryinput="

HTMLHeadSection
Version : 3.2 +

# You can enter HTML code that will be added at the top of AWStats reports.
# Default: ""
#
HTMLHeadSection=""

HTMLEndSection
Version : 3.2 +

# You can enter HTML code that will be added at the end of AWStats reports.
# Great to add advert ban.
# Default: ""
#
HTMLEndSection=""

Bar...
Version : 1.0 +

# Value of maximum bar width/heigth for horizontal/vertical graphics bar
# Default: 260/90
#
BarWidth = 260
BarHeight = 90

Logo...
Version : 3.1 +

# You can set Logo and LogoLink to use your own logo.
# Logo must be the name of image file (must be in $DirIcons/other directory).
# LogoLink is the expected URL when clicking on Logo.
# Default: "awstats_logo1.png"
#
Logo="awstats_logo1.png"
LogoLink="http://awstats.sourceforge.net"

StyleSheet
Version : 4.0 +

# You can ask AWStats to use a particular CSS (Cascading Style Sheet) to
# change its look.
# Example: "/css/awstats.css"
# Default: ""
#
StyleSheet=""

color_...
Version :
3.1 for color_Background,color_TableBGTitle,color_TableTitle,color_TableBG, color_TableRowTitle,color_TableBGRowTitle,color_TableBorder,color_text, color_textpercent,color_titletext,color_weekend,color_link,color_hover, color_u,color_v,color_p,color_h,color_k,color_s
4.1 for color_e,color_x
5.0 for color_other

# Those colors parameters can be used (if StyleSheet parameter is not used)
# to change AWStats look.
# Example: color_name="RRGGBB" # RRGGBB is Red Green Blue components in Hex
#
color_Background="FFFFFF" # Background color for main page (Default = "FFFFFF")
color_TableBGTitle="CCCCDD" # Background color for table title (Default = "CCCCDD")
color_TableTitle="000000" # Table title font color (Default = "000000")
color_TableBG="CCCCDD" # Background color for table (Default = "CCCCDD")
color_TableRowTitle="FFFFFF" # Table row title font color (Default = "FFFFFF")
color_TableBGRowTitle="ECECEC" # Background color for row title (Default = "ECECEC")
color_TableBorder="ECECEC" # Table border color (Default = "ECECEC")
color_text="000000" # Color of text (Default = "000000")
color_textpercent="606060" # Color of text for percent values (Default = "606060")
color_titletext="000000" # Color of text title within colored Title Rows (Default = "000000")
color_weekend="EAEAEA" # Color for week-end days (Default = "EAEAEA")
color_link="0011BB" # Color of HTML links (Default = "0011BB")
color_hover="605040" # Color of HTML on-mouseover links (Default = "605040")
color_other="666688" # Color of text for 'other' record in charts (Default = "666688")
color_u="FFB055" # Background color for number of unique visitors (Default = "FFB055")
color_v="F8E880" # Background color for number of visites (Default = "F8E880")
color_p="4477DD" # Background color for number of pages (Default = "4477DD")
color_h="66F0FF" # Background color for number of hits (Default = "66F0FF")
color_k="2EA495" # Background color for number of bytes (Default = "2EA495")
color_s="8888DD" # Background color for number of search (Default = "8888DD")
color_e="CEC2E8" # Background color for number of entry pages (Default = "CEC2E8")
color_x="C1B2E2" # Background color for number of exit pages (Default = "C1B2E2")

LoadPlugin
Version : 5.0 +

# Add here all plugins file you want to load.
# Plugin files must be .pm files stored in 'plugins' directory.
# Uncomment LoadPlugin lines to enable a plugin after checking that plugin
# required perl modules are installed.

# Plugin: PluginName
# PluginName description
# Perl modules required: ...
#
LoadPlugin="pluginname"

Extra...
Version : 5.2 +

# You can define your own charts, you choose here what are rows and columns
# keys. This feature is particularly usefull for marketing purpose, tracking
# products orders for example.
# For this, edit all parameters of Extra section. Each set of parameter is a
# different chart. For several charts, duplicate section changing the number.
# Note that each Extra section reduces AWStats speed by 10%.
#
# WARNING: A wrong setup of Extra section can result in a too large arrays
# that will consume all your memory, making AWStats unusable after several
# updates, so be sure to setup it correctly.
# In most cases, you don't need this feature.
#
# ExtraSectionNameX is title of your personalized chart.
# ExtraSectionConditionalX are conditions on URL and/or QUERY_STRING and/or
# REFERER you can use to count or not the hit. Use "|" for "OR".
# ExtraSectionFirstColumnTitleX is the first column title of the chart.
# ExtraSectionFirstColumnValuesX is a Regex string to tell AWStats how to
# extract the value used for first column. Each different value found will
# be a different row. Be sure that list of different values is "limited" to
# avoid "not enough memory" problems !
# ExtraSectionStatTypesX are things you want to count. You can use standard
# code letters (P for pages,H for hits,B for bandwidth,L for last access).
# MaxNbOfExtraX is maximum number of rows shown in chart.
# MinHitExtraX is minimum number of hits required to be shown in chart.
#

# Example to report the 20 products the most ordered by "order.cgi" script
ExtraSectionName1="Product orders"
ExtraSectionCondition1="URL,/cgi-bin/order.cgi"
ExtraSectionFirstColumnTitle1="Product ID"
ExtraSectionFirstColumnValues1="QUERY_STRING,productid=([^&]+)"
ExtraSectionStatTypes1=PL
MaxNbOfExtra1=20
MinHitExtra1=1

#include
Version : 5.1 +

# You can include other config files using the directive with the name of the
# config file (like Apache, so you must keep the '#' before 'include').
# This is particularly usefull for users who have a lot of virtual servers, so
# a lot of config files and want to maintain common values in only one file.
# Note that when a variable is defined both in a config file and in an
# included file, AWStats will use the last value read.
#
#include ""