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