1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
4
<meta name="description" content="AWStats Documentation - Configuration directives and parameters">
5
<meta name="keywords" content="awstats, awstat, config, parameters, configuration, conf">
6
<meta name="robots" content="index,follow">
7
<meta name="title" content="AWStats Documentation - Configuration directives and parameters">
8
<title>AWStats Documentation - Configuration directives and parameters</title>
9
<link rel="stylesheet" href="styles.css" type="text/css">
10
<!-- $Revision: 1.157 $ - $Author: eldy $ - $Date: 2004/01/07 07:12:05 $ -->
13
<body topmargin=10 leftmargin=5>
16
<table style="font: 10pt arial,helvetica,verdana" cellpadding=0 cellspacing=0 border=0 bgcolor=#FFFFFF width=100%>
19
<tr style="font: 10pt arial,helvetica,verdana">
20
<td bgcolor=#9999cc align=center><a href="/"><img src="images/awstats_logo4.png" border=0></a></td>
21
<td bgcolor=#9999cc align=center>
23
<font style="font: 16pt arial,helvetica,sanserif" color=#EEEEFF><b>AWStats logfile analyzer 6.0 Documentation</b></font><br>
26
<td bgcolor=#9999cc align=center>
34
<br><br><H1 style="font: 26px arial,helvetica,sanserif">AWStats configuration directives/options</H1>
35
<!-- -------------------------------------------------------------------------------------- -->
37
<br>Each directives available in the AWStats config file (.conf) is listed here.<br>
38
They are described using a consistent format.<br>
41
To include an environment variable in any parameter (AWStats will replace it with its value
42
when reading it), follow the example:<br>
43
<i>Parameter="__ENVNAME__"</i>
47
<br><b>MAIN SETUP SECTION (Required to make AWStats work)</b><br>
49
<li><a href="#LogFile">LogFile</a>
50
<li><a href="#LogType">LogType</a>
51
<li><a href="#LogFormat">LogFormat</a>
52
<li><a href="#LogSeparator">LogSeparator</a>
53
<li><a href="#DNSLookup">DNSLookup</a>
54
<li><a href="#DirData">DirData</a>
55
<li><a href="#DirCgi">DirCgi</a>
56
<li><a href="#DirIcons">DirIcons</a>
57
<li><a href="#SiteDomain">SiteDomain</a>
58
<li><a href="#HostAliases">HostAliases</a>
59
<li><a href="#AllowToUpdateStatsFromBrowser">AllowToUpdateStatsFromBrowser</a>
60
<li><a href="#AllowFullYearView">AllowFullYearView</a>
64
<br><b>OPTIONAL SETUP SECTION (Not required but increase AWStats features)</b><br>
66
<li><a href="#EnableLockForUpdate">EnableLockForUpdate</a>
67
<li><a href="#DNSStaticCacheFile">DNSStaticCacheFile</a>
68
<li><a href="#DNSLastUpdateCacheFile">DNSLastUpdateCacheFile</a>
69
<li><a href="#SkipDNSLookupFor">SkipDNSLookupFor</a>
70
<li><a href="#AllowAccessFromWebToAuthenticatedUsersOnly">AllowAccessFromWebToAuthenticatedUsersOnly</a>
71
<li><a href="#AllowAccessFromWebToFollowingAuthenticatedUsers">AllowAccessFromWebToFollowingAuthenticatedUsers</a>
72
<li><a href="#AllowAccessFromWebToFollowingIPAddresses">AllowAccessFromWebToFollowingIPAddresses</a>
73
<li><a href="#CreateDirDataIfNotExists">CreateDirDataIfNotExists</a>
74
<li><a href="#BuildHistoryFormat">BuildHistoryFormat</a>
75
<li><a href="#BuildReportFormat">BuildReportFormat</a>
76
<li><a href="#SaveDatabaseFilesWithPermissionsForEveryone">SaveDatabaseFilesWithPermissionsForEveryone</a>
77
<li><a href="#PurgeLogFile">PurgeLogFile</a>
78
<li><a href="#ArchiveLogRecords">ArchiveLogRecords</a>
79
<li><a href="#KeepBackupOfHistoricFiles">KeepBackupOfHistoricFiles</a>
80
<li><a href="#DefaultFile">DefaultFile</a>
81
<li><a href="#SkipHosts">SkipHosts</a>
82
<li><a href="#SkipUserAgents">SkipUserAgents</a>
83
<li><a href="#SkipFiles">SkipFiles</a>
84
<li><a href="#OnlyHosts">OnlyHosts</a>
85
<li><a href="#OnlyUserAgents">OnlyUserAgents</a>
86
<li><a href="#OnlyFiles">OnlyFiles</a>
87
<li><a href="#NotPageList">NotPageList</a>
88
<li><a href="#ValidHTTPCodes">ValidHTTPCodes</a>
89
<li><a href="#ValidSMTPCodes">ValidSMTPCodes</a>
90
<li><a href="#AuthenticatedUsersNotCaseSensitive">AuthenticatedUsersNotCaseSensitive</a>
91
<li><a href="#URLNotCaseSensitive">URLNotCaseSensitive</a>
92
<li><a href="#URLWithAnchor">URLWithAnchor</a>
93
<li><a href="#URLQuerySeparators">URLQuerySeparators</a>
94
<li><a href="#URLWithQuery">URLWithQuery</a>
95
<li><a href="#URLWithQueryWithOnlyFollowingParameters">URLWithQueryWithOnlyFollowingParameters</a>
96
<li><a href="#URLWithQueryWithoutFollowingParameters">URLWithQueryWithoutFollowingParameters</a>
97
<li><a href="#URLReferrerWithQuery">URLReferrerWithQuery</a>
98
<li><a href="#WarningMessages">WarningMessages</a>
99
<li><a href="#ErrorMessages">ErrorMessages</a>
100
<li><a href="#DebugMessages">DebugMessages</a>
101
<li><a href="#NbOfLinesForCorruptedLog">NbOfLinesForCorruptedLog</a>
102
<li><a href="#SplitSearchString">SplitSearchString</a>
103
<li><a href="#WrapperScript">WrapperScript</a>
104
<li><a href="#DecodeUA">DecodeUA</a>
105
<li><a href="#MiscTrackerUrl">MiscTrackerUrl</a>
108
<br><b>OPTIONAL ACCURACY SETUP SECTION (Not required but increase AWStats features)</b><br>
110
<li><a href="#LevelFor">LevelForBrowsersDetection</a>
111
<li><a href="#LevelFor">LevelForOSDetection</a>
112
<li><a href="#LevelFor">LevelForRefererAnalyze</a>
113
<li><a href="#LevelFor">LevelForRobotsDetection</a>
114
<li><a href="#LevelFor">LevelForSearchEnginesDetection</a>
115
<li><a href="#LevelFor">LevelForKeywordsDetection</a>
116
<li><a href="#LevelFor">LevelForFileTypesDetection</a>
117
<li><a href="#LevelFor">LevelForWormsDetection</a>
121
<br><b>OPTIONAL APPEARANCE SETUP SECTION (Not required but increase AWStats features)</b><br>
123
<li><a href="#UseFramesWhenCGI">UseFramesWhenCGI</a>
124
<li><a href="#DetailedReportsOnNewWindows">DetailedReportsOnNewWindows</a>
125
<li><a href="#Expires">Expires</a>
126
<li><a href="#MaxRowsInHTMLOutput">MaxRowsInHTMLOutput</a>
127
<li><a href="#Lang">Lang</a>
128
<li><a href="#DirLang">DirLang</a>
129
<li><a href="#Show">ShowHeader</a>
130
<li><a href="#Show">ShowMenu</a>
131
<li><a href="#Show">ShowMonthStats</a>
132
<li><a href="#Show">ShowDaysOfMonthStats</a>
133
<li><a href="#Show">ShowDaysOfWeekStats</a>
134
<li><a href="#Show">ShowHoursStats</a>
135
<li><a href="#Show">ShowDomainsStats</a>
136
<li><a href="#Show">ShowHostsStats</a>
137
<li><a href="#Show">ShowAuthenticatedUsers</a>
138
<li><a href="#Show">ShowRobotsStats</a>
139
<li><a href="#Show">ShowWormsStats</a>
140
<li><a href="#Show">ShowSessionsStats</a>
141
<li><a href="#Show">ShowPagesStats</a>
142
<li><a href="#Show">ShowCompressionStats</a>
143
<li><a href="#Show">ShowFileTypesStats</a>
144
<li><a href="#Show">ShowFileSizesStats</a>
145
<li><a href="#Show">ShowOSStats</a>
146
<li><a href="#Show">ShowBrowsersStats</a>
147
<li><a href="#Show">ShowScreenSizeStats</a>
148
<li><a href="#Show">ShowOriginStats</a>
149
<li><a href="#Show">ShowKeyphrasesStats</a>
150
<li><a href="#Show">ShowKeywordsStats</a>
151
<li><a href="#Show">ShowMiscStats</a>
152
<li><a href="#Show">ShowHTTPErrorsStats</a>
153
<li><a href="#Show">ShowSMTPErrorsStats</a>
154
<li><a href="#Show">ShowClusterStats</a>
155
<li><a href="#AddDataArray">AddDataArrayMonthStats</a>
156
<li><a href="#AddDataArray">AddDataArrayShowDaysOfMonthStats</a>
157
<li><a href="#AddDataArray">AddDataArrayShowDaysOfWeekStats</a>
158
<li><a href="#AddDataArray">AddDataArrayShowHoursStats</a>
159
<li><a href="#Max">MaxNbOfDomain</a>
160
<li><a href="#Max">MinHitDomain</a>
161
<li><a href="#Max">MaxNbOfHostsShown</a>
162
<li><a href="#Max">MinHitHost</a>
163
<li><a href="#Max">MaxNbOfLoginShown</a>
164
<li><a href="#Max">MinHitLogin</a>
165
<li><a href="#Max">MaxNbOfRobotShown</a>
166
<li><a href="#Max">MinHitRobot</a>
167
<li><a href="#Max">MaxNbOfPageShown</a>
168
<li><a href="#Max">MaxNbOfOsShown</a>
169
<li><a href="#Max">MinHitOs</a>
170
<li><a href="#Max">MaxNbOfBrowsersShown</a>
171
<li><a href="#Max">MinHitBrowser</a>
172
<li><a href="#Max">MinHitFile</a>
173
<li><a href="#Max">MaxNbOfScreenSizesShown</a>
174
<li><a href="#Max">MinHitScreenSize</a>
175
<li><a href="#Max">MaxNbOfRefererShown</a>
176
<li><a href="#Max">MinHitRefer</a>
177
<li><a href="#Max">MaxNbOfKeywordsShown</a>
178
<li><a href="#Max">MinHitKeyword</a>
179
<li><a href="#FirstDayOfWeek">FirstDayOfWeek</a>
180
<li><a href="#ShowFlagLinks">ShowFlagLinks</a>
181
<li><a href="#ShowLinksOnUrl">ShowLinksOnUrl</a>
182
<li><a href="#MaxLengthOfURL">MaxLengthOfURL</a>
183
<li><a href="#ShowLinksToWhoIs">ShowLinksToWhoIs</a>
184
<li><a href="#UseHTTPSLinksForUrl">UseHTTPSLinksForUrl</a>
185
<li><a href="#LinksToWhoIs">LinksToWhoIs</a>
186
<li><a href="#LinksToIPWhoIs">LinksToIPWhoIs</a>
187
<li><a href="#HTMLHeadSection">HTMLHeadSection</a>
188
<li><a href="#HTMLEndSection">HTMLEndSection</a>
189
<li><a href="#Bar">BarWidth</a>
190
<li><a href="#Bar">BarHeight</a>
191
<li><a href="#Logo">Logo</a>
192
<li><a href="#Logo">LogoLink</a>
193
<li><a href="#StyleSheet">StyleSheet</a>
194
<li><a href="#color_">color_Background</a>
195
<li><a href="#color_">color_TableBGTitle</a>
196
<li><a href="#color_">color_TableTitle</a>
197
<li><a href="#color_">color_TableBG</a>
198
<li><a href="#color_">color_TableRowTitle</a>
199
<li><a href="#color_">color_TableBGRowTitle</a>
200
<li><a href="#color_">color_TableBorder</a>
201
<li><a href="#color_">color_text</a>
202
<li><a href="#color_">color_titletext</a>
203
<li><a href="#color_">color_weekend</a>
204
<li><a href="#color_">color_link</a>
205
<li><a href="#color_">color_hover</a>
206
<li><a href="#color_">color_u</a>
207
<li><a href="#color_">color_v</a>
208
<li><a href="#color_">color_p</a>
209
<li><a href="#color_">color_h</a>
210
<li><a href="#color_">color_k</a>
211
<li><a href="#color_">color_s</a>
212
<li><a href="#color_">color_e</a>
213
<li><a href="#color_">color_x</a>
216
<br><b>PLUGINS</b><br>
218
<li><a href="#LoadPlugin">LoadPlugin</a>
223
<li><a href="#Extra">ExtraSectionNameX</a>
224
<li><a href="#Extra">ExtraSectionConditionX</a>
225
<li><a href="#Extra">ExtraSectionFirstColumnTitleX</a>
226
<li><a href="#Extra">ExtraSectionFirstColumnValuesX</a>
227
<li><a href="#Extra">ExtraSectionFirstColumnFormatX</a>
228
<li><a href="#Extra">ExtraSectionStatTypesX</a>
229
<li><a href="#Extra">ExtraSectionAddAverageRowX</a>
230
<li><a href="#Extra">ExtraSectionAddSumRowX</a>
231
<li><a href="#Extra">MaxNbOfExtraX</a>
232
<li><a href="#Extra">MinHitExtraX</a>
235
<br><b>INCLUDES</b><br>
237
<li><a href="#Include">Include</a>
244
<a name="LogFile"><b>LogFile</b></a><br>
245
<b>Version : </b>1.0+<br>
246
3.1+ for tags %YYYY-n,%YY-n,%MM-n,%DD-n,%HH-n<br>
247
3.2+ for tag %WM-n<br>
248
4.0+ for tag %DW-n<br>
249
4.1+ for tag %NS-n<br>
250
5.0+ for tag %WY-n<br>
251
5.1+ for tag %Wm-n, %Wy-n, %Dw-n<br>
252
<br># "LogFile" contains the web, ftp or mail server logfile to analyze.
253
<br># You can use a full path or relative path from awstats.pl directory.
254
<br># Example: "/var/log/apache/access.log"
255
<br># Example: "../logs/mycombinedlog.log"
256
<br># You can also use tags in this filename if you need a dynamic file name
257
<br># depending on date or time (Replacement is made by AWStats at the beginning
258
<br># of its execution). This is available tags :
259
<br># %YYYY-n is replaced with 4 digits year we were n hours ago
260
<br># %YY-n is replaced with 2 digits year we were n hours ago
261
<br># %MM-n is replaced with month we were n hours ago
262
<br># %MO-n is replaced with 3 letters month we were n hours ago
263
<br># %DD-n is replaced with day we were n hours ago
264
<br># %HH-n is replaced with hour we were n hours ago
265
<br># %NS-n is replaced with number of seconds at 00:00 since 1970
266
<br># %WM-n is replaced with the week number in month (1-5)
267
<br># %Wm-n is replaced with the week number in month (0-4)
268
<br># %WY-n is replaced with the week number in year (01-52)
269
<br># %Wy-n is replaced with the week number in year (00-51)
270
<br># %DW-n is replaced with the day number in week (1-7, 1=sunday)
271
<br># use n=24 if you need (1-7, 1=monday)
272
<br># %Dw-n is replaced with the day number in week (0-6, 0=sunday)
273
<br># use n=24 if you need (0-6, 0=monday)
274
<br># Use 0 for n if you need current year, month, day, hour...
275
<br># Example: "/var/log/access_log.%YYYY-0%MM-0%DD-0.log"
276
<br># Example: "C:/WINNT/system32/LogFiles/W3SVC1/ex%YY-24%MM-24%DD-24.log"
277
<br># You can also use a pipe if log file come from a pipe.
278
<br># Example: "gzip -d </var/log/apache/access.log.gz |"
279
<br># If there is several log files from load balancing servers :
280
<br># Example: "/pathtotools/logresolvemerge.pl *.log |"
282
<br>LogFile="/var/log/httpd/mylog.log"
286
<a name="LogType"><b>LogType</b></a><br>
287
<b>Version : </b>5.7+<br>
288
<br># Enter the log file type you want to analyze.
289
<br># Possible values:
290
<br># W - For a web log file
291
<br># M - For a mail log file
292
<br># F - For a ftp log file
300
<a name="LogFormat"><b>LogFormat</b></a><br>
301
<b>Version : </b>2.1+<br>
302
3.1+ for tags %host,%logname,%time1,%time2,%methodurl,%methodurlnoprot,%method,%url,
303
%query,%code,%bytesd,%refererquot,%referer,%uaquot,%ua,%other<br>
304
3.2+ for tags %gzipin,%gzipout<br>
305
4.0+ for tags %gzipratio,%syslog<br>
306
4.1+ for tag %virtualname<br>
307
5.6+ for tag %deflateratio<br>
308
<br># Enter here your log format (Must agree with your web server. See setup
309
<br># instructions in README.txt to know how to configure your web server to have
310
<br># the required log format).
311
<br># Possible values: 1,2,3,4,5 or "your_own_personalized_log_format"
312
<br># 1 - Apache or Lotus Notes/Domino native combined log format (NCSA combined/XLF/ELF log format)
313
<br># 2 - IIS log format (W3C log format)
314
<br># 3 - Webstar native log format
315
<br># 4 - Apache or Squid native common log format (NCSA common/CLF log format)
316
<br># With LogFormat=4, some features (browsers, os, keywords...) can't work.
317
<br># "your_own_personalized_log_format" = If your log is ftp, mail or other format,
318
<br># you must use following keys to define the log format string (See FAQ
319
<br># for ftp, mail or exotic web log format examples):
320
<br># %host Host client name or IP address
321
<br># %lognamequot Authenticated login/user with format: "alex"
322
<br># %logname Authenticated login/user with format: alex
323
<br># %time1 Date and time with format: [dd/mmm/yyyy:hh:mm:ss +0000] or [dd/mmm/yyyy:hh:mm:ss]
324
<br># %time2 Date and time with format: yyyy-mm-dd hh-mm-ss
325
<br># %methodurl Method and URL with format: "GET /index.html HTTP/x.x"
326
<br># %methodurlnoprot Method and URL with format: "GET /index.html"
327
<br># %method Method with format: GET
328
<br># %url URL only with format: /index.html
329
<br># %query Query string (used by URLWithQuery option)
330
<br># %code Return code status (with format for web log: 999)
331
<br># %bytesd Size of document in bytes
332
<br># %refererquot Referer page with format: "http://from.com/from.htm"
333
<br># %referer Referer page with format: http://from.com/from.htm
334
<br># %uaquot User agent with format: "Mozilla/4.0 (compatible, ...)"
335
<br># %ua User agent with format: Mozilla/4.0_(compatible...)
336
<br># %gzipin mod_gzip compression input bytes: In:XXX
337
<br># %gzipout mod_gzip compression output bytes & ratio: Out:YYY:ZZpct.
338
<br># %gzipratio mod_gzip compression ratio: ZZpct.
339
<br># %deflateratio mod_deflate compression ratio with format: (ZZ)
340
<br># %email EMail sender (for mail log)
341
<br># %email_r EMail receiver (for mail log)
342
<br># %virtualname Web sever virtual hostname. Use this tag when same log
343
<br># contains data of several virtual web servers. AWStats
344
<br># will discard records not in SiteDomain nor HostAliases
345
<br># %cluster If log file is provided from several computers (merged by
346
<br># logresolvemerge.pl), this tag define field of cluster id.
347
<br># If your log format has some fields not included in this list, use
348
<br># %other Means another field
350
<br># Examples for Apache combined logs (following two examples are equivalent):
352
<br># LogFormat = "%host %other %logname %time1 %methodurl %code %bytesd %refererquot %uaquot"
354
<br># Examples for IIS (following two examples are equivalent):
356
<br># LogFormat = "%time2 %host %logname %method %url %code %bytesd %other %ua %referer"
362
<a name="LogSeparator"><b>LogSeparator</b></a><br>
363
<b>Version : </b>5.0+<br>
364
<br># If your log field's separator is not a space, you can change this parameter.
365
<br># This parameter is not used if LogFormat is a predefined value (1,2,3,4,5,6)
375
<a name="DNSLookup"><b>DNSLookup</b></a><br>
376
<b>Version : </b>1.0+ (5.0+ for value 2) <br>
377
<br># If you want to have hosts reported by name instead of ip address, AWStats
378
<br># need to make reverse DNS lookups (if not already done in your log file).
379
<br># With DNSLookup to 0, all hosts will be reported by their IP addresses and
380
<br># not by the full hostname of visitors (except if names are already available
382
<br># If you want/need to set DNSLookup to 1, don't forget that this will reduce
383
<br># dramatically AWStats update process speed. Do not use on large web sites.
384
<br># Note: Reverse DNS lookup is done on IPv4 only (Enable ipv6 plugin for IPv6).
385
<br># Note: Result of DNS Lookup can be used to build the Country report. However
386
<br># it is highly recommanded to enable the plugin 'geoipfree' or 'geoip' to
387
<br># have an accurate Country report with no need of DNS Lookup.
388
<br># Possible values:
389
<br># 0 - No DNS Lookup
390
<br># 1 - DNS Lookup is fully enabled
391
<br># 2 - DNS Lookup is made only from static DNS cache file (if it exists)
398
<a name="DirData"><b>DirData</b></a><br>
399
<b>Version : </b>1.0+<br>
400
<br># When AWStats updates its statistics, it stores results of its analysis in
401
<br># files (AWStats database). All those files are written in the directory
402
<br># defined by the "DirData" parameter. Set this value to the directory where
403
<br># you want AWStats to save its database and working files into.
404
<br># Warning: If you want to be able to use the "AllowToUpdateStatsFromBrowser"
405
<br># feature (see later), you need write permissions by webserver user on this
407
<br># Example: "/var/lib/awstats"
408
<br># Example: "../data"
409
<br># Example: "C:/awstats_data_dir"
410
<br># Default: "." (means same directory as awstats.pl)
416
<a name="DirCgi"><b>DirCgi</b></a><br>
417
<b>Version : </b>1.0+<br>
418
<br># Relative or absolute web URL of your awstats cgi-bin directory.
419
<br># This parameter is used only when AWStats is ran from command line
420
<br># with -output option (to generate links in HTML reported page).
421
<br># Example: "/awstats"
422
<br># Default: "/cgi-bin" (means awstats.pl is in "/yourwwwroot/cgi-bin")
424
<br>DirCgi="/cgi-bin"
428
<a name="DirIcons"><b>DirIcons</b></a><br>
429
<b>Version : </b>1.0+<br>
430
<br># Relative or absolute web URL of your awstats icon directory.
431
<br># If you build static reports ("... -output > outputpath/output.html"), enter
432
<br># path of icon directory relative to the output directory 'outputpath'.
433
<br># Example: "/awstatsicons"
434
<br># Example: "../icon"
435
<br># Default: "/icon" (means you must copy icon directories in "/mywwwroot/icon")
441
<a name="SiteDomain"><b>SiteDomain</b></a><br>
442
<b>Version : </b>3.2+<br>
443
<br># "SiteDomain" must contain the main domain name or the main intranet web
444
<br># server name used to reach the web site.
445
<br># If you share the same log file for several virtual web servers, this
446
<br># parameter is used to tell AWStats to filter record that contains records for
447
<br># this virtual host name only (So check that this virtual hostname can be
448
<br># found in your log file and use a personalized log format that include the
449
<br># %virtualname tag).
450
<br># But for multi hosting a better solution is to have one log file for each
451
<br># virtual web server. In this case, this parameter is only used to generate
452
<br># full URL's links when ShowLinksOnUrl option is set to 1.
453
<br># If analysing mail log, enter here the domain name of mail server.
454
<br># Example: "myintranetserver"
455
<br># Example: "www.domain.com"
456
<br># Example: "ftp.domain.com"
457
<br># Example: "domain.com"
463
<a name="HostAliases"><b>HostAliases</b></a><br>
464
<b>Version : </b>1.0+ (5.6+ for REGEX syntax)<br>
465
<br># Enter here all other possible domain names, addresses or virtual host
466
<br># aliases someone can use to access your site. Try to keep only the minimum
467
<br># number of possible names/addresses to have the best performances.
468
<br># You can repeat the "SiteDomain" value in this list.
469
<br># This parameter is used to analyze referer field in log file and to help
470
<br># AWStats to know if a referer URL is a local URL of same site or an URL of
472
<br># Note: Use space between each value.
473
<br># Note: You can use regular expression values writing value with REGEX[value].
474
<br># Example: "www.myserver.com localhost 127.0.0.1 REGEX[\.mydomain\.(net|org)$]"
476
<br>HostAliases="localhost 127.0.0.1 REGEX[^.*\.myserver\.com$]"
480
<a name="AllowToUpdateStatsFromBrowser"><b>AllowToUpdateStatsFromBrowser</b></a><br>
481
<b>Version : </b>3.0+<br>
482
<br># When this parameter is set to 1, AWStats add a button on report page to
483
<br># allow to "update" statistics from a web browser. Warning, when "update" is
484
<br># made from a browser, AWStats is ran as a CGI by the web server user
485
<br># defined in your web server (user "nobody" by default with Apache, "IUSR_XXX"
486
<br># with IIS), so the "DirData" directory and all already existing history files
487
<br># (awstatsMMYYYY[.xxx].txt) must be writable by this user. Change permissions
489
<br># Warning: Update process can be long so you might experience "time out"
490
<br># browser errors if you don't launch AWStats enough frequently.
491
<br># When set to 0, update is only made when AWStats is ran from the command
492
<br># line interface (or a task scheduler).
493
<br># Possible values: 0 or 1
496
<br>AllowToUpdateStatsFromBrowser=0
500
<a name="AllowFullYearView"><b>AllowFullYearView</b></a><br>
501
<b>Version : </b>5.9+<br>
502
<br># AWStats save and sort its database on a month basis, this allows to build
503
<br># build a report quickly. However, if you choose the -month=all from command
504
<br># line or value '-Year-' from CGI combo form to have a report for all year,
505
<br># AWStats needs to reload all data for full year, and resort them completely,
506
<br># requiring a large amount of time, memory and CPU. This might be a problem
507
<br># for web hosting providers that offer AWStats for large sites on shared
508
<br># servers to non CPU cautious customers.
509
<br># For this reason, the 'full year' is only enable on Command Line by default.
510
<br># You can change this by setting this parameter to 0, 1, 2 or 3.
511
<br># Possible values:
512
<br># 0 - Never allowed
513
<br># 1 - Allowed on CLI only, -Year- value in combo is not visible
514
<br># 2 - Allowed on CLI only, -Year- value in combo is visible but not allowed
515
<br># 3 - Possible on CLI and CGI
518
<br>AllowFullYearView=2
522
<a name="EnableLockForUpdate"><b>EnableLockForUpdate</b></a><br>
523
<b>Version : </b>5.0+<br>
524
<br># When the update process run, AWStats can set a lock file in TEMP or TMP
525
<br># directory. This lock is to avoid to have 2 update processes running at the
526
<br># same time to prevent unknown conflicts problems and avoid DoS attacks when
527
<br># AllowToUpdateStatsFromBrowser is set to 1.
528
<br># Because, when you use lock file, you can experience sometimes problems in
529
<br># lock file not correctly removed (killed process for example requires that
530
<br># you remove the file manualy), this option is not enabled by default (Do
531
<br># not enable this option with no console server access).
532
<br># Possible values: 0 or 1
535
<br>EnableLockForUpdate=0
539
<a name="DNSStaticCacheFile"><b>DNSStaticCacheFile</b></a><br>
540
<b>Version : </b>5.0+<br>
541
<br># AWStats can do reverse DNS lookups through a static DNS cache file that was
542
<br># previously created manually. If no path is given in static DNS cache file
543
<br># name, AWStats will search DirData directory. This file is never changed.
544
<br># This option is not used if DNSLookup=0.
545
<br># Note: DNS cache file format is 'minsince1970 ipaddress resolved_hostname'
546
<br># or just 'ipaddress resolved_hostname'
547
<br># Example: "/mydnscachedir/dnscache"
548
<br># Default: "dnscache.txt"
550
<br>DNSStaticCacheFile="dnscache.txt"
554
<a name="DNSLastUpdateCacheFile"><b>DNSLastUpdateCacheFile</b></a><br>
555
<b>Version : </b>5.0+<br>
556
<br># AWStats can do reverse DNS lookups through a DNS cache file that was created
557
<br># by a previous run of AWStats. This file is erased and recreated after each
558
<br># statistics update process. You don't need to create and/or edit it.
559
<br># AWStats will read and save this file in DirData directory.
560
<br># This option is used only if DNSLookup=1.
561
<br># Note: If a DNSStaticCacheFile is available, AWStats will check for DNS
562
<br># lookup in DNSLastUpdateCacheFile after checking into DNSStaticCacheFile.
563
<br># Example: "/mydnscachedir/dnscachelastupdate"
564
<br># Default: "dnscachelastupdate.txt"
566
<br>DNSLastUpdateCacheFile="dnscachelastupdate.txt"
570
<a name="SkipDNSLookupFor"><b>SkipDNSLookupFor</b></a><br>
571
<b>Version : </b>3.0+ (5.6+ for REGEX syntax)<br>
572
<br># You can specify specific IP addresses that should NOT be looked up in DNS.
573
<br># This option is used only if DNSLookup=1.
574
<br># Note: Use space between each value.
575
<br># Note: You can use regular expression values writing value with REGEX[value].
576
<br># Change : Effective for new updates only
577
<br># Example: "123.123.123.123 REGEX[^192\.168\.]"
580
<br>SkipDNSLookupFor=""
584
<a name="AllowAccessFromWebToAuthenticatedUsersOnly"><b>AllowAccessFromWebToAuthenticatedUsersOnly</b></a><br>
585
<b>Version : </b>4.0+<br>
586
<br># The following two parameters allow you to protect a config file from being
587
<br># read by AWStats when called from a browser if web user has not been
588
<br># authenticated. Your AWStats program must be in a web protected "realm" (With
589
<br># Apache, you can use .htaccess files to do so. With other web servers, see
590
<br># your server setup manual).
591
<br># Change : Effective immediatly
592
<br># Possible values: 0 or 1
595
<br>AllowAccessFromWebToAuthenticatedUsersOnly=0
599
<a name="AllowAccessFromWebToFollowingAuthenticatedUsers"><b>AllowAccessFromWebToFollowingAuthenticatedUsers</b></a><br>
600
<b>Version : </b>4.0+<br>
601
<br># This parameter gives the list of all authorized authenticated users to view
602
<br># statistics for this domain/config file. This parameter is used only if
603
<br># AllowAccessToAuthenticatedUsersOnly is set to 1.
604
<br># Change : Effective immediatly
605
<br># Example: "user1 user2"
608
<br>AllowAccessFromWebToFollowingAuthenticatedUsers=""
612
<a name="AllowAccessFromWebToFollowingIPAddresses"><b>AllowAccessFromWebToFollowingIPAddresses</b></a><br>
613
<b>Version : </b>5.0+<br>
614
<br># When this parameter is defined to something, the IP address of the user that
615
<br># read its statistics from a browser (when AWStats is used as a CGI) is
616
<br># checked and must match one of the IP address values or ranges.
617
<br># Change : Effective immediatly
618
<br># Example: "127.0.0.1 123.123.123.1-123.123.123.255"
621
<br>AllowAccessFromWebToFollowingIPAddresses=""
625
<a name="CreateDirDataIfNotExists"><b>CreateDirDataIfNotExists</b></a><br>
626
<b>Version : </b>4.0+<br>
627
<br># If the "DirData" directory (see above) does not exists, AWStats return an
628
<br># error. However, you can ask AWStats to create it.
629
<br># This option can be used by some Web Hosting Providers that has defined a
630
<br># dynamic value for DirData (for example DirData="/home/__REMOTE_USER__") and
631
<br># don't want to have to create a new directory each time they add a new user.
632
<br># Change : Effective immediatly
633
<br># Possible values: 0 or 1
636
<br>CreateDirDataIfNotExists=1
640
<a name="BuildHistoryFormat"><b>BuildHistoryFormat</b></a><br>
641
<b>Version : </b>6.0+<br>
642
<br># If you can choose in which format tha awstats history database is saved.
643
<br># For the moment, only text is supported.
644
<br># Possible values: text
647
<br>BuildHistoryFormat=text
651
<a name="BuildReportFormat"><b>BuildReportFormat</b></a><br>
652
<b>Version : </b>6.0+<br>
653
<br># If you prefer having the report output pages be built as XML compliant pages
654
<br># instead of simple HTML pages, you can set this to 'xml' (May not works
655
<br># properly with some browsers).
656
<br># Possible values: html or xml
659
<br>BuildReportFormat=html
663
<a name="SaveDatabaseFilesWithPermissionsForEveryone"><b>SaveDatabaseFilesWithPermissionsForEveryone</b></a><br>
664
<b>Version : </b>4.0+<br>
665
<br># In most case, AWStats is used as a cgi program. So AWStats process is ran
666
<br># by default web server user (nobody for Unix, IUSR_xxx for IIS/Windows,...).
667
<br># To make use easier and avoid permission problems between update process
668
<br># (run by an admin user) and CGI process (ran by a low level user), AWStats
669
<br># save its database files with read and write for everyone.
670
<br># If you have experience on managing security policies (Web Hosting Provider),
671
<br># you should set this parameter to 0. AWStats will keep default process user
672
<br># permissions on its files.
673
<br># Possible values: 0 or 1
676
<br>SaveDatabaseFilesWithPermissionsForEveryone=1
680
<a name="PurgeLogFile"><b>PurgeLogFile</b></a><br>
681
<b>Version : </b>2.23+<br>
682
<br># AWStats can purge log file, after analyzing it. Note that AWStats is able
683
<br># to detect new lines in a log file, to process only them, so you can launch
684
<br># AWStats as often as you want, even with this parameter to 0.
685
<br># With 0, no purge is made, so you must use a scheduled task or a web server
686
<br># that make this purge frequently.
687
<br># With 1, the purge of the log file is made each time AWStats is ran.
688
<br># This parameter doesn't work with IIS (This web server doesn't let its log
689
<br># file to be purged).
690
<br># Possible values: 0 or 1
697
<a name="ArchiveLogRecords"><b>ArchiveLogRecords</b></a><br>
698
<b>Version : </b>2.1+<br>
699
<br># When PurgeLogFile is setup to 1, AWStats will clean your log file after
700
<br># processing it. You can however keep an archive file (saved in "DirData") of
701
<br># all processed log records by setting this to 1 (For example if you want to
702
<br># use another log analyzer).
703
<br># This parameter is not used if PurgeLogFile=0
704
<br># Possible values: 0 or 1
707
<br>ArchiveLogRecords=0
711
<a name="KeepBackupOfHistoricFiles"><b>KeepBackupOfHistoricFiles</b></a><br>
712
<b>Version : </b>3.2+<br>
713
<br># Each time you run the update process, AWStats overwrite the 'historic file'
714
<br># for the month (awstatsMMYYYY[.*].txt) with the updated one.
715
<br># When write errors occurs (IO, disk full,...), this historic file can be
716
<br># corrupted and must be deleted. Because this file contains information of all
717
<br># past processed log files, you will loose old stats if removed. So you can
718
<br># ask AWStats to save last non corrupted file in a .bak file. This file is
719
<br># stored in "DirData" directory with other 'historic files'.
720
<br># Possible values: 0 or 1
723
<br>KeepBackupOfHistoricFiles=0
727
<a name="DefaultFile"><b>DefaultFile</b></a><br>
728
<b>Version : </b>1.0+ (5.0+ can accept several values)<br>
729
<br># Default index page name for your web server.
730
<br># Example: "default.htm default.html"
731
<br># Default: "index.html"
733
<br>DefaultFile="index.html"
737
<a name="SkipHosts"><b>SkipHosts</b></a><br>
738
<b>Version : </b>1.0+ (5.6+ for REGEX syntax)<br>
739
<br># Do not include access from clients that match following criteria.
740
<br># If your log file contains IP adresses in host field, you must enter here
741
<br># matching IP adresses criteria.
742
<br># If DNS lookup is already done in your log file, you must enter here hostname
743
<br># criteria, else enter ip address criteria.
744
<br># The opposite parameter of "SkipHosts" is "OnlyHosts".
745
<br># Note: Use space between each value.
746
<br># Note: You can use regular expression values writing value with REGEX[value].
747
<br># Change : Effective for new updates only
748
<br># Example: "127.0.0.1 REGEX[^192\.168\.] REGEX[^10\.0\.0\.]"
749
<br># Example: "localhost REGEX[^.*\.localdomain$]"
756
<a name="SkipUserAgents"><b>SkipUserAgents</b></a><br>
757
<b>Version : </b>5.1+ (5.6+ for REGEX syntax)<br>
758
<br># Do not include access from clients with a user agent that match following
759
<br># criteria. If you want to exclude a robot, you should update the robots.pm
760
<br># file instead of this parameter.
761
<br># The opposite parameter of "SkipUserAgents" is "OnlyUserAgents".
762
<br># Note: Use space between each value. This parameter is not case sensitive.
763
<br># Note: You can use regular expression values writing value with REGEX[value].
764
<br># Change : Effective for new updates only
765
<br># Example: "konqueror REGEX[ua_test_v\d\.\d]"
768
<br>SkipUserAgents=""
772
<a name="SkipFiles"><b>SkipFiles</b></a><br>
773
<b>Version : </b>1.0+ (5.6+ for REGEX syntax)<br>
774
<br># Use SkipFiles to ignore access to URLs that match one of following entries.
775
<br># You can enter a list of not important URLs (like framed menus, hidden pages,
776
<br># etc...) to exclude them from statistics. You must enter here exact relative
777
<br># URL as found in log file, or a matching REGEX value.
778
<br># For example, to ignore /badpage.html, just add "/badpage.html". To ignore
779
<br># all pages in a particular directory, add "REGEX[^\/directorytoexclude]".
780
<br># The opposite parameter of "SkipFiles" is "OnlyFiles".
781
<br># Note: Use space between each value. This parameter is not case sensitive.
782
<br># Note: You can use regular expression values writing value with REGEX[value].
783
<br># Change : Effective for new updates only
784
<br># Example: "/badpage.html REGEX[^\/excludedirectory]"
791
<a name="OnlyHosts"><b>OnlyHosts</b></a><br>
792
<b>Version : </b>5.2+ (5.6+ for REGEX syntax)<br>
793
<br># Include in stats, only accesses from hosts that match one of following
794
<br># entries. For example, if you want AWStats to filter access to keep only
795
<br># stats for visits from particular hosts, you can add those hosts names in
796
<br># this parameter.
797
<br># If DNS lookup is already done in your log file, you must enter here hostname
798
<br># criteria, else enter ip address criteria.
799
<br># The opposite parameter of "OnlyHosts" is "SkipHosts".
800
<br># Note: Use space between each value. This parameter is not case sensitive.
801
<br># Note: You can use regular expression values writing value with REGEX[value].
802
<br># Change : Effective for new updates only
803
<br># Example: "127.0.0.1 REGEX[^192\.168\.] REGEX[^10\.0\.0\.]"
810
<a name="OnlyUserAgents"><b>OnlyUserAgents</b></a><br>
811
<b>Version : </b>5.8+<br>
812
<br># Include in stats, only accesses from user agent that match one of following
813
<br># entries. For example, if you want AWStats to filter access to keep only
814
<br># stats for visits from particular browsers, you can add their user agents
815
<br># string in this parameter.
816
<br># The opposite parameter of "OnlyUserAgents" is "SkipUserAgents".
817
<br># Note: Use space between each value. This parameter is not case sensitive.
818
<br># Note: You can use regular expression values writing value with REGEX[value].
819
<br># Change : Effective for new updates only
820
<br># Example: "msie"
823
<br>OnlyUserAgents=""
827
<a name="OnlyFiles"><b>OnlyFiles</b></a><br>
828
<b>Version : </b>3.0+ (5.6+ for REGEX syntax)<br>
829
<br># Include in stats, only accesses to URLs that match one of following entries.
830
<br># For example, if you want AWStats to filter access to keep only stats that
831
<br># match a particular string, like a particular directory, you can add this
832
<br># directory name in this parameter.
833
<br># The opposite parameter of "OnlyFiles" is "SkipFiles".
834
<br># Note: Use space between each value. This parameter is not case sensitive.
835
<br># Note: You can use regular expression values writing value with REGEX[value].
836
<br># Change : Effective for new updates only
837
<br># Example: "REGEX[marketing_directory] REGEX[office\/.*\.(csv|sxw)$]"
844
<a name="NotPageList"><b>NotPageList</b></a><br>
845
<b>Version : </b>3.2+<br>
846
<br># Add here a list of kind of url (file extension) that must be counted as
847
<br># "Hit only" and not as a "Hit" and "Page/Download". You can set here all
848
<br># images extensions as they are hit downloaded that must be counted but they
849
<br># are not viewed pages. URLs with such extensions are not included in the TOP
850
<br># Pages/URL report.
851
<br># Note: If you want to exclude particular URLs from stats (No Pages and no
852
<br># Hits reported), you must use SkipFiles parameter.
853
<br># Example: "css js class gif jpg jpeg png bmp zip arj gz z wav mp3 wma mpg"
855
<br># Default: "css js class gif jpg jpeg png bmp"
857
<br>NotPageList="css js class gif jpg jpeg png bmp"
861
<a name="ValidHTTPCodes"><b>ValidHTTPCodes</b></a><br>
862
<b>Version : </b>4.0+<br>
863
<br># By default, AWStats considers that records found in log file are successful
864
<br># hits if HTTP code returned by server is a valid HTTP code (200 and 304).
865
<br># Any other code are reported in HTTP error chart.
866
<br># However in some specific environment, with web server HTTP redirection,
867
<br># you can choose to also accept other codes.
868
<br># Example: "200 304 302 305"
869
<br># Default: "200 304"
871
<br>ValidHTTPCodes="200 304"
873
<br><u>This is examples of current HTTP codes</u>
875
<br>#[Miscellaneous successes]
876
<br>"2xx", "[Miscellaneous successes]",
877
<br>"200", "OK", # HTTP request OK
878
<br>"201", "Created",
879
<br>"202", "Request recorded, will be executed later",
880
<br>"203", "Non-authoritative information",
881
<br>"204", "Request executed",
882
<br>"205", "Reset document",
883
<br>"206", "Partial Content",
884
<br>#[Miscellaneous redirections]
885
<br>"3xx", "[Miscellaneous redirections]",
886
<br>"300", "Multiple documents available",
887
<br>"301", "Moved Permanently",
889
<br>"303", "See other document",
890
<br>"304", "Not Modified since last retrieval", # HTTP request OK
891
<br>"305", "Use proxy",
892
<br>"306", "Switch proxy",
893
<br>"307", "Document moved temporarily",
894
<br>#[Miscellaneous client/user errors]
895
<br>"4xx", "[Miscellaneous client/user errors]",
896
<br>"400", "Bad Request",
897
<br>"401", "Unauthorized",
898
<br>"402", "Payment required",
899
<br>"403", "Forbidden",
900
<br>"404", "Document Not Found",
901
<br>"405", "Method not allowed",
902
<br>"406", "ocument not acceptable to client",
903
<br>"407", "Proxy authentication required",
904
<br>"408", "Request Timeout",
905
<br>"409", "Request conflicts with state of resource",
906
<br>"410", "Document gone permanently",
907
<br>"411", "Length required",
908
<br>"412", "Precondition failed",
909
<br>"413", "Request too long",
910
<br>"414", "Requested filename too long",
911
<br>"415", "Unsupported media type",
912
<br>"416", "Requested range not valid",
914
<br>#[Miscellaneous server errors]
915
<br>"5xx", "[Miscellaneous server errors]",
916
<br>"500", "Internal server Error",
917
<br>"501", "Not implemented",
918
<br>"502", "Received bad response from real server",
919
<br>"503", "Server busy",
920
<br>"504", "Gateway timeout",
921
<br>"505", "HTTP version not supported",
922
<br>"506", "Redirection failed",
924
<br>"xxx" ,"[Unknown]"
929
<a name="ValidSMTPCodes"><b>ValidSMTPCodes</b></a><br>
930
<b>Version : </b>5.0+<br>
931
<br># By default, AWStats considers that records found in mail log file are
932
<br># successful mail transfers if field that represent return code in analyzed
933
<br># log file match values defined by this parameter.
934
<br># Change : Effective for new updates only
935
<br># Example: "1 250 200"
936
<br># Default: "1 250"
938
<br>ValidSMTPCodes="1 250"
942
<a name="AuthenticatedUsersNotCaseSensitive"><b>AuthenticatedUsersNotCaseSensitive</b></a><br>
943
<b>Version : </b>5.3+<br>
944
<br># Some web servers on some Operating systems (IIS-Windows) considers that a
945
<br># login with same value but different case are the same login. To tell AWStats
946
<br># to also considers them as one, set this parameter to 1.
947
<br># Possible values: 0 or 1
950
<br>AuthenticatedUsersNotCaseSensitive=0
954
<a name="URLNotCaseSensitive"><b>URLNotCaseSensitive</b></a><br>
955
<b>Version : </b>5.1+<br>
956
<br># Some web servers on some Operating systems (IIS-Windows) considers that two
957
<br># URLs with same value but different case are the same URL. To tell AWStats to
958
<br># also considers them as one, set this parameter to 1.
959
<br># Possible values: 0 or 1
962
<br>URLNotCaseSensitive=0
966
<a name="URLWithAnchor"><b>URLWithAnchor</b></a><br>
967
<b>Version : </b>5.4+<br>
968
<br># Keep or remove the anchor string you can find in some URLs.
969
<br># Possible values: 0 or 1
976
<a name="URLQuerySeparators"><b>URLQuerySeparators</b></a><br>
977
<b>Version : </b>5.2+<br>
978
<br># In URL links, "?" char is used to add parameter's list in URLs. Syntax is:
979
<br># /mypage.html?param1=value1
980
<br># However, some servers/sites have also others chars to isolate dynamic part of
981
<br># their URLs. You can complete this list with all such characters.
985
<br>URLQuerySeparators="?;"
989
<a name="URLWithQuery"><b>URLWithQuery</b></a><br>
990
<b>Version : </b>3.2+<br>
991
<br># Keep or remove the query string to the URL in the statistics for individual
992
<br># pages. This is primarily used to differentiate between the URLs of dynamic
993
<br># pages. If set to 1, mypage.html?id=x and mypage.html?id=y are counted as two
994
<br># different pages.
995
<br># Warning, when set to 1, memory required to run AWStats is dramatically
996
<br># increased if you have a lot of changing URLs (for example URLs with a random
997
<br># id inside). Such web sites should not set this option to 1 or use seriously
998
<br># the next parameter URLWithQueryWithoutFollowingParameters.
999
<br># Possible values:
1000
<br># 0 - URLs are cleaned from the query string (ie: "/mypage.html")
1001
<br># 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y")
1008
<a name="URLWithQueryWithOnlyFollowingParameters"><b>URLWithQueryWithOnlyFollowingParameters</b></a><br>
1009
<b>Version : </b>6.0+<br>
1010
<br># When URLWithQuery is on, you will get the full URL with all parameters in
1011
<br># URL reports. But among thoose parameters, sometimes you don't need a
1012
<br># particular parameter because it does not identify the page or because it's
1013
<br># a random ID changing for each access even if URL points to same page. In
1014
<br># such cases, it is higly recommanded to ask AWStats to keep only parameters
1015
<br># you need (if you know them) before counting, manipulating and storing URL.
1016
<br># Enter here list of wanted parameters. For example, with "param", one hit on
1017
<br># /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r
1018
<br># will be reported as 2 hits on /mypage.cgi?param=abc
1019
<br># This parameter is not used when URLWithQuery is 0 and can't be used with
1020
<br># URLWithQueryWithoutFollowingParameters.
1021
<br># Change : Effective for new updates only
1022
<br># Example: "param"
1025
<br>URLWithQueryWithOnlyFollowingParameters=""
1029
<a name="URLWithQueryWithoutFollowingParameters"><b>URLWithQueryWithoutFollowingParameters</b></a><br>
1030
<b>Version : </b>5.1+<br>
1031
<br># When URLWithQuery is on, you will get the full URL with all parameters in
1032
<br># URL reports. But among thoose parameters, sometimes you don't need a
1033
<br># particular parameter because it does not identify the page or because it's
1034
<br># a random ID changing for each access even if URL points to same page. In
1035
<br># such cases, it is higly recommanded to ask AWStats to remove such parameters
1036
<br># from the URL before counting, manipulating and storing URL. Enter here list
1037
<br># of all non wanted parameters. For example, if you enter "id", one hit on
1038
<br># /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r
1039
<br># will be reported as 2 hits on /mypage.cgi?param=abc
1040
<br># This parameter is not used when URLWithQuery is 0 and can't be used with
1041
<br># URLWithQueryWithOnlyFollowingParameters.
1042
<br># Change : Effective for new updates only
1043
<br># Example: "PHPSESSID jsessionid"
1046
<br>URLWithQueryWithoutFollowingParameters=""
1050
<a name="URLReferrerWithQuery"><b>URLReferrerWithQuery</b></a><br>
1051
<b>Version : </b>5.1+<br>
1052
<br># Keep or remove the query string to the referrer URL in the statistics for
1053
<br># external referrer pages. This is used to differentiate between the URLs of
1054
<br># dynamic referrer pages. If set to 1, mypage.html?id=x and mypage.html?id=y
1055
<br># are counted as two different referrer pages.
1056
<br># Possible values:
1057
<br># 0 - Referrer URLs are cleaned from the query string (ie: "/mypage.html")
1058
<br># 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y")
1061
<br>URLReferrerWithQuery=0
1065
<a name="WarningMessages"><b>WarningMessages</b></a><br>
1066
<b>Version : </b>1.0+<br>
1067
<br># AWStats can detect setup problems or show you important informations to have
1068
<br># a better use. Keep this to 1, except if AWStats says you can change it.
1069
<br># Possible values: 0 or 1
1072
<br>WarningMessages=1
1076
<a name="ErrorMessages"><b>ErrorMessages</b></a><br>
1077
<b>Version : </b>5.2+<br>
1078
<br># When an error occurs, AWStats output a message related to errors. If you
1079
<br># want (in most cases for security reasons) to have no error messages, you
1080
<br># can set this parameter to your personalized generic message.
1081
<br># Example: "An error occured. Contact your Administrator"
1084
<br>ErrorMessages=""
1088
<a name="DebugMessages"><b>DebugMessages</b></a><br>
1089
<b>Version : </b>5.2+<br>
1090
<br># AWStat can be run with debug=x parameter to ouput various informations
1091
<br># to help in debugging or solving troubles. If you want (in most cases for
1092
<br># security reasons) to disable debugging, set this parameter to 0.
1093
<br># Possible values: 0 or 1
1100
<a name="NbOfLinesForCorruptedLog"><b>NbOfLinesForCorruptedLog</b></a><br>
1101
<b>Version : </b>3.2+<br>
1102
<br># To help you to detect if your log format is good, AWStats report an error
1103
<br># if all the first NbOfLinesForCorruptedLog lines have a format that does not
1104
<br># match the LogFormat parameter.
1105
<br># However, some worm virus attack on your web server can result in a very high
1106
<br># number of corrupted lines in your log. So if you experience awstats stop
1107
<br># because of bad virus records at the beginning of your log file, you can
1108
<br># increase this parameter (very rare).
1111
<br>NbOfLinesForCorruptedLog=50
1115
<a name="SplitSearchString"><b>SplitSearchString</b></a><br>
1116
<font color="#808080">
1117
<b>Version : </b>2.24 - 4.0 (deprecated since 4.1)<br>
1118
This parameter has been removed since 4.1.<br>
1119
AWStats 4.1+ supports both keywords AND keyphrases by default with no need of any parameter.<br>
1124
<a name="WrapperScript"><b>WrapperScript</b></a><br>
1125
<b>Version : </b>4.0+<br>
1126
<br># For some particular integration needs, you may want to have CGI links to
1127
<br># point to another script than awstats.pl.
1128
<br># Use the name of this script in WrapperScript parameter.
1129
<br># Example: "awstatslauncher.pl"
1132
<br>WrapperScript=""
1136
<a name="DecodeUA"><b>DecodeUA</b></a><br>
1137
<b>Version : </b>5.0+<br>
1138
<br># DecodeUA must be set to 1 if you use Roxen web server. This server converts
1139
<br># all spaces in user agent field into %20. This make the AWStats robots, os
1140
<br># and browsers detection fail in some cases. Just change it to 1 if and only
1141
<br># if your web server is Roxen.
1142
<br># Possible values: 0 or 1
1149
<a name="MiscTrackerUrl"><b>MiscTrackerUrl</b></a><br>
1150
<b>Version : </b>5.6+<br>
1151
<br># MiscTrackerUrl can be used to make AWStats able to detect some miscellanous
1152
<br># things, that can not be tracked on other way like:
1154
<br># - Screen color depth
1155
<br># - Java enabled
1156
<br># - Macromedia Director plugin
1157
<br># - Macromedia Shockwave plugin
1158
<br># - Realplayer G2 plugin
1159
<br># - QuickTime plugin
1160
<br># - Mediaplayer plugin
1161
<br># - Acrobat PDF plugin
1162
<br># To enable all this features, you must copy the awstats_misc_tracker.js file
1163
<br># into a /js/ directory stored in your web document root and add the following
1164
<br># HTML code at the end of your index page (before </BODY>) :
1165
<br># <i><script language=javascript src="/js/awstats_misc_tracker.js"></script></i>
1166
<br># If code is not added in index page, all this detection capabilities will be
1167
<br># disabled. You must also check that ShowScreenSizeStats and ShowMiscStats
1168
<br># parameters are set to 1 to make results appear in report page.
1169
<br># If you want to use another directory than /js/, you must also change the
1170
<br># awstatsmisctrackerurl variable into the awstats_misc_tracker.js file.
1171
<br># Change : Effective for new updates only.
1172
<br># Possible value: Full URL of javascript tracker file added in HTML code
1173
<br># Default: "/js/awstats_misc_tracker.js"
1175
<br>MiscTrackerUrl="/js/awstats_misc_tracker.js"
1179
<a name="LevelFor"><b>LevelFor</b></a><br>
1180
<b>Version : </b>4.0+<br>
1181
6.0+ for LevelForFileTypesDetection, LevelForSearchEnginesDetection, LevelForKeywordsDetection, LevelForWormsDetection<br>
1182
<br># Following values allows you to define accuracy of AWStats entities (robots,
1183
<br># browsers, os, referers, file types) detection.
1184
<br># It might be a good idea for large web sites or ISP that provides AWStats to
1185
<br># high number of customers, to set this parameter to 1 (or 0), instead of 2.
1186
<br># Possible values:
1187
<br># 0 = No detection,
1188
<br># 1 = Medium/Standard detection
1189
<br># 2 = Full detection
1190
<br># Change : Effective for new updates only
1191
<br># Default: 2 (0 for LevelForWormsDetection)
1193
<br>LevelForBrowsersDetection=2 # 0 disables Browsers detection.
1194
<br> # 2 reduces AWStats speed by 2%
1195
<br>LevelForOSDetection=2 # 0 disables OS detection.
1196
<br> # 2 reduces AWStats speed by 3%
1197
<br>LevelForRefererAnalyze=2 # 0 disables Origin detection.
1198
<br> # 2 reduces AWStats speed by 14%
1199
<br>LevelForRobotsDetection=2 # 0 disables Robots detection.
1200
<br> # 2 reduces AWStats speed by 2.5%
1201
<br>LevelForSearchEnginesDetection=2 # 0 disables Search engines detection.
1202
<br> # 2 reduces AWStats speed by 9%
1203
<br>LevelForKeywordsDetection=2 # 0 disables Keyphrases/Keywords detection.
1204
<br> # 2 reduces AWStats speed by 1%
1205
<br>LevelForFileTypesDetection=2 # 0 disables File types detection.
1206
<br> # 2 reduces AWStats speed by 1%
1207
<br>LevelForWormsDetection=0 # 0 disables Worms detection.
1208
<br> # 2 reduces AWStats speed by 15%
1212
<a name="UseFramesWhenCGI"><b>UseFramesWhenCGI</b></a><br>
1213
<b>Version : </b>5.0+<br>
1214
<br># When you use AWStats as a CGI, you can have the reports shown in HTML views.
1215
<br># Frames are only available for report viewed dynamically. When you build
1216
<br># pages from command line, this option is not used and no frames are built.
1217
<br># Possible values: 0 or 1
1220
<br>UseFramesWhenCGI=1
1224
<a name="DetailedReportsOnNewWindows"><b>DetailedReportsOnNewWindows</b></a><br>
1225
<b>Version : </b>4.1+ (5.0+ for value 2)<br>
1226
<br># This parameter ask your browser to open detailed reports into a different
1227
<br># window than the main page.
1228
<br># Possible values:
1229
<br># 0 - Open all in same browser window
1230
<br># 1 - Open detailed reports in another window except if using frames
1231
<br># 2 - Open always in a different window even if reports are framed
1234
<br>DetailedReportsOnNewWindows=1
1238
<a name="Expires"><b>Expires</b></a><br>
1239
<b>Version : </b>3.1+<br>
1240
<br># You can add, in the HTML report page, a cache lifetime (in seconds) that
1241
<br># will be returned to browser in HTTP header answer by server.
1242
<br># This parameter is not used when report are built with -staticlinks option.
1250
<a name="MaxRowsInHTMLOutput"><b>MaxRowsInHTMLOutput</b></a><br>
1251
<b>Version : </b>4.0+<br>
1252
<br># To avoid too large web pages, you can ask AWStats to limit number of rows of
1253
<br># all reported charts to this number when no other limit apply.
1256
<br>MaxRowsInHTMLOutput=1000
1260
<a name="Lang"><b>Lang</b></a><br>
1261
<b>Version : </b>2.1+<br>
1262
<br># Set your primary language.
1263
<br># Possible value:
1264
<br># Albanian=al, Bosnian=ba, Bulgarian=bg,
1265
<br># Chinese (Taiwan)=tw, Chinese (Simpliefied)=cn, Czech=cz,
1266
<br># Danish=dk, Dutch=nl, English=en, Estonian=et, Finnish=fi, French=fr,
1267
<br># German=de, Greek=gr, Hebrew=he, Hungarian=hu, Indonesian=id, Italian=it,
1268
<br># Japanese=jp, Korean=kr, Latvian=lv, Norwegian (Nynorsk)=nn,
1269
<br># Norwegian (Bokmal)=nb, Polish=pl, Portuguese=pt, Portuguese (Brazilian)=br,
1270
<br># Romanian=ro, Russian=ru, Serbian=sr, Slovak=sk, Spanish=es,
1271
<br># Spanish (Catalan)=es_cat, Swedish=se, Turkish=tr, Ukrainian=ua, Welsh=wlk.
1272
<br># First available language accepted by browser=auto
1273
<br># Default: "auto"
1279
<a name="DirLang"><b>DirLang</b></a><br>
1280
<b>Version : </b>2.1+<br>
1281
<br># Set the location of language files.
1282
<br># Example: "/usr/share/awstats/lang"
1283
<br># Default: "./lang" (means lang directory is in same location than awstats.pl)
1285
<br>DirLang="./lang"
1289
<a name="Show"><b>Show...</b></a><br>
1290
<b>Version : </b><br>
1291
<font color="#808080">3.2 - 5.3 for ShowHeader (deprecated since 5.4)</font><br>
1292
3.2+ for ShowMenu,ShowMonthStats,ShowDaysOfWeekStats,ShowHoursStats,
1293
ShowDomainsStats,ShowHostsStats,ShowAuthenticatedUsers,ShowRobotsStats,
1294
ShowPagesStats,ShowFileTypesStats,ShowFileSizesStats,ShowBrowsersStats,
1295
ShowOSStats,ShowOriginStats,ShowKeyphrasesStats,ShowKeywordsStats,ShowHTTPErrorsStats<br>
1296
<font color="#808080">3.2 - 5.0 for ShowCompressionStats (deprecated since 5.1, use code C with ShowFileTypesStats instead)</font><br>
1297
4.1+ for ShowSessionsStats, ShowKeywordsStats<br>
1298
5.1+ for all letters codes<br>
1299
5.5+ for ShowDaysOfMonthStats<br>
1300
5.6+ for ShowMiscStats,ShowSTMPErrorsStats<br>
1301
5.8+ for ShowClusterStats<br>
1302
6.0+ for ShowWormsStats<br>
1303
<br># You choose here which reports you want to see in the main page and what you
1304
<br># want to see in those reports.
1305
<br># Possible values:
1306
<br># 0 - Topic is not shown at all
1307
<br># 1 - Report is shown with default informations
1308
<br># XYZ - Report is shown with only informations defined by code X,Y,Z...
1309
<br># X,Y,Z... are code letters among the following:
1310
<br># U = Unique visitors
1312
<br># P = Number of pages
1313
<br># H = Number of hits (or mails)
1314
<br># B = Bandwith (or total mail size for mail logs)
1315
<br># L = Last access date
1316
<br># E = Entry pages
1317
<br># X = Exit pages
1318
<br># C = Web compression (mod_gzip,mod_deflate)
1319
<br># M = Average mail size (mail logs)
1321
<br># Show menu header with report links
1322
<br># Default: 1, Possible codes: None
1324
<br># Show monthly chart
1325
<br># Default: UVPHB, Possible codes: UVPHB
1326
<br>ShowMonthStats=UVPHB
1327
<br># Show days of month chart
1328
<br># Default: VPHB, Possible codes: VPHB
1329
<br>ShowDaysOfMonthStats=VPHB
1330
<br># Show days of week chart
1331
<br># Default: PHB, Possible codes: PHB
1332
<br>ShowDaysOfWeekStats=PHB
1333
<br># Show hourly chart
1334
<br># Default: PHB, Possible codes: PHB
1335
<br>ShowHoursStats=PHB
1336
<br># Show domains/country chart
1337
<br># Default: PHB, Possible codes: PHB
1338
<br>ShowDomainsStats=PHB
1339
<br># Show hosts chart
1340
<br># Default: PHBL, Possible codes: PHBL
1341
<br>ShowHostsStats=PHBL
1342
<br># Show authenticated users chart
1343
<br># Default: 0, Possible codes: PHBL
1344
<br>ShowAuthenticatedUsers=0
1345
<br># Show robots chart
1346
<br># Default: HBL, Possible codes: HBL
1347
<br>ShowRobotsStats=HBL
1348
<br># Show worms chart
1349
<br># Default: 0 (See also LevelForWormsDetection if set), Possible codes: HBL
1350
<br>ShowWormsStats=0
1351
<br># Show email senders chart (For use when analyzing mail log files)
1352
<br># Default: 0, Possible codes: HBML
1353
<br>ShowEMailSenders=0
1354
<br># Show email receivers chart (For use when analyzing mail log files)
1355
<br># Default: 0, Possible codes: HBML
1356
<br>ShowEMailReceivers=0
1357
<br># Show session chart
1358
<br># Default: 1, Possible codes: None
1359
<br>ShowSessionsStats=1
1360
<br># Show pages-url chart.
1361
<br># Default: PBEX, Possible codes: PBEX
1362
<br>ShowPagesStats=PBEX
1363
<br># Show file types chart.
1364
<br># Default: HB, Possible codes: HBC
1365
<br>ShowFileTypesStats=HB
1366
<br># Show file size chart (Not yet available)
1367
<br># Default: 1, Possible codes: None
1368
<br>ShowFileSizesStats=0
1369
<br># Show operating systems chart
1370
<br># Default: 1, Possible codes: None
1372
<br># Show browsers chart
1373
<br># Default: 1, Possible codes: None
1374
<br>ShowBrowsersStats=1
1375
<br># Show screen size chart
1376
<br># Default: 0 (See also MiscTrackerUrl if set to 1), Possible codes: None
1377
<br>ShowScreenSizeStats=0
1378
<br># Show origin chart
1379
<br># Default: PH, Possible codes: HB
1380
<br>ShowOriginStats=PH
1381
<br># Show keyphrases chart
1382
<br># Default: 1, Possible codes: None
1383
<br>ShowKeyphrasesStats=1
1384
<br># Show keywords chart
1385
<br># Default: 1, Possible codes: None
1386
<br>ShowKeywordsStats=1
1387
<br># Show misc chart
1388
<br># Default: a (See also MiscTrackerUrl parameter), Possible codes: ajdfrqwp
1390
<br># Show http errors chart
1391
<br># Default: 1, Possible codes: None
1392
<br>ShowHTTPErrorsStats=1
1393
<br># Show smtp errors chart (For use when analyzing mail log files)
1394
<br># Default: 0, Possible codes: None
1395
<br>ShowSMTPErrorsStats=0
1396
<br># Show the cluster report (Your LogFormat must contains the %cluster tag)
1397
<br># Default: 0, Possible codes: PHB
1398
<br>ShowClusterStats=0
1402
<a name="AddDataArray"><b>AddDataArray...</b></a><br>
1403
<b>Version : </b><br>
1404
5.4+ for AddDataArrayMonthStats,AddDataArrayShowDaysOfWeekStats,AddDataArrayShowHoursStats<br>
1405
5.5+ for AddDataArrayShowDaysOfMonthStats<br>
1406
<br># Some graphical reports are followed by the data array of values.
1407
<br># If you don't want this array (to reduce report size for example), you can
1408
<br># set thoose options to 0.
1409
<br># Possible values: 0 or 1
1412
<br># Data array values for the ShowMonthStats report
1413
<br>AddDataArrayMonthStats=1
1414
<br># Data array values for the ShowDaysOfMonthStats report
1415
<br>AddDataArrayShowDaysOfMonthStats=1
1416
<br># Data array values for the ShowDaysOfWeekStats report
1417
<br>AddDataArrayShowDaysOfWeekStats=1
1418
<br># Data array values for the ShowHoursStats report
1419
<br>AddDataArrayShowHoursStats=1
1423
<a name="Max"><b>Max...</b></a><br>
1424
<b>Version : </b>1.0+<br>
1425
<br># This value can be used to choose maximum number of lines shown for each
1426
<br># particular reporting.
1428
<br># Stats by domains
1429
<br>MaxNbOfDomain = 10
1430
<br>MinHitDomain = 1
1431
<br># Stats by hosts
1432
<br>MaxNbOfHostsShown = 10
1434
<br># Stats by authenticated users
1435
<br>MaxNbOfLoginShown = 10
1437
<br># Stats by robots
1438
<br>MaxNbOfRobotShown = 10
1440
<br># Stats by pages
1441
<br>MaxNbOfPageShown = 10
1444
<br>MaxNbOfOsShown = 10
1446
<br># Stats by browsers
1447
<br>MaxNbOfBrowsersShown = 10
1448
<br>MinHitBrowser = 1
1449
<br># Stats by screen size
1450
<br>MaxNbOfScreenSizesShown = 5
1451
<br>MinHitScreenSize = 1
1452
<br># Stats by referers
1453
<br>MaxNbOfRefererShown = 10
1455
<br># Stats for keywords
1456
<br>MaxNbOfKeywordsShown = 10
1457
<br>MinHitKeyword = 1
1458
<br># Stats for sender or receiver emails
1459
<br>MaxNbOfEMailsShown = 20
1464
<a name="FirstDayOfWeek"><b>FirstDayOfWeek</b></a><br>
1465
<b>Version : </b>3.2+<br>
1466
<br># Choose if you want week to start on sunday or monday
1467
<br># Possible values:
1468
<br># 0 - Week start on sunday
1469
<br># 1 - Week start on monday
1472
<br>FirstDayOfWeek=1
1476
<a name="ShowFlagLinks"><b>ShowFlagLinks</b></a><br>
1477
<b>Version : </b>3.2+<br>
1478
<br># List of visible flags with link to other language translations.
1479
<br># See Lang parameter for list of allowed flag/language codes.
1480
<br># If you don't want any flag link, set ShowFlagLinks to "".
1481
<br># This parameter is used only if ShowMenu parameter is set to 1.
1482
<br># Possible values: "" or "language_codes_separated_by_space"
1483
<br># Default: "en es fr it nl es"
1485
<br>ShowFlagLinks="en fr de it nl es"
1489
<a name="ShowLinksOnUrl"><b>ShowLinksOnUrl</b></a><br>
1490
<b>Version : </b>3.1+<br>
1491
<br># Each URL shown in stats report views are links you can click.
1492
<br># Possible values: 0 or 1
1495
<br>ShowLinksOnUrl=1
1499
<a name="UseHTTPSLinkForUrl"><b>UseHTTPSLinkForUrl</b></a><br>
1500
<b>Version : </b>4.0+<br>
1501
<br># When AWStats build HTML links in its report pages, it starts thoose link
1502
<br># with "http://". However some links might be HTTPS links, so you can enter
1503
<br># here the root of all your HTTPS links. If all your site is a SSL web site,
1504
<br># just enter "/".
1505
<br># This parameter is not used if ShowLinksOnUrl is 0.
1506
<br># Example: "/shopping"
1510
<br>UseHTTPSLinkForUrl=""
1514
<a name="MaxLengthOfShownURL"><b>MaxLengthOfShownURL</b></a><br>
1515
<b>Version : </b>1.0+<br>
1516
<br># Maximum length of URL part shown on stats page (number of characters).
1517
<br># This affects only URL visible text, larger links still work.
1520
<br>MaxLengthOfShownURL=64
1524
<a name="ShowLinksToWhoIs"><b>ShowLinksToWhoIs</b></a><br>
1525
<font color="#808080">
1526
<b>Version : </b>4.0 - 5.6 (deprecated since 5.7, replaced by plugin 'hostinfo')<br>
1527
This parameter has been removed since 5.7.<br>
1528
You must enable the plugin 'hostinfo' to get the same result if you were using this
1534
<a name="LinksToWhoIs"><b>LinksToWhoIs</b></a><br>
1535
<font color="#808080">
1536
<b>Version : </b>4.0 - 5.9 (deprecated since 6.0, replaced by plugin 'hostinfo')<br>
1537
This parameter has been removed since 6.0.<br>
1538
This parameter is no more required.
1543
<a name="LinksToIPWhoIs"><b>LinksToIPWhoIs</b></a><br>
1544
<font color="#808080">
1545
<b>Version : </b>5.0 - 5.9 (deprecated since 6.0, replaced by plugin 'hostinfo')<br>
1546
This parameter has been removed since 6.0.<br>
1547
This parameter is no more required.
1552
<a name="HTMLHeadSection"><b>HTMLHeadSection</b></a><br>
1553
<b>Version : </b>3.2+<br>
1554
<br># You can enter HTML code that will be added at the top of AWStats reports.
1557
<br>HTMLHeadSection=""
1561
<a name="HTMLEndSection"><b>HTMLEndSection</b></a><br>
1562
<b>Version : </b>3.2+<br>
1563
<br># You can enter HTML code that will be added at the end of AWStats reports.
1564
<br># Great to add advert ban.
1567
<br>HTMLEndSection=""
1571
<a name="Bar"><b>Bar...</b></a><br>
1572
<b>Version : </b>1.0+<br>
1573
<br># Value of maximum bar width/height for horizontal/vertical HTML graphics bar.
1574
<br># Default: 260/90
1581
<a name="Logo"><b>Logo...</b></a><br>
1582
<b>Version : </b>3.1+<br>
1583
<br># You can set Logo and LogoLink to use your own logo.
1584
<br># Logo must be the name of image file (must be in $DirIcons/other directory).
1585
<br># LogoLink is the expected URL when clicking on Logo.
1586
<br># Default: "awstats_logo1.png"
1588
<br>Logo="awstats_logo1.png"
1589
<br>LogoLink="http://awstats.sourceforge.net"
1593
<a name="StyleSheet"><b>StyleSheet</b></a><br>
1594
<b>Version : </b>5.6+<br>
1595
<br># You can ask AWStats to use a particular CSS (Cascading Style Sheet) to
1596
<br># change its look. To create a style sheet, you can use samples provided with
1597
<br># AWStats in wwwroot/css directory.
1598
<br># Example: "/awstatscss/awstats_bw.css"
1599
<br># Example: "/css/awstats_bw.css"
1606
<a name="color_"><b>color_...</b></a><br>
1607
<b>Version : </b><br>
1608
3.1 for color_Background,color_TableBGTitle,color_TableTitle,color_TableBG,
1609
color_TableRowTitle,color_TableBGRowTitle,color_TableBorder,color_text,
1610
color_textpercent,color_titletext,color_weekend,color_link,color_hover,
1611
color_u,color_v,color_p,color_h,color_k,color_s<br>
1612
4.1 for color_e,color_x<br>
1613
5.0 for color_other<br>
1614
<br># Those colors parameters can be used (if StyleSheet parameter is not used)
1615
<br># to change AWStats look.
1616
<br># Example: color_name="RRGGBB" # RRGGBB is Red Green Blue components in Hex
1618
<br>color_Background="FFFFFF" # Background color for main page (Default = "FFFFFF")
1619
<br>color_TableBGTitle="CCCCDD" # Background color for table title (Default = "CCCCDD")
1620
<br>color_TableTitle="000000" # Table title font color (Default = "000000")
1621
<br>color_TableBG="CCCCDD" # Background color for table (Default = "CCCCDD")
1622
<br>color_TableRowTitle="FFFFFF" # Table row title font color (Default = "FFFFFF")
1623
<br>color_TableBGRowTitle="ECECEC" # Background color for row title (Default = "ECECEC")
1624
<br>color_TableBorder="ECECEC" # Table border color (Default = "ECECEC")
1625
<br>color_text="000000" # Color of text (Default = "000000")
1626
<br>color_textpercent="606060" # Color of text for percent values (Default = "606060")
1627
<br>color_titletext="000000" # Color of text title within colored Title Rows (Default = "000000")
1628
<br>color_weekend="EAEAEA" # Color for week-end days (Default = "EAEAEA")
1629
<br>color_link="0011BB" # Color of HTML links (Default = "0011BB")
1630
<br>color_hover="605040" # Color of HTML on-mouseover links (Default = "605040")
1631
<br>color_other="666688" # Color of text for 'other' record in charts (Default = "666688")
1632
<br>color_u="FFB055" # Background color for number of unique visitors (Default = "FFB055")
1633
<br>color_v="F8E880" # Background color for number of visites (Default = "F8E880")
1634
<br>color_p="4477DD" # Background color for number of pages (Default = "4477DD")
1635
<br>color_h="66F0FF" # Background color for number of hits (Default = "66F0FF")
1636
<br>color_k="2EA495" # Background color for number of bytes (Default = "2EA495")
1637
<br>color_s="8888DD" # Background color for number of search (Default = "8888DD")
1638
<br>color_e="CEC2E8" # Background color for number of entry pages (Default = "CEC2E8")
1639
<br>color_x="C1B2E2" # Background color for number of exit pages (Default = "C1B2E2")
1643
<a name="LoadPlugin"><b>LoadPlugin</b></a><br>
1644
<b>Version : </b>5.0+<br>
1645
<br># Add here all plugins file you want to load.
1646
<br># Plugin files must be .pm files stored in 'plugins' directory.
1647
<br># Uncomment LoadPlugin lines to enable a plugin after checking that plugin
1648
<br># required perl modules are installed.
1650
<br># Plugin: PluginName
1651
<br># PluginName description
1652
<br># Perl modules required: ...
1654
<br>LoadPlugin="pluginname"
1658
<a name="Extra"><b>Extra...</b></a><br>
1659
<b>Version : </b><br>
1661
5.8 for ExtraSectionFirstColumnFormatX, ExtraSectionAddAverageRowX, ExtraSectionAddSumRowX<br>
1662
<br># You can define your own charts, you choose here what are rows and columns
1663
<br># keys. This feature is particularly usefull for marketing purpose, tracking
1664
<br># products orders for example.
1665
<br># For this, edit all parameters of Extra section. Each set of parameter is a
1666
<br># different chart. For several charts, duplicate section changing the number.
1667
<br># Note that each Extra section reduces AWStats speed by 10%.
1669
<br># WARNING: A wrong setup of Extra section can result in a too large arrays
1670
<br># that will consume all your memory, making AWStats unusable after several
1671
<br># updates, so be sure to setup it correctly.
1672
<br># In most cases, you don't need this feature.
1674
<br># ExtraSectionNameX is title of your personalized chart.
1675
<br># ExtraSectionConditionalX are conditions you can use to count or not the hit,
1676
<br># Use one of the field condition (URL, QUERY_STRING, REFERER, UA, HOST)
1677
<br># and string to match after a coma. Use "|" for "OR". If you can also use
1678
<br># several conditions, they will be combined as "AND".
1679
<br># ExtraSectionFirstColumnTitleX is the first column title of the chart.
1680
<br># ExtraSectionFirstColumnValuesX is a Regex string to tell AWStats in which
1681
<br># field to extract value from (URL, QUERY_STRING, REFERER, UA, HOST) and how
1682
<br># to extract the value. Each different value found will appear in first
1683
<br># column of report on a different row. Be sure that list of different values
1684
<br># is "limited" to avoid "not enough memory" problems !
1685
<br># ExtraSectionFirstColumnFormatX is the string used to write value.
1686
<br># ExtraSectionStatTypesX are things you want to count. You can use standard
1687
<br># code letters (P for pages,H for hits,B for bandwidth,L for last access).
1688
<br># ExtraSectionAddAverageRowX add a row at bottom of chart with average values.
1689
<br># ExtraSectionAddSumRowX add a row at bottom of chart with sum values.
1690
<br># MaxNbOfExtraX is maximum number of rows shown in chart.
1691
<br># MinHitExtraX is minimum number of hits required to be shown in chart.
1694
<br># Example to report the 20 products the most ordered by "order.cgi" script
1695
<br>ExtraSectionName1="Product orders"
1696
<br>ExtraSectionCondition1="URL,/cgi-bin/order.cgi|URL,/cgi-bin/order2.cgi"
1697
<br>ExtraSectionFirstColumnTitle1="Product ID"
1698
<br>ExtraSectionFirstColumnValues1="QUERY_STRING,productid=([^&]+)"
1699
<br>ExtraSectionFirstColumnFormat1="%s"
1700
<br>ExtraSectionStatTypes1=PL
1701
<br>ExtraSectionAddAverageRow1=0
1702
<br>ExtraSectionAddSumRow1=1<br>
1703
<br>MaxNbOfExtra1=20
1708
<a name="Include"><b>Include</b></a><br>
1709
<b>Version : </b>5.4+<br>
1710
<br># You can include other config files using the directive with the name of the
1712
<br># This is particularly usefull for users who have a lot of virtual servers, so
1713
<br># a lot of config files and want to maintain common values in only one file.
1714
<br># Note that when a variable is defined both in a config file and in an
1715
<br># included file, AWStats will use the last value read.
1720
<!-- -------------------------------------------------------------------------------------- -->
1724
<script language=javascript>
1725
var date='$Date: 2004/01/07 07:12:05 $';
1726
document.writeln("Last revision: "+date);
added
removed
docs/awstats_config.html
