· 5 years ago · Feb 12, 2020, 01:42 PM
1# AWSTATS CONFIGURE FILE 7.3
2#-----------------------------------------------------------------------------
3# Copy this file into awstats.www.mydomain.conf and edit this new config file
4# to setup AWStats (See documentation in docs/ directory).
5# The config file must be in /etc/awstats, /usr/local/etc/awstats or /etc (for
6# Unix/Linux) or same directory than awstats.pl (Windows, Mac, Unix/Linux...)
7# To include an environment variable in any parameter (AWStats will replace
8# it with its value when reading it), follow the example:
9# Parameter="__ENVNAME__"
10# Note that environment variable AWSTATS_CURRENT_CONFIG is always defined with
11# the config value in an AWStats running session and can be used like others.
12#-----------------------------------------------------------------------------
13
14
15
16#-----------------------------------------------------------------------------
17# MAIN SETUP SECTION (Required to make AWStats work)
18#-----------------------------------------------------------------------------
19
20# "LogFile" contains the web, ftp or mail server log file to analyze.
21# Possible values: A full path, or a relative path from awstats.pl directory.
22# Example: "/var/log/apache/access.log"
23# Example: "../logs/mycombinedlog.log"
24# You can also use tags in this filename if you need a dynamic file name
25# depending on date or time (Replacement is made by AWStats at the beginning
26# of its execution). This is available tags :
27# %YYYY-n is replaced with 4 digits year we were n hours ago
28# %YY-n is replaced with 2 digits year we were n hours ago
29# %MM-n is replaced with 2 digits month we were n hours ago
30# %MO-n is replaced with 3 letters month we were n hours ago
31# %DD-n is replaced with day we were n hours ago
32# %HH-n is replaced with hour we were n hours ago
33# %NS-n is replaced with number of seconds at 00:00 since 1970
34# %WM-n is replaced with the week number in month (1-5)
35# %Wm-n is replaced with the week number in month (0-4)
36# %WY-n is replaced with the week number in year (01-52)
37# %Wy-n is replaced with the week number in year (00-51)
38# %DW-n is replaced with the day number in week (1-7, 1=sunday)
39# use n=24 if you need (1-7, 1=monday)
40# %Dw-n is replaced with the day number in week (0-6, 0=sunday)
41# use n=24 if you need (0-6, 0=monday)
42# Use 0 for n if you need current year, month, day, hour...
43# Example: "/var/log/access_log.%YYYY-0%MM-0%DD-0.log"
44# Example: "C:/WINNT/system32/LogFiles/W3SVC1/ex%YY-24%MM-24%DD-24.log"
45# You can also use a pipe if log file come from a pipe :
46# Example: "gzip -cd /var/log/apache/access.log.gz |"
47# If there are several log files from load balancing servers :
48# Example: "/pathtotools/logresolvemerge.pl *.log |"
49#
50LogFile=/var/log/virtualmin/giapjournals.com_access_log
51
52
53# Enter the log file type you want to analyze.
54# Possible values:
55# W - For a web log file
56# S - For a streaming log file
57# M - For a mail log file
58# F - For a ftp log file
59# Example: W
60# Default: W
61#
62LogType=W
63
64
65# Enter here your log format (Must match your web server config. See setup
66# instructions in documentation to know how to configure your web server to
67# have the required log format).
68# Possible values: 1,2,3,4 or "your_own_personalized_log_format"
69# 1 - Apache or Lotus Notes/Domino native combined log format (NCSA combined/XLF/ELF log format)
70# 2 - IIS or ISA format (IIS W3C log format). See FAQ-COM115 For ISA.
71# 3 - Webstar native log format.
72# 4 - Apache or Squid native common log format (NCSA common/CLF log format)
73# With LogFormat=4, some features (browsers, os, keywords...) can't work.
74# "your_own_personalized_log_format" = If your log is ftp, mail or other format,
75# you must use following keys to define the log format string (See FAQ for
76# ftp, mail or exotic web log format examples):
77# %host Client hostname or IP address (or Sender host for mail log)
78# %host_r Receiver hostname or IP address (for mail log)
79# %lognamequot Authenticated login/user with format: "john"
80# %logname Authenticated login/user with format: john
81# %time1 Date and time with format: [dd/mon/yyyy:hh:mm:ss +0000] or [dd/mon/yyyy:hh:mm:ss]
82# %time2 Date and time with format: yyyy-mm-dd hh:mm:ss
83# %time3 Date and time with format: Mon dd hh:mm:ss or Mon dd hh:mm:ss yyyy
84# %time4 Date and time with unix timestamp format: dddddddddd
85# %time5 Date and time with format iso: yyyy-mm-ddThh:mm:ss, with optional timezone specification (ignored)
86# %methodurl Method and URL with format: "GET /index.html HTTP/x.x"
87# %methodurlnoprot Method and URL with format: "GET /index.html"
88# %method Method with format: GET
89# %url URL only with format: /index.html
90# %query Query string (used by URLWithQuery option)
91# %code Return code status (with format for web log: 999)
92# %bytesd Size of document in bytes
93# %refererquot Referer page with format: "http://from.com/from.htm"
94# %referer Referer page with format: http://from.com/from.htm
95# %uabracket User agent with format: [Mozilla/4.0 (compatible, ...)]
96# %uaquot User agent with format: "Mozilla/4.0 (compatible, ...)"
97# %ua User agent with format: Mozilla/4.0_(compatible...)
98# %gzipin mod_gzip compression input bytes: In:XXX
99# %gzipout mod_gzip compression output bytes & ratio: Out:YYY:ZZpct.
100# %gzipratio mod_gzip compression ratio: ZZpct.
101# %deflateratio mod_deflate compression ratio with format: (ZZ)
102# %email EMail sender (for mail log)
103# %email_r EMail receiver (for mail log)
104# %virtualname Web sever virtual hostname. Use this tag when same log
105# contains data of several virtual web servers. AWStats
106# will discard records not in SiteDomain nor HostAliases
107# %cluster If log file is provided from several computers (merged by
108# logresolvemerge.pl), use this to define cluster id field.
109# %extraX Another field that you plan to use for building a
110# personalized report with ExtraSection feature (See later).
111# If your log format has some fields not included in this list, use:
112# %other Means another not used field
113# %otherquot Means another not used double quoted field
114# If your log format has some literal strings, which precede data fields, use
115# status=%code Means your log files have HTTP status logged as "status=200"
116# Literal strings that follow data field must be separated from said data fields by space.
117#
118# Examples for Apache combined logs (following two examples are equivalent):
119# LogFormat = 1
120# LogFormat = "%host %other %logname %time1 %methodurl %code %bytesd %refererquot %uaquot"
121
122#LogFormat = “%time1 client=%host method=%method request=%methodurl request_length=%bytesd status=%code bytes_sent=%other body_bytes_sent=%other referer=%referer user_agent=%uaquot upstream_addr=%other upstream_status=%code request_time=%other upstream_cache_status=%otherquot upstream_response_time=%other upstream_connect_time=%other upstream_header_time=%other”
123LogFormat = "%time1 client=%host method=%method request=%methodurl request_length=%bytesd status=%code bytes_sent=%other body_bytes_sent=%other referer=%referer user_agent=%uaquot upstream_addr=%other upstream_status=200 request_time=0.550 upstream_cache_status=%otherquot upstream_response_time=%other upstream_connect_time=%other upstream_header_time=%other"
124#upstream_response_time=0.548 upstream_connect_time=0.000 upstream_header_time=0.544
125#"12/Feb/2020:20:09:18 +0800" client=54.36.150.73 method=GET request="GET /index.php/ijsrtm/article/view/136 HTTP/2.0" request_length=117 status=200 bytes_sent=8007 body_bytes_sent=7749 referer=- user_agent="Mozilla/5.0 (compatible; AhrefsBot/6.1; +http://ahrefs.com/robot/)" upstream_addr=127.0.0.1:8009 upstream_status=200 request_time=0.550 upstream_cache_status="MISS" upstream_response_time=0.548 upstream_connect_time=0.000 upstream_header_time=0.544
126
127# Example for IIS:
128# LogFormat = 2
129#
130#LogFormat=1
131#LogFormat = "%host %other %other %time1 %methodurl %code %bytesd %refererquot %uaquot"
132
133
134# If your log field's separator is not a space, you can change this parameter.
135# This parameter is not used if LogFormat is a predefined value (1,2,3,4)
136# Backslash can be used as escape character.
137# Example: " "
138# Example: "\t"
139# Example: "\|"
140# Example: ","
141# Default: " "
142#
143LogSeparator=" "
144
145
146# "SiteDomain" must contain the main domain name, or the main intranet web
147# server name, used to reach the web site.
148# If you share the same log file for several virtual web servers, this
149# parameter is used to tell AWStats to filter record that contains records for
150# this virtual host name only (So check that this virtual hostname can be
151# found in your log file and use a personalized log format that include the
152# %virtualname tag).
153# But for multi hosting a better solution is to have one log file for each
154# virtual web server. In this case, this parameter is only used to generate
155# full URL's links when ShowLinksOnUrl option is set to 1.
156# If analyzing mail log, enter here the domain name of mail server.
157# Example: "myintranetserver"
158# Example: "www.domain.com"
159# Example: "ftp.domain.com"
160# Example: "domain.com"
161#
162SiteDomain="giapjournals.com"
163
164
165# Enter here all other possible domain names, addresses or virtual host
166# aliases someone can use to access your site. Try to keep only the minimum
167# number of possible names/addresses to have the best performances.
168# You can repeat the "SiteDomain" value in this list.
169# This parameter is used to analyze referer field in log file and to help
170# AWStats to know if a referer URL is a local URL of same site or an URL of
171# another site.
172# Note: Use space between each value.
173# Note: You can use regular expression values writing value with REGEX[value].
174# Note: You can also use @/mypath/myfile if list of aliases are in a file.
175# Example: "www.myserver.com localhost 127.0.0.1 REGEX[mydomain\.(net|org)$]"
176#
177HostAliases=REGEX[giapjournals\.com$]
178
179
180# If you want to have hosts reported by name instead of ip address, AWStats
181# need to make reverse DNS lookups (if not already done in your log file).
182# With DNSLookup to 0, all hosts will be reported by their IP addresses and
183# not by the full hostname of visitors (except if names are already available
184# in log file).
185# If you want/need to set DNSLookup to 1, don't forget that this will reduce
186# dramatically AWStats update process speed. Do not use on large web sites.
187# Note: Reverse DNS lookup is done on IPv4 only (Enable ipv6 plugin for IPv6).
188# Note: Result of DNS Lookup can be used to build the Country report. However
189# it is highly recommanded to enable the plugin 'geoip' or 'geoipfree' to
190# have an accurate Country report with no need of DNS Lookup.
191# Possible values:
192# 0 - No DNS Lookup
193# 1 - DNS Lookup is fully enabled
194# 2 - DNS Lookup is made only from static DNS cache file (if it exists)
195# Default: 2
196#
197DNSLookup=1
198
199
200# For very large sites, setting DNSLookup to 0 (or 2) might be the only
201# reasonable choice. DynamicDNSLookup allows to resolve host names for
202# items shown in html tables only, when data is output on reports instead
203# of resolving once during log analysis step.
204# Possible values:
205# 0 - No dynamic DNS lookup
206# 1 - Dynamic DNS lookup enabled
207# 2 - Dynamic DNS lookup enabled (including static DNS cache file as a second
208# source)
209# Default: 0
210#
211DynamicDNSLookup=0
212
213
214# When AWStats updates its statistics, it stores results of its analysis in
215# files (AWStats database). All those files are written in the directory
216# defined by the "DirData" parameter. Set this value to the directory where
217# you want AWStats to save its database and working files into.
218# Warning: If you want to be able to use the "AllowToUpdateStatsFromBrowser"
219# feature (see later), you need "Write" permissions by web server user on this
220# directory (and "Modify" for Windows NTFS file systems).
221# Example: "/var/lib/awstats"
222# Example: "../data"
223# Example: "C:/awstats_data_dir"
224# Default: "." (means same directory as awstats.pl)
225#
226DirData=/home/giapjournals/awstats
227
228
229# Relative or absolute web URL of your awstats cgi-bin directory.
230# This parameter is used only when AWStats is run from command line
231# with -output option (to generate links in HTML reported page).
232# Example: "/awstats"
233# Default: "/cgi-bin" (means awstats.pl is in "/yourwwwroot/cgi-bin")
234#
235DirCgi="/cgi-bin"
236
237
238# Relative or absolute web URL of your awstats icon directory.
239# If you build static reports ("... -output > outputpath/output.html"), enter
240# path of icon directory relative to the output directory 'outputpath'.
241# Example: "/awstatsicons"
242# Example: "../icon"
243# Default: "/icon" (means you must copy icon directories in "/mywwwroot/icon")
244#
245DirIcons="/awstats-icon"
246
247
248# When this parameter is set to 1, AWStats adds a button on report page to
249# allow to "update" statistics from a web browser. Warning, when "update" is
250# made from a browser, AWStats is run as a CGI by the web server user defined
251# in your web server (user "nobody" by default with Apache, "IUSR_XXX" with
252# IIS), so the "DirData" directory and all already existing history files
253# awstatsMMYYYY[.xxx].txt must be writable by this user. Change permissions if
254# necessary to "Read/Write" (and "Modify" for Windows NTFS file systems).
255# Warning: Update process can be long so you might experience "time out"
256# browser errors if you don't launch AWStats frequently enough.
257# When set to 0, update is only made when AWStats is run from the command
258# line interface (or a task scheduler).
259# Possible values: 0 or 1
260# Default: 0
261#
262AllowToUpdateStatsFromBrowser=0
263
264
265# AWStats saves and sorts its database on a month basis (except if using
266# databasebreak option from command line).
267# However, if you choose the -month=all from command line or
268# value '-Year-' from CGI combo form to have a report for all year, AWStats
269# needs to reload all data for full year (each month), and sort them,
270# requiring a large amount of time, memory and CPU. This might be a problem
271# for web hosting providers that offer AWStats for large sites, on shared
272# servers, to non CPU cautious customers.
273# For this reason, the 'full year' is only enabled on Command Line by default.
274# You can change this by setting this parameter to 0, 1, 2 or 3.
275# Possible values:
276# 0 - Never allowed
277# 1 - Allowed on CLI only, -Year- value in combo is not visible
278# 2 - Allowed on CLI only, -Year- value in combo is visible but not allowed
279# 3 - Possible on CLI and CGI
280# Default: 2
281#
282AllowFullYearView=2
283
284
285
286#-----------------------------------------------------------------------------
287# OPTIONAL SETUP SECTION (Not required but enhances AWStats's functionality)
288#-----------------------------------------------------------------------------
289
290# When the update process runs, AWStats can set a lock file in TEMP or TMP
291# directory. This lock is to avoid to have 2 update processes running at the
292# same time to prevent unknown conflicts problems and avoid DoS attacks when
293# AllowToUpdateStatsFromBrowser is set to 1.
294# Because, when you use lock file, you can experience sometimes problems in
295# lock file not correctly removed (killed process for example requires that
296# you remove the file manualy), this option is not enabled by default (Do
297# not enable this option with no console server access).
298# Change : Effective immediately
299# Possible values: 0 or 1
300# Default: 0
301#
302EnableLockForUpdate=0
303
304
305# AWStats can do reverse DNS lookups through a static DNS cache file that was
306# previously created manually. If no path is given in static DNS cache file
307# name, AWStats will search DirData directory. This file is never changed.
308# This option is not used if DNSLookup=0.
309# Note: DNS cache file format is 'minsince1970 ipaddress resolved_hostname'
310# or just 'ipaddress resolved_hostname'
311# Change : Effective for new updates only
312# Example: "/mydnscachedir/dnscache"
313# Default: "dnscache.txt"
314#
315DNSStaticCacheFile="dnscache.txt"
316
317
318# AWStats can do reverse DNS lookups through a DNS cache file that was created
319# by a previous run of AWStats. This file is erased and recreated after each
320# statistics update process. You don't need to create and/or edit it.
321# AWStats will read and save this file in DirData directory.
322# This option is used only if DNSLookup=1.
323# Note: If a DNSStaticCacheFile is available, AWStats will check for DNS
324# lookup in DNSLastUpdateCacheFile after checking into DNSStaticCacheFile.
325# Change : Effective for new updates only
326# Example: "/mydnscachedir/dnscachelastupdate"
327# Default: "dnscachelastupdate.txt"
328#
329DNSLastUpdateCacheFile="dnscachelastupdate.txt"
330
331
332# You can specify specific IP addresses that should NOT be looked up in DNS.
333# This option is used only if DNSLookup=1.
334# Note: Use space between each value.
335# Note: You can use regular expression values writing value with REGEX[value].
336# Change : Effective for new updates only
337# Example: "123.123.123.123 REGEX[^192\.168\.]"
338# Default: ""
339#
340SkipDNSLookupFor=""
341
342
343# The following two parameters allow you to protect a config file from being
344# read by AWStats when called from a browser if the web user has not been
345# authenticated. Your AWStats program must be in a web protected "realm" (With
346# Apache, you can use .htaccess files to do so. With other web servers, see
347# your server setup manual).
348# Change : Effective immediately
349# Possible values: 0 or 1
350# Default: 0
351#
352AllowAccessFromWebToAuthenticatedUsersOnly=0
353
354
355# This parameter gives the list of all authorized authenticated users to view
356# statistics for this domain/config file. This parameter is used only if
357# AllowAccessFromWebToAuthenticatedUsersOnly is set to 1.
358# Change : Effective immediately
359# Example: "user1 user2"
360# Example: "__REMOTE_USER__"
361# Default: ""
362#
363AllowAccessFromWebToFollowingAuthenticatedUsers=""
364
365
366# When this parameter is defined to something, the IP address of the user that
367# reads its statistics from a browser (when AWStats is used as a CGI) is
368# checked and must match one of the IP address values or ranges.
369# Change : Effective immediately
370# Example: "127.0.0.1 123.123.123.1-123.123.123.255"
371# Default: ""
372#
373AllowAccessFromWebToFollowingIPAddresses=""
374
375
376# If the "DirData" directory (see above) does not exist, AWStats return an
377# error. However, you can ask AWStats to create it.
378# This option can be used by some Web Hosting Providers that has defined a
379# dynamic value for DirData (for example DirData="/home/__REMOTE_USER__") and
380# don't want to have to create a new directory each time they add a new user.
381# Change : Effective immediately
382# Possible values: 0 or 1
383# Default: 0
384#
385CreateDirDataIfNotExists=0
386
387
388# You can choose in which format the Awstats history database is saved.
389# Note: Using "xml" format make AWStats building database files three times
390# larger than using "text" format.
391# Change : Database format is switched after next update
392# Possible values: text or xml
393# Default: text
394#
395BuildHistoryFormat=text
396
397
398# If you prefer having the report output pages be built as XML compliant pages
399# instead of simple HTML pages, you can set this to 'xhtml' (May not work
400# properly with old browsers).
401# Change : Effective immediately
402# Possible values: html or xhtml
403# Default: html
404#
405BuildReportFormat=html
406
407
408# AWStats databases can be updated from command line of from a browser (when
409# used as a cgi program). So AWStats database files need write permission
410# for both command line user and default web server user (nobody for Unix,
411# IUSR_xxx for IIS/Windows,...).
412# To avoid permission problems between update process (run by an admin user)
413# and CGI process (ran by a low level user), AWStats can save its database
414# files with read and write permissions for everyone.
415# By default, AWStats keeps default user permissions on updated files. If you
416# set AllowToUpdateStatsFromBrowser to 1, you can change this parameter to 1.
417# Change : Effective for new updates only
418# Possible values: 0 or 1
419# Default: 0
420#
421SaveDatabaseFilesWithPermissionsForEveryone=0
422
423
424# AWStats can purge log file, after analyzing it. Note that AWStats is able
425# to detect new lines in a log file, to process only them, so you can launch
426# AWStats as often as you want, even with this parameter to 0.
427# With 0, no purge is made, so you must use a scheduled task or a web server
428# that make this purge frequently.
429# With 1, the purge of the log file is made each time AWStats update is run.
430# This parameter doesn't work with IIS (This web server doesn't let its log
431# file to be purged).
432# Change : Effective for new updates only
433# Possible values: 0 or 1
434# Default: 0
435#
436PurgeLogFile=0
437
438
439# When PurgeLogFile is setup to 1, AWStats will clean your log file after
440# processing it. You can however keep an archive file of all processed log
441# records by setting this parameter (For example if you want to use another
442# log analyzer). The archived log file is saved in "DirData" with name
443# awstats_archive.configname[.suffix].log
444# This parameter is not used if PurgeLogFile=0
445# Change : Effective for new updates only
446# Possible values: 0, 1, or tags (See LogFile parameter) for suffix
447# Example: 1
448# Example: %YYYY%MM%DD
449# Default: 0
450#
451ArchiveLogRecords=0
452
453
454# Each time you run the update process, AWStats overwrites the 'historic file'
455# for the month (awstatsMMYYYY[.*].txt) with the updated one.
456# When write errors occurs (IO, disk full,...), this historic file can be
457# corrupted and must be deleted. Because this file contains information of all
458# past processed log files, you will loose old stats if removed. So you can
459# ask AWStats to save last non corrupted file in a .bak file. This file is
460# stored in "DirData" directory with other 'historic files'.
461# Change : Effective for new updates only
462# Possible values: 0 or 1
463# Default: 0
464#
465KeepBackupOfHistoricFiles=0
466
467
468# Default index page name for your web server.
469# Change : Effective for new updates only
470# Example: "index.php index.html default.html"
471# Default: "index.php index.html"
472#
473DefaultFile="index.php index.html"
474
475
476# Do not include access from clients that match following criteria.
477# If your log file contains IP addresses in host field, you must enter here
478# matching IP addresses criteria.
479# If DNS lookup is already done in your log file, you must enter here hostname
480# criteria, else enter ip address criteria.
481# The opposite parameter of "SkipHosts" is "OnlyHosts".
482# Note: Use space between each value. This parameter is not case sensitive.
483# Note: You can use regular expression values writing value with REGEX[value].
484# Change : Effective for new updates only
485# Example: "127.0.0.1 REGEX[^192\.168\.] REGEX[^10\.]"
486# Example: "localhost REGEX[^.*\.localdomain$]"
487# Default: ""
488#
489
490
491# Do not include access from clients with a user agent that match following
492# criteria. If you want to exclude a robot, you should update the robots.pm
493# file instead of this parameter.
494# The opposite parameter of "SkipUserAgents" is "OnlyUserAgents".
495# Note: Use space between each value. This parameter is not case sensitive.
496# Note: You can use regular expression values writing value with REGEX[value].
497# Change : Effective for new updates only
498# Example: "konqueror REGEX[ua_test_v\d\.\d]"
499# Default: ""
500#
501
502
503# Use SkipFiles to ignore access to URLs that match one of following entries.
504# You can enter a list of not important URLs (like framed menus, hidden pages,
505# etc...) to exclude them from statistics. You must enter here exact relative
506# URL as found in log file, or a matching REGEX value. Check apply on URL with
507# all its query paramaters.
508# For example, to ignore /badpage.php, just add "/badpage.php". To ignore all
509# pages in a particular directory, add "REGEX[^\/directorytoexclude]".
510# The opposite parameter of "SkipFiles" is "OnlyFiles".
511# Note: Use space between each value. This parameter is or not case sensitive
512# depending on URLNotCaseSensitive parameter.
513# Note: You can use regular expression values writing value with REGEX[value].
514# Change : Effective for new updates only
515# Example: "/badpage.php /page.php?param=x REGEX[^\/excludedirectory]"
516# Default: ""
517#
518
519
520# Use SkipReferrersBlackList if you want to exclude records coming from a SPAM
521# referrer. Parameter must receive a local file name containing rules applied
522# on referrer field. If parameter is empty, no filter is applied.
523# An example of such a file is available in lib/blacklist.txt
524# Change : Effective for new updates only
525# Example: "/mylibpath/blacklist.txt"
526# Default: ""
527#
528# WARNING!! Using this feature make AWStats running very slower (5 times slower
529# with black list file provided with AWStats !
530#
531SkipReferrersBlackList=""
532
533
534# Include in stats, only accesses from hosts that match one of following
535# entries. For example, if you want AWStats to filter access to keep only
536# stats for visits from particular hosts, you can add those host names in
537# this parameter.
538# If DNS lookup is already done in your log file, you must enter here hostname
539# criteria, else enter ip address criteria.
540# The opposite parameter of "OnlyHosts" is "SkipHosts".
541# Note: Use space between each value. This parameter is not case sensitive.
542# Note: You can use regular expression values writing value with REGEX[value].
543# Change : Effective for new updates only
544# Example: "127.0.0.1 REGEX[^192\.168\.] REGEX[^10\.]"
545# Default: ""
546#
547OnlyHosts=""
548
549
550# Include in stats, only accesses from user agent that match one of following
551# entries. For example, if you want AWStats to filter access to keep only
552# stats for visits from particular browsers, you can add their user agents
553# string in this parameter.
554# The opposite parameter of "OnlyUserAgents" is "SkipUserAgents".
555# Note: Use space between each value. This parameter is not case sensitive.
556# Note: You can use regular expression values writing value with REGEX[value].
557# Change : Effective for new updates only
558# Example: "msie"
559# Default: ""
560#
561OnlyUserAgents=""
562
563
564# Include in stats, only accesses from authenticated users that match one of
565# following entries. For example, if you want AWStats to filter access to keep
566# only stats for authenticated users, you can add those users names in
567# this parameter. Useful for statistics for per user ftp logs.
568# Note: Use space between each value. This parameter is not case sensitive.
569# Note: You can use regular expression values writing value with REGEX[value].
570# Change : Effective for new updates only
571# Example: "john bob REGEX[^testusers]"
572# Default: ""
573#
574OnlyUsers=""
575
576
577# Include in stats, only accesses to URLs that match one of following entries.
578# For example, if you want AWStats to filter access to keep only stats that
579# match a particular string, like a particular directory, you can add this
580# directory name in this parameter.
581# The opposite parameter of "OnlyFiles" is "SkipFiles".
582# Note: Use space between each value. This parameter is or not case sensitive
583# depending on URLNotCaseSensitive parameter.
584# Note: You can use regular expression values writing value with REGEX[value].
585# Change : Effective for new updates only
586# Example: "REGEX[marketing_directory] REGEX[office\/.*\.(csv|sxw)$]"
587# Default: ""
588#
589OnlyFiles=""
590
591
592# Add here a list of kind of url (file extension) that must be counted as
593# "Hit only" and not as a "Hit" and "Page/Download". You can set here all
594# image extensions as they are hit downloaded that must be counted but they
595# are not viewed pages. URLs with such extensions are not included in the TOP
596# Pages/URL report.
597# Note: If you want to exclude particular URLs from stats (No Pages and no
598# Hits reported), you must use SkipFiles parameter.
599# Change : Effective for new updates only
600# Example: "css js class gif jpg jpeg png bmp ico rss xml swf zip arj rar gz z bz2 wav mp3 wma mpg avi"
601# Example: ""
602# Default: "css js class gif jpg jpeg png bmp ico rss xml swf eot woff woff2"
603#
604NotPageList="css js class gif jpg jpeg png bmp ico rss xml swf eot woff woff2"
605
606
607# By default, AWStats considers that records found in web log file are
608# successful hits if HTTP code returned by server is a valid HTTP code (200
609# and 304). Any other code are reported in HTTP status chart.
610# Note that HTTP 'control codes', like redirection (302, 305) are not added by
611# default in this list as they are not pages seen by a visitor but are
612# protocol exchange codes to tell the browser to ask another page. Because
613# this other page will be counted and seen with a 200 or 304 code, if you
614# add such codes, you will have 2 pages viewed reported for only one in facts.
615# Change : Effective for new updates only
616# Example: "200 304 302 305"
617# Default: "200 304"
618#
619ValidHTTPCodes="200 304"
620
621
622# By default, AWStats considers that records found in mail log file are
623# successful mail transfers if field that represent return code in analyzed
624# log file match values defined by this parameter.
625# Change : Effective for new updates only
626# Example: "1 250 200"
627# Default: "1 250"
628#
629ValidSMTPCodes="1 250"
630
631
632# By default, AWStats only records info on 404 'Document Not Found' errors.
633# At the cost of additional processing time, further info pages can be made
634# available by adding codes below.
635# Change : Effective for new updates only
636# Example: "403 404"
637# Default: "404"
638#
639TrapInfosForHTTPErrorCodes = "400 403 404"
640
641
642# Some web servers on some Operating systems (IIS-Windows) consider that a
643# login with same value but different case are the same login. To tell AWStats
644# to also consider them as one, set this parameter to 1.
645# Change : Effective for new updates only
646# Possible values: 0 or 1
647# Default: 0
648#
649AuthenticatedUsersNotCaseSensitive=0
650
651
652# Some web servers on some Operating systems (IIS-Windows) considers that two
653# URLs with same value but different case are the same URL. To tell AWStats to
654# also considers them as one, set this parameter to 1.
655# Change : Effective for new updates only
656# Possible values: 0 or 1
657# Default: 0
658#
659URLNotCaseSensitive=0
660
661
662# Keep or remove the anchor string you can find in some URLs.
663# Change : Effective for new updates only
664# Possible values: 0 or 1
665# Default: 0
666#
667URLWithAnchor=0
668
669
670# In URL links, "?" char is used to add parameter's list in URLs. Syntax is:
671# /mypage.html?param1=value1¶m2=value2
672# However, some servers/sites use also other chars to isolate dynamic part of
673# their URLs. You can complete this list with all such characters.
674# Change : Effective for new updates only
675# Example: "?;,"
676# Default: "?;"
677#
678URLQuerySeparators="?;"
679
680
681# Keep or remove the query string to the URL in the statistics for individual
682# pages. This is primarily used to differentiate between the URLs of dynamic
683# pages. If set to 1, mypage.html?id=x and mypage.html?id=y are counted as two
684# different pages.
685# Warning, when set to 1, memory required to run AWStats is dramatically
686# increased if you have a lot of changing URLs (for example URLs with a random
687# id inside). Such web sites should not set this option to 1 or use seriously
688# the next parameter URLWithQueryWithOnlyFollowingParameters (or eventually
689# URLWithQueryWithoutFollowingParameters).
690# Change : Effective for new updates only
691# Possible values:
692# 0 - URLs are cleaned from the query string (ie: "/mypage.html")
693# 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y")
694# Default: 0
695#
696URLWithQuery=0
697
698
699# When URLWithQuery is on, you will get the full URL with all parameters in
700# URL reports. But among thoose parameters, sometimes you don't need a
701# particular parameter because it does not identify the page or because it's
702# a random ID changing for each access even if URL points to same page. In
703# such cases, it is higly recommanded to ask AWStats to keep only parameters
704# you need (if you know them) before counting, manipulating and storing URL.
705# Enter here list of wanted parameters. For example, with "param", one hit on
706# /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r
707# will be reported as 2 hits on /mypage.cgi?param=abc
708# This parameter is not used when URLWithQuery is 0 and can't be used with
709# URLWithQueryWithoutFollowingParameters.
710# Change : Effective for new updates only
711# Example: "param"
712# Default: ""
713#
714URLWithQueryWithOnlyFollowingParameters=""
715
716
717# When URLWithQuery is on, you will get the full URL with all parameters in
718# URL reports. But among thoose parameters, sometimes you don't need a
719# particular parameter because it does not identify the page or because it's
720# a random ID changing for each access even if URL points to same page. In
721# such cases, it is higly recommanded to ask AWStats to remove such parameters
722# from the URL before counting, manipulating and storing URL. Enter here list
723# of all non wanted parameters. For example if you enter "id", one hit on
724# /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r
725# will be reported as 2 hits on /mypage.cgi?param=abc
726# This parameter is not used when URLWithQuery is 0 and can't be used with
727# URLWithQueryWithOnlyFollowingParameters.
728# Change : Effective for new updates only
729# Example: "PHPSESSID jsessionid"
730# Default: ""
731#
732URLWithQueryWithoutFollowingParameters=""
733
734
735# Keep or remove the query string to the referrer URL in the statistics for
736# external referrer pages. This is used to differentiate between the URLs of
737# dynamic referrer pages. If set to 1, mypage.html?id=x and mypage.html?id=y
738# are counted as two different referrer pages.
739# Change : Effective for new updates only
740# Possible values:
741# 0 - Referrer URLs are cleaned from the query string (ie: "/mypage.html")
742# 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y")
743# Default: 0
744#
745URLReferrerWithQuery=0
746
747
748# AWStats can detect setup problems or show you important informations to have
749# a better use. Keep this to 1, except if AWStats says you can change it.
750# Change : Effective immediately
751# Possible values: 0 or 1
752# Default: 1
753#
754WarningMessages=1
755
756
757# When an error occurs, AWStats outputs a message related to errors. If you
758# want (in most cases for security reasons) to have no error messages, you
759# can set this parameter to your personalized generic message.
760# Change : Effective immediately
761# Example: "An error occurred. Contact your Administrator"
762# Default: ""
763#
764ErrorMessages=""
765
766
767# AWStat can be run with debug=x parameter to output various informations
768# to help in debugging or solving troubles. If you want to allow this (not
769# enabled by default for security reasons), set this parameter to 0.
770# Change : Effective immediately
771# Possible values: 0 or 1
772# Default: 0
773#
774DebugMessages=0
775
776
777# To help you to detect if your log format is good, AWStats reports an error
778# if all the first NbOfLinesForCorruptedLog lines have a format that does not
779# match the LogFormat parameter.
780# However, some worm virus attack on your web server can result in a very high
781# number of corrupted lines in your log. So if you experience awstats stop
782# because of bad virus records at the beginning of your log file, you can
783# increase this parameter (very rare).
784# Change : Effective for new updates only
785# Default: 50
786#
787NbOfLinesForCorruptedLog=50
788
789
790# For some particular integration needs, you may want to have CGI links to
791# point to another script than awstats.pl.
792# Use the name of this script in WrapperScript parameter.
793# Change : Effective immediately
794# Example: "awstatslauncher.pl"
795# Example: "awstatswrapper.cgi?key=123"
796# Default: ""
797#
798WrapperScript=""
799
800
801# DecodeUA must be set to 1 if you use Roxen web server. This server converts
802# all spaces in user agent field into %20. This make the AWStats robots, OS
803# and browsers detection fail in some cases. Just change it to 1 if and only
804# if your web server is Roxen.
805# Change : Effective for new updates only
806# Possible values: 0 or 1
807# Default: 0
808#
809DecodeUA=0
810
811
812# MiscTrackerUrl can be used to make AWStats able to detect some miscellaneous
813# things, that can not be tracked on other way, like:
814# - Javascript disabled
815# - Java enabled
816# - Screen size
817# - Color depth
818# - Macromedia Director plugin
819# - Macromedia Shockwave plugin
820# - Realplayer G2 plugin
821# - QuickTime plugin
822# - Mediaplayer plugin
823# - Acrobat PDF plugin
824# To enable all these features, you must copy the awstats_misc_tracker.js file
825# into a /js/ directory stored in your web document root and add the following
826# HTML code at the end of your index page (but before </BODY>) :
827#
828# <script type="text/javascript" src="/js/awstats_misc_tracker.js"></script>
829# <noscript><img src="/js/awstats_misc_tracker.js?nojs=y" height=0 width=0 border=0 style="display: none"></noscript>
830#
831# If code is not added in index page, all those detection capabilities will be
832# disabled. You must also check that ShowScreenSizeStats and ShowMiscStats
833# parameters are set to 1 to make results appear in AWStats report page.
834# If you want to use another directory than /js/, you must also change the
835# awstatsmisctrackerurl variable into the awstats_misc_tracker.js file.
836# Change : Effective for new updates only.
837# Possible value: URL of javascript tracker file added in your HTML code.
838# Default: "/js/awstats_misc_tracker.js"
839#
840MiscTrackerUrl="/js/awstats_misc_tracker.js"
841
842
843# AddLinkToExternalCGIWrapper can be used to add a link to a wrapper script
844# into each title of Dolibarr reports. This can be used to add a wrapper
845# to download data into a CSV file for example.
846#
847# AddLinkToExternalCGIWrapper="/awstats/awdownloadcsv.pl"
848
849
850
851#-----------------------------------------------------------------------------
852# OPTIONAL ACCURACY SETUP SECTION (Not required but increase AWStats features)
853#-----------------------------------------------------------------------------
854
855# The following values allow you to define accuracy of AWStats entities
856# (robots, browsers, os, referers, file types) detection.
857# It might be a good idea for large web sites or ISP that provides AWStats to
858# high number of customers, to set this parameter to 1 (or 0), instead of 2.
859# Possible values:
860# 0 = No detection,
861# 1 = Medium/Standard detection
862# 2 = Full detection
863# Change : Effective for new updates only
864# Note : LevelForBrowsersDetection can also accept value "allphones". This
865# enable detailed detection of phone/pda browsers.
866# Default: 2 (0 for LevelForWormsDetection)
867#
868LevelForBrowsersDetection=2
869 # 2 reduces AWStats speed by 2%
870 # allphones reduces AWStats speed by 5%
871LevelForOSDetection=2
872 # 2 reduces AWStats speed by 3%
873LevelForRefererAnalyze=2
874 # 2 reduces AWStats speed by 14%
875LevelForRobotsDetection=2
876 # 2 reduces AWStats speed by 2.5%
877LevelForSearchEnginesDetection=2 # 0 disables Search engines detection.
878 # 2 reduces AWStats speed by 9%
879LevelForKeywordsDetection=2 # 0 disables Keyphrases/Keywords detection.
880 # 2 reduces AWStats speed by 1%
881LevelForFileTypesDetection=2 # 0 disables File types detection.
882 # 2 reduces AWStats speed by 1%
883LevelForWormsDetection=0 # 0 disables Worms detection.
884 # 2 reduces AWStats speed by 15%
885
886
887
888#-----------------------------------------------------------------------------
889# OPTIONAL APPEARANCE SETUP SECTION (Not required but increase AWStats features)
890#-----------------------------------------------------------------------------
891
892# When you use AWStats as a CGI, you can have the reports shown in HTML frames.
893# Frames are only available for report viewed dynamically. When you build
894# pages from command line, this option is not used and no frames are built.
895# Possible values: 0 or 1
896# Default: 1
897#
898UseFramesWhenCGI=
899
900
901# This parameter asks your browser to open detailed reports into a different
902# window than the main page.
903# Possible values:
904# 0 - Open all in same browser window
905# 1 - Open detailed reports in another window except if using frames
906# 2 - Open always in a different window even if reports are framed
907# Default: 1
908#
909DetailedReportsOnNewWindows=1
910
911
912# You can add, in the HTML report page, a cache lifetime (in seconds) that
913# will be returned to the browser in HTTP header answer by server.
914# This parameter is not used when reports are built with -staticlinks option.
915# Example: 3600
916# Default: 0
917#
918Expires=0
919
920
921# To avoid too large web pages, you can ask AWStats to limit number of rows of
922# all reported charts to this number when no other limits apply.
923# Default: 10000
924#
925MaxRowsInHTMLOutput=10000
926
927
928# Set your primary language (ISO-639-1 language codes).
929# Possible values:
930# Albanian=al, Bosnian=ba, Bulgarian=bg, Catalan=ca,
931# Chinese (Taiwan)=tw, Chinese (Simpliefied)=cn, Croatian=hr, Czech=cz,
932# Danish=dk, Dutch=nl, English=en, Estonian=et, Euskara=eu, Finnish=fi,
933# French=fr, Galician=gl, German=de, Greek=gr, Hebrew=he, Hungarian=hu,
934# Icelandic=is, Indonesian=id, Italian=it, Japanese=jp, Korean=ko,
935# Latvian=lv, Norwegian (Nynorsk)=nn, Norwegian (Bokmal)=nb, Polish=pl,
936# Portuguese=pt, Portuguese (Brazilian)=br, Romanian=ro, Russian=ru,
937# Serbian=sr, Slovak=sk, Slovenian=si, Spanish=es, Swedish=se, Turkish=tr,
938# Ukrainian=ua, Welsh=cy.
939# First available language accepted by browser=auto
940# Default: "auto"
941#
942Lang="auto"
943
944
945# Set the location of language files.
946# Example: "/usr/share/awstats/lang"
947# Default: "./lang" (means lang directory is in same location than awstats.pl)
948#
949DirLang="/usr/share/awstats/lang"
950
951
952# Show menu header with reports' links
953# Possible values: 0 or 1
954# Default: 1
955#
956ShowMenu=1
957
958
959# You choose here which reports you want to see in the main page and what you
960# want to see in those reports.
961# Possible values:
962# 0 - Report is not shown at all
963# 1 - Report is shown in main page with an entry in menu and default columns
964# XYZ - Report shows column informations defined by code X,Y,Z...
965# X,Y,Z... are code letters among the following:
966# U = Unique visitors
967# V = Visits
968# P = Number of pages
969# H = Number of hits (or mails)
970# B = Bandwidth (or total mail size for mail logs)
971# L = Last access date
972# E = Entry pages
973# X = Exit pages
974# C = Web compression (mod_gzip,mod_deflate)
975# M = Average mail size (mail logs)
976#
977
978# Show monthly summary
979# Context: Web, Streaming, Mail, Ftp
980# Default: UVPHB, Possible column codes: UVPHB
981ShowSummary=UVPHB
982
983# Show monthly chart
984# Context: Web, Streaming, Mail, Ftp
985# Default: UVPHB, Possible column codes: UVPHB
986ShowMonthStats=UVPHB
987
988# Show days of month chart
989# Context: Web, Streaming, Mail, Ftp
990# Default: VPHB, Possible column codes: VPHB
991ShowDaysOfMonthStats=VPHB
992
993# Show days of week chart
994# Context: Web, Streaming, Mail, Ftp
995# Default: PHB, Possible column codes: PHB
996ShowDaysOfWeekStats=PHB
997
998# Show hourly chart
999# Context: Web, Streaming, Mail, Ftp
1000# Default: PHB, Possible column codes: PHB
1001ShowHoursStats=PHB
1002
1003# Show domains/country chart
1004# Context: Web, Streaming, Mail, Ftp
1005# Default: PHB, Possible column codes: UVPHB
1006ShowDomainsStats=PHB
1007
1008# Show hosts chart
1009# Context: Web, Streaming, Mail, Ftp
1010# Default: PHBL, Possible column codes: PHBL
1011ShowHostsStats=PHBL
1012
1013# Show authenticated users chart
1014# Context: Web, Streaming, Ftp
1015# Default: 0, Possible column codes: PHBL
1016ShowAuthenticatedUsers=0
1017
1018# Show robots chart
1019# Context: Web, Streaming
1020# Default: HBL, Possible column codes: HBL
1021ShowRobotsStats=HBL
1022
1023# Show worms chart
1024# Context: Web, Streaming
1025# Default: 0 (If set to other than 0, see also LevelForWormsDetection), Possible column codes: HBL
1026ShowWormsStats=0
1027
1028# Show email senders chart (For use when analyzing mail log files)
1029# Context: Mail
1030# Default: 0, Possible column codes: HBML
1031ShowEMailSenders=0
1032
1033# Show email receivers chart (For use when analyzing mail log files)
1034# Context: Mail
1035# Default: 0, Possible column codes: HBML
1036ShowEMailReceivers=0
1037
1038# Show session chart
1039# Context: Web, Streaming, Ftp
1040# Default: 1, Possible column codes: None
1041ShowSessionsStats=1
1042
1043# Show pages-url chart.
1044# Context: Web, Streaming, Ftp
1045# Default: PBEX, Possible column codes: PBEX
1046ShowPagesStats=PBEX
1047
1048# Show file types chart.
1049# Context: Web, Streaming, Ftp
1050# Default: HB, Possible column codes: HBC
1051ShowFileTypesStats=HB
1052
1053# Show file size chart (Not yet available)
1054# Context: Web, Streaming, Mail, Ftp
1055# Default: 1, Possible column codes: None
1056ShowFileSizesStats=0
1057
1058# Show downloads chart.
1059# Context: Web, Streaming, Ftp
1060# Default: HB, Possible column codes: HB
1061ShowDownloadsStats=HB
1062
1063# Show operating systems chart
1064# Context: Web, Streaming, Ftp
1065# Default: 1, Possible column codes: None
1066ShowOSStats=1
1067
1068# Show browsers chart
1069# Context: Web, Streaming
1070# Default: 1, Possible column codes: None
1071ShowBrowsersStats=1
1072
1073# Show screen size chart
1074# Context: Web, Streaming
1075# Default: 0 (If set to 1, see also MiscTrackerUrl), Possible column codes: None
1076ShowScreenSizeStats=0
1077
1078# Show origin chart
1079# Context: Web, Streaming
1080# Default: PH, Possible column codes: PH
1081ShowOriginStats=PH
1082
1083# Show keyphrases chart
1084# Context: Web, Streaming
1085# Default: 1, Possible column codes: None
1086ShowKeyphrasesStats=1
1087
1088# Show keywords chart
1089# Context: Web, Streaming
1090# Default: 1, Possible column codes: None
1091ShowKeywordsStats=1
1092
1093# Show misc chart
1094# Context: Web, Streaming
1095# Default: a (See also MiscTrackerUrl parameter), Possible column codes: anjdfrqwp
1096ShowMiscStats=a
1097
1098# Show http errors chart
1099# Context: Web, Streaming
1100# Default: 1, Possible column codes: None
1101ShowHTTPErrorsStats=1
1102
1103# Show http error page details
1104# Context: Web, Streaming
1105# Default: R, Possible column codes: RH
1106ShowHTTPErrorsPageDetail=R
1107
1108# Show smtp errors chart (For use when analyzing mail log files)
1109# Context: Mail
1110# Default: 0, Possible column codes: None
1111ShowSMTPErrorsStats=0
1112
1113# Show the cluster report (Your LogFormat must contains the %cluster tag)
1114# Context: Web, Streaming, Ftp
1115# Default: 0, Possible column codes: PHB
1116ShowClusterStats=0
1117
1118
1119# Some graphical reports are followed by the data array of values.
1120# If you don't want this array (to reduce the report size for example), you
1121# can set thoose options to 0.
1122# Possible values: 0 or 1
1123# Default: 1
1124#
1125# Data array values for the ShowMonthStats report
1126AddDataArrayMonthStats=1
1127# Data array values for the ShowDaysOfMonthStats report
1128AddDataArrayShowDaysOfMonthStats=1
1129# Data array values for the ShowDaysOfWeekStats report
1130AddDataArrayShowDaysOfWeekStats=1
1131# Data array values for the ShowHoursStats report
1132AddDataArrayShowHoursStats=1
1133
1134
1135# In the Origin chart, you have stats on where your hits came from. You can
1136# include hits on pages that come from pages of same sites in this chart.
1137# Possible values: 0 or 1
1138# Default: 0
1139#
1140IncludeInternalLinksInOriginSection=0
1141
1142
1143# The following parameters can be used to choose the maximum number of lines
1144# shown for the particular following reports.
1145#
1146# Stats by countries/domains
1147MaxNbOfDomain = 10
1148MinHitDomain = 1
1149# Stats by hosts
1150MaxNbOfHostsShown = 10
1151MinHitHost = 1
1152# Stats by authenticated users
1153MaxNbOfLoginShown = 10
1154MinHitLogin = 1
1155# Stats by robots
1156MaxNbOfRobotShown = 10
1157MinHitRobot = 1
1158# Stats for Downloads
1159MaxNbOfDownloadsShown = 10
1160MinHitDownloads = 1
1161# Stats by pages
1162MaxNbOfPageShown = 10
1163MinHitFile = 1
1164# Stats by OS
1165MaxNbOfOsShown = 10
1166MinHitOs = 1
1167# Stats by browsers
1168MaxNbOfBrowsersShown = 10
1169MinHitBrowser = 1
1170# Stats by screen size
1171MaxNbOfScreenSizesShown = 5
1172MinHitScreenSize = 1
1173# Stats by window size (following 2 parameters are not yet used)
1174MaxNbOfWindowSizesShown = 5
1175MinHitWindowSize = 1
1176# Stats by referers
1177MaxNbOfRefererShown = 10
1178MinHitRefer = 1
1179# Stats for keyphrases
1180MaxNbOfKeyphrasesShown = 10
1181MinHitKeyphrase = 1
1182# Stats for keywords
1183MaxNbOfKeywordsShown = 10
1184MinHitKeyword = 1
1185# Stats for sender or receiver emails
1186MaxNbOfEMailsShown = 20
1187MinHitEMail = 1
1188
1189
1190# Choose if you want the week report to start on sunday or monday
1191# Possible values:
1192# 0 - Week starts on sunday
1193# 1 - Week starts on monday
1194# Default: 1
1195#
1196FirstDayOfWeek=1
1197
1198
1199# List of visible flags that link to other language translations.
1200# See Lang parameter for list of allowed flag/language codes.
1201# If you don't want any flag link, set ShowFlagLinks to "".
1202# This parameter is used only if ShowMenu parameter is set to 1.
1203# Possible values: "" or "language_codes_separated_by_space"
1204# Example: "en es fr nl de"
1205# Default: ""
1206#
1207ShowFlagLinks=""
1208
1209
1210# Each URL, shown in stats report views, are links you can click.
1211# Possible values: 0 or 1
1212# Default: 1
1213#
1214ShowLinksOnUrl=1
1215
1216
1217# When AWStats builds HTML links in its report pages, it starts those links
1218# with "http://". However some links might be HTTPS links, so you can enter
1219# here the root of all your HTTPS links. If all your site is a SSL web site,
1220# just enter "/".
1221# This parameter is not used if ShowLinksOnUrl is 0.
1222# Example: "/shopping"
1223# Example: "/"
1224# Default: ""
1225#
1226UseHTTPSLinkForUrl=""
1227
1228
1229# Maximum length of URL part shown on stats page (number of characters).
1230# This affects only URL visible text, links still work.
1231# Default: 64
1232#
1233MaxLengthOfShownURL=64
1234
1235
1236# You can enter HTML code that will be added at the top of AWStats reports.
1237# Default: ""
1238#
1239HTMLHeadSection=""
1240
1241
1242# You can enter HTML code that will be added at the end of AWStats reports.
1243# Great to add advert ban.
1244# Default: ""
1245#
1246HTMLEndSection=""
1247
1248
1249# By default AWStats page contains meta tag robots=noindex,nofollow
1250# If you want to have your statistics to be indexed, set this option to 1.
1251# Default: 0
1252#
1253MetaRobot=0
1254
1255
1256# You can set Logo and LogoLink to use your own logo.
1257# Logo must be the name of image file (must be in $DirIcons/other directory).
1258# LogoLink is the expected URL when clicking on Logo.
1259# Default: "awstats_logo6.png"
1260#
1261Logo="awstats_logo6.png"
1262LogoLink="http://www.awstats.org"
1263
1264
1265# Value of maximum bar width/height for horizontal/vertical HTML graphics bars.
1266# Default: 260/90
1267#
1268BarWidth = 260
1269BarHeight = 90
1270
1271
1272# You can ask AWStats to use a particular CSS (Cascading Style Sheet) to
1273# change its look. To create a style sheet, you can use samples provided with
1274# AWStats in wwwroot/css directory.
1275# Example: "/awstatscss/awstats_bw.css"
1276# Example: "/css/awstats_bw.css"
1277# Default: ""
1278#
1279StyleSheet=""
1280
1281
1282# Those color parameters can be used (if StyleSheet parameter is not used)
1283# to change AWStats look.
1284# Example: color_name="RRGGBB" # RRGGBB is Red Green Blue components in Hex
1285#
1286color_Background="FFFFFF" # Background color for main page (Default = "FFFFFF")
1287color_TableBGTitle="CCCCDD" # Background color for table title (Default = "CCCCDD")
1288color_TableTitle="000000" # Table title font color (Default = "000000")
1289color_TableBG="CCCCDD" # Background color for table (Default = "CCCCDD")
1290color_TableRowTitle="FFFFFF" # Table row title font color (Default = "FFFFFF")
1291color_TableBGRowTitle="ECECEC" # Background color for row title (Default = "ECECEC")
1292color_TableBorder="ECECEC" # Table border color (Default = "ECECEC")
1293color_text="000000" # Color of text (Default = "000000")
1294color_textpercent="606060" # Color of text for percent values (Default = "606060")
1295color_titletext="000000" # Color of text title within colored Title Rows (Default = "000000")
1296color_weekend="EAEAEA" # Color for week-end days (Default = "EAEAEA")
1297color_link="0011BB" # Color of HTML links (Default = "0011BB")
1298color_hover="605040" # Color of HTML on-mouseover links (Default = "605040")
1299color_u="FFAA66" # Background color for number of unique visitors (Default = "FFAA66")
1300color_v="F4F090" # Background color for number of visites (Default = "F4F090")
1301color_p="4477DD" # Background color for number of pages (Default = "4477DD")
1302color_h="66DDEE" # Background color for number of hits (Default = "66DDEE")
1303color_k="2EA495" # Background color for number of bytes (Default = "2EA495")
1304color_s="8888DD" # Background color for number of search (Default = "8888DD")
1305color_e="CEC2E8" # Background color for number of entry pages (Default = "CEC2E8")
1306color_x="C1B2E2" # Background color for number of exit pages (Default = "C1B2E2")
1307
1308
1309
1310#-----------------------------------------------------------------------------
1311# PLUGINS
1312#-----------------------------------------------------------------------------
1313
1314# Add here all plugin files you want to load.
1315# Plugin files must be .pm files stored in 'plugins' directory.
1316# Uncomment LoadPlugin lines to enable a plugin after checking that perl
1317# modules required by the plugin are installed.
1318
1319# PLUGIN: Tooltips
1320# REQUIRED MODULES: None
1321# PARAMETERS: None
1322# DESCRIPTION: Add tooltips pop-up help boxes to HTML report pages.
1323# NOTE: This will increased HTML report pages size, thus server load and bandwidth.
1324#
1325#LoadPlugin="tooltips"
1326
1327# PLUGIN: DecodeUTFKeys
1328# REQUIRED MODULES: Encode and URI::Escape
1329# PARAMETERS: None
1330# DESCRIPTION: Allow AWStats to show correctly (in language charset)
1331# keywords/keyphrases strings even if they were UTF8 coded by the
1332# referer search engine.
1333#
1334#LoadPlugin="decodeutfkeys"
1335
1336# PLUGIN: IPv6
1337# PARAMETERS: None
1338# REQUIRED MODULES: Net::IP and Net::DNS
1339# DESCRIPTION: This plugin gives AWStats capability to make reverse DNS
1340# lookup on IPv6 addresses.
1341#
1342#LoadPlugin="ipv6"
1343
1344# PLUGIN: HashFiles
1345# REQUIRED MODULES: Storable
1346# PARAMETERS: None
1347# DESCRIPTION: AWStats DNS cache files are read/saved as native hash files.
1348# This increases DNS cache files loading speed, above all for very large web sites.
1349#
1350LoadPlugin="hashfiles"
1351
1352
1353# PLUGIN: UserInfo
1354# REQUIRED MODULES: None
1355# PARAMETERS: None
1356# DESCRIPTION: Add a text (Firtname, Lastname, Office Department, ...) in
1357# authenticated user reports for each login value.
1358# A text file called userinfo.myconfig.txt, with two fields (first is login,
1359# second is text to show, separated by a tab char) must be created in DirData
1360# directory.
1361#
1362#LoadPlugin="userinfo"
1363
1364# PLUGIN: HostInfo
1365# REQUIRED MODULES: Net::XWhois
1366# PARAMETERS: None
1367# DESCRIPTION: Add a column into host chart with a link to open a popup window that shows
1368# info on host (like whois records).
1369#
1370#LoadPlugin="hostinfo"
1371
1372# PLUGIN: ClusterInfo
1373# REQUIRED MODULES: None
1374# PARAMETERS: None
1375# DESCRIPTION: Add a text (for example a full hostname) in cluster reports for each cluster
1376# number. A text file called clusterinfo.myconfig.txt, with two fields (first is
1377# cluster number, second is text to show) separated by a tab char. must be
1378# created into DirData directory.
1379# Note this plugin is useless if ShowClusterStats is set to 0 or if you don't
1380# use a personalized log format that contains %cluster tag.
1381#
1382#LoadPlugin="clusterinfo"
1383
1384# PLUGIN: UrlAliases
1385# REQUIRED MODULES: None
1386# PARAMETERS: None
1387# DESCRIPTION: Add a text (Page title, description...) in URL reports before URL value.
1388# A text file called urlalias.myconfig.txt, with two fields (first is URL,
1389# second is text to show, separated by a tab char) must be created into
1390# DirData directory.
1391#
1392#LoadPlugin="urlalias"
1393
1394# PLUGIN: TimeHiRes
1395# REQUIRED MODULES: Time::HiRes (if Perl < 5.8)
1396# PARAMETERS: None
1397# DESCRIPTION: Time reported by -showsteps option is in millisecond. For debug purpose.
1398#
1399#LoadPlugin="timehires"
1400
1401# PLUGIN: TimeZone
1402# REQUIRED MODULES: Time::Local
1403# PARAMETERS: [timezone offset]
1404# DESCRIPTION: Allow AWStats to adjust time stamps for a different timezone
1405# This plugin reduces AWStats speed of 10% !!!!!!!
1406# LoadPlugin="timezone"
1407# LoadPlugin="timezone +2"
1408# LoadPlugin="timezone CET"
1409#
1410#LoadPlugin="timezone +2"
1411
1412# PLUGIN: Rawlog
1413# REQUIRED MODULES: None
1414# PARAMETERS: None
1415# DESCRIPTION: This plugin adds a form in AWStats main page to allow users to see raw
1416# content of current log files. A filter is also available.
1417#
1418#LoadPlugin="rawlog"
1419
1420# PLUGIN: GraphApplet
1421# REQUIRED MODULES: None
1422# PARAMETERS: [CSS classes to override]
1423# DESCRIPTION: Supported charts are built by a 3D graphic applet.
1424#
1425#LoadPlugin="graphapplet /awstatsclasses" # EXPERIMENTAL FEATURE
1426
1427# PLUGIN: GraphGoogleChartAPI
1428# REQUIRED MODULES: None
1429# PARAMETERS: None
1430# DESCRIPTION: Replaces the standard charts with free Google API generated images
1431# in HTML reports. If country data is available and more than one country has hits,
1432# a map will be generated using Google Visualizations.
1433# Note: The machine where reports are displayed must have Internet access for the
1434# charts to be generated. The only data sent to Google includes the statistic numbers,
1435# legend names and country names.
1436# Warning: This plugin is not compatible with option BuildReportFormat=xhtml.
1437#
1438#LoadPlugin="graphgooglechartapi"
1439
1440# PLUGIN: GeoIPfree
1441# REQUIRED MODULES: Geo::IPfree version 0.2+ (from Graciliano M.P.)
1442# PARAMETERS: None
1443# DESCRIPTION: Country chart is built from an Internet IP-Country database.
1444# This plugin is useless for intranet only log files.
1445# Note: You must choose between using this plugin (need Perl Geo::IPfree
1446# module, database is free but not up to date) or the GeoIP plugin (need
1447# Perl Geo::IP module from Maxmind, database is also free and up to date).
1448# Note: Activestate provide a corrupted version of Geo::IPfree 0.2 Perl
1449# module, so install it from elsewhere (from www.cpan.org for example).
1450# This plugin reduces AWStats speed by up to 10% !
1451#
1452#LoadPlugin="geoipfree"
1453
1454# MAXMIND GEO IP MODULES: Please see documentation for notes on all Maxmind modules
1455
1456# PLUGIN: GeoIP
1457# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind)
1458# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/geoip.dat[+/pathto/override.txt]]
1459# DESCRIPTION: Builds a country chart and adds an entry to the hosts
1460# table with country name
1461# Replace spaces in the path of geoip data file with string "%20".
1462#
1463#LoadPlugin="geoip GEOIP_STANDARD /usr/share/GeoIP/GeoIP.dat"
1464
1465# PLUGIN: GeoIP6
1466# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind, version >= 1.40)
1467# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/geoipv6.dat[+/pathto/override.txt]]
1468# DESCRIPTION: Builds a country chart and adds an entry to the hosts
1469# table with country name
1470# works with IPv4 and also IPv6 addresses
1471# Replace spaces in the path of geoip data file with string "%20".
1472#
1473#LoadPlugin="geoip6 GEOIP_STANDARD /pathto/GeoIPv6.dat"
1474
1475# PLUGIN: GeoIP_City_Maxmind
1476# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind)
1477# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPCity.dat[+/pathto/override.txt]]
1478# DESCRIPTION: This plugin adds a column under the hosts field and tracks the pageviews
1479# and hits by city including regions.
1480# Replace spaces in the path of geoip data file with string "%20".
1481#
1482#LoadPlugin="geoip_city_maxmind GEOIP_STANDARD /usr/share/GeoIP/GeoIPCity.dat"
1483
1484# PLUGIN: GeoIP_ASN_Maxmind
1485# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind)
1486# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPASN.dat[+/pathto/override.txt][+http://linktoASlookup]]
1487# DESCRIPTION: This plugin adds a chart of AS numbers where the host IP address is registered.
1488# This plugin can display some ISP information if included in the database. You can also provide
1489# a link that will be used to lookup additional registration data. Put the link at the end of
1490# the parameter string and the report page will include the link with the full AS number at the end.
1491# Replace spaces in the path of geoip data file with string "%20".
1492#
1493#LoadPlugin="geoip_asn_maxmind GEOIP_STANDARD /usr/local/geoip.dat+http://enc.com.au/itools/autnum.php?asn="
1494
1495# PLUGIN: GeoIP_Region_Maxmind
1496# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind)
1497# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPRegion.dat[+/pathto/override.txt]]
1498# DESCRIPTION:This plugin adds a chart of hits by regions. Only regions for US and
1499# Canada can be detected.
1500# Replace spaces in the path of geoip data file with string "%20".
1501#
1502#LoadPlugin="geoip_region_maxmind GEOIP_STANDARD /usr/share/GeoIP/GeoIPRegion.dat"
1503
1504# PLUGIN: GeoIP_ISP_Maxmind
1505# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind)
1506# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPISP.dat[+/pathto/override.txt]]
1507# DESCRIPTION: This plugin adds a chart of hits by ISP.
1508# Replace spaces in the path of geoip data file with string "%20".
1509#
1510#LoadPlugin="geoip_isp_maxmind GEOIP_STANDARD /usr/share/GeoIP/GeoIPISP.dat"
1511
1512# PLUGIN: GeoIP_Org_Maxmind
1513# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind)
1514# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPOrg.dat[+/pathto/override.txt]]
1515# DESCRIPTION: This plugin add a chart of hits by Organization name
1516# Replace spaces in the path of geoip data file with string "%20".
1517#
1518#LoadPlugin="geoip_org_maxmind GEOIP_STANDARD /usr/share/GeoIP/GeoIPOrg.dat"
1519
1520
1521#-----------------------------------------------------------------------------
1522# EXTRA SECTIONS
1523#-----------------------------------------------------------------------------
1524
1525# You can define your own charts, you choose here what are rows and columns
1526# keys. This feature is particularly useful for marketing purpose, tracking
1527# products orders for example.
1528# For this, edit all parameters of Extra section. Each set of parameter is a
1529# different chart. For several charts, duplicate section changing the number.
1530# Note: Each Extra section reduces AWStats speed by 8%.
1531#
1532# WARNING: A wrong setup of Extra section might result in too large arrays
1533# that will consume all your memory, making AWStats unusable after several
1534# updates, so be sure to setup it correctly.
1535# In most cases, you don't need this feature.
1536#
1537# ExtraSectionNameX is title of your personalized chart.
1538# ExtraSectionCodeFilterX is list of codes the record code field must match.
1539# Put an empty string for no test on code.
1540# ExtraSectionConditionX are conditions you can use to count or not the hit,
1541# Use one of the field condition
1542# (URL,URLWITHQUERY,QUERY_STRING,REFERER,UA,HOSTINLOG,HOST,VHOST,extraX)
1543# and a regex to match, after a coma. Use "||" for "OR".
1544# ExtraSectionFirstColumnTitleX is the first column title of the chart.
1545# ExtraSectionFirstColumnValuesX is a string to tell AWStats which field to
1546# extract value from
1547# (URL,URLWITHQUERY,QUERY_STRING,REFERER,UA,HOSTINLOG,HOST,VHOST,extraX)
1548# and how to extract the value (using regex syntax). Each different value
1549# found will appear in first column of report on a different row. Be sure
1550# that list of different possible values will not grow indefinitely.
1551# ExtraSectionFirstColumnFormatX is the string used to write value.
1552# ExtraSectionStatTypesX are things you want to count. You can use standard
1553# code letters (P for pages,H for hits,B for bandwidth,L for last access).
1554# ExtraSectionAddAverageRowX add a row at bottom of chart with average values.
1555# ExtraSectionAddSumRowX add a row at bottom of chart with sum values.
1556# MaxNbOfExtraX is maximum number of rows shown in chart.
1557# MinHitExtraX is minimum number of hits required to be shown in chart.
1558#
1559
1560# Example to report the 20 products the most ordered by "order.cgi" script
1561#ExtraSectionName1="Product orders"
1562#ExtraSectionCodeFilter1="200 304"
1563#ExtraSectionCondition1="URL,\/cgi\-bin\/order\.cgi||URL,\/cgi\-bin\/order2\.cgi"
1564#ExtraSectionFirstColumnTitle1="Product ID"
1565#ExtraSectionFirstColumnValues1="QUERY_STRING,productid=([^&]+)"
1566#ExtraSectionFirstColumnFormat1="%s"
1567#ExtraSectionStatTypes1=PL
1568#ExtraSectionAddAverageRow1=0
1569#ExtraSectionAddSumRow1=1
1570#MaxNbOfExtra1=20
1571#MinHitExtra1=1
1572
1573
1574# There is also a global parameter ExtraTrackedRowsLimit that limits the
1575# number of possible rows an ExtraSection can report. This parameter is
1576# here to protect too much memory use when you make a bad setup in your
1577# ExtraSection. It applies to all ExtraSection independently meaning that
1578# none ExtraSection can report more rows than value defined by ExtraTrackedRowsLimit.
1579# If you know an ExtraSection will report more rows than its value, you should
1580# increase this parameter or AWStats will stop with an error.
1581# Example: 2000
1582# Default: 500
1583#
1584ExtraTrackedRowsLimit=500
1585
1586
1587#-----------------------------------------------------------------------------
1588# INCLUDES
1589#-----------------------------------------------------------------------------
1590
1591# You can include other config files using the directive with the name of the
1592# config file.
1593# This is particularly useful for users who have a lot of virtual servers, so
1594# a lot of config files and want to maintain common values in only one file.
1595# Note that when a variable is defined both in a config file and in an
1596# included file, AWStats will use the last value read for parameters that
1597# contains one value and AWStats will concat all values from both files for
1598# parameters that are lists of values.
1599#
1600
1601Include "/etc/awstats/awstats.conf.local"