1 rizwank 1.1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html>
3 <head>
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.172 $ - $Author: eldy $ - $Date: 2005/01/22 15:38:04 $ -->
11 </head>
12
13 <body topmargin=10 leftmargin=5>
14
15
16 <table style="font: 10pt arial,helvetica,verdana" cellpadding=0 cellspacing=0 border=0 bgcolor=#FFFFFF width=100%>
17
18 <!-- Large -->
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>
22 rizwank 1.1 <br>
23 <font style="font: 16pt arial,helvetica,sans-serif" color=#EEEEFF><b>AWStats logfile analyzer 6.3 Documentation</b></font><br>
24 <br>
25 </td>
26 <td bgcolor=#9999cc align=center>
27
28 </td>
29 </tr>
30
31 </table>
32
33
34 <br><br><H1 style="font: 26px arial,helvetica,sans-serif">AWStats configuration directives/options</H1>
35 <!-- -------------------------------------------------------------------------------------- -->
36
37 <br>Each directives available in the AWStats config file (.conf) is listed here.<br>
38 They are described using a consistent format.<br>
39 <br>
40 <b>Notes</b>
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 rizwank 1.1 <i>Parameter="__ENVNAME__"</i>
44 <br>
45 <br>
46 <br>
47 <br><b>MAIN SETUP SECTION (Required to make AWStats work)</b><br>
48 <ul>
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>
61 </ul>
62
63
64 rizwank 1.1 <br><b>OPTIONAL SETUP SECTION (Not required but increase AWStats features)</b><br>
65 <ul>
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 rizwank 1.1 <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>
106 rizwank 1.1 </ul>
107
108 <br><b>OPTIONAL ACCURACY SETUP SECTION (Not required but increase AWStats features)</b><br>
109 <ul>
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>
118
119 </ul>
120
121 <br><b>OPTIONAL APPEARANCE SETUP SECTION (Not required but increase AWStats features)</b><br>
122 <ul>
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 rizwank 1.1 <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 rizwank 1.1 <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="#IncludeInternalLinksInOriginSection">IncludeInternalLinksInOriginSection</a>
160 <li><a href="#Max">MaxNbOfDomain</a>
161 <li><a href="#Max">MinHitDomain</a>
162 <li><a href="#Max">MaxNbOfHostsShown</a>
163 <li><a href="#Max">MinHitHost</a>
164 <li><a href="#Max">MaxNbOfLoginShown</a>
165 <li><a href="#Max">MinHitLogin</a>
166 <li><a href="#Max">MaxNbOfRobotShown</a>
167 <li><a href="#Max">MinHitRobot</a>
168 <li><a href="#Max">MaxNbOfPageShown</a>
169 rizwank 1.1 <li><a href="#Max">MaxNbOfOsShown</a>
170 <li><a href="#Max">MinHitOs</a>
171 <li><a href="#Max">MaxNbOfBrowsersShown</a>
172 <li><a href="#Max">MinHitBrowser</a>
173 <li><a href="#Max">MinHitFile</a>
174 <li><a href="#Max">MaxNbOfScreenSizesShown</a>
175 <li><a href="#Max">MinHitScreenSize</a>
176 <li><a href="#Max">MaxNbOfRefererShown</a>
177 <li><a href="#Max">MinHitRefer</a>
178 <li><a href="#Max">MaxNbOfKeywordsShown</a>
179 <li><a href="#Max">MinHitKeyword</a>
180 <li><a href="#FirstDayOfWeek">FirstDayOfWeek</a>
181 <li><a href="#ShowFlagLinks">ShowFlagLinks</a>
182 <li><a href="#ShowLinksOnUrl">ShowLinksOnUrl</a>
183 <li><a href="#MaxLengthOfURL">MaxLengthOfURL</a>
184 <li><a href="#ShowLinksToWhoIs">ShowLinksToWhoIs</a>
185 <li><a href="#UseHTTPSLinksForUrl">UseHTTPSLinksForUrl</a>
186 <li><a href="#LinksToWhoIs">LinksToWhoIs</a>
187 <li><a href="#LinksToIPWhoIs">LinksToIPWhoIs</a>
188 <li><a href="#HTMLHeadSection">HTMLHeadSection</a>
189 <li><a href="#HTMLEndSection">HTMLEndSection</a>
190 rizwank 1.1 <li><a href="#Bar">BarWidth</a>
191 <li><a href="#Bar">BarHeight</a>
192 <li><a href="#Logo">Logo</a>
193 <li><a href="#Logo">LogoLink</a>
194 <li><a href="#StyleSheet">StyleSheet</a>
195 <li><a href="#color_">color_Background</a>
196 <li><a href="#color_">color_TableBGTitle</a>
197 <li><a href="#color_">color_TableTitle</a>
198 <li><a href="#color_">color_TableBG</a>
199 <li><a href="#color_">color_TableRowTitle</a>
200 <li><a href="#color_">color_TableBGRowTitle</a>
201 <li><a href="#color_">color_TableBorder</a>
202 <li><a href="#color_">color_text</a>
203 <li><a href="#color_">color_titletext</a>
204 <li><a href="#color_">color_weekend</a>
205 <li><a href="#color_">color_link</a>
206 <li><a href="#color_">color_hover</a>
207 <li><a href="#color_">color_u</a>
208 <li><a href="#color_">color_v</a>
209 <li><a href="#color_">color_p</a>
210 <li><a href="#color_">color_h</a>
211 rizwank 1.1 <li><a href="#color_">color_k</a>
212 <li><a href="#color_">color_s</a>
213 <li><a href="#color_">color_e</a>
214 <li><a href="#color_">color_x</a>
215 </ul>
216
217 <br><b>PLUGINS</b><br>
218 <ul>
219 <li><a href="#LoadPlugin">LoadPlugin</a>
220 </ul>
221
222 <br><b>EXTRA</b><br>
223 <ul>
224 <li><a href="#Extra">ExtraSectionNameX</a>
225 <li><a href="#Extra">ExtraSectionCodeFilterX</a>
226 <li><a href="#Extra">ExtraSectionConditionX</a>
227 <li><a href="#Extra">ExtraSectionFirstColumnTitleX</a>
228 <li><a href="#Extra">ExtraSectionFirstColumnValuesX</a>
229 <li><a href="#Extra">ExtraSectionFirstColumnFormatX</a>
230 <li><a href="#Extra">ExtraSectionStatTypesX</a>
231 <li><a href="#Extra">ExtraSectionAddAverageRowX</a>
232 rizwank 1.1 <li><a href="#Extra">ExtraSectionAddSumRowX</a>
233 <li><a href="#Extra">MaxNbOfExtraX</a>
234 <li><a href="#Extra">MinHitExtraX</a>
235 <li><a href="#ExtraTrackedRowsLimit">ExtraTrackedRowsLimit</a>
236 </ul>
237
238 <br><b>INCLUDES</b><br>
239 <ul>
240 <li><a href="#Include">Include</a>
241 </ul>
242
243
244
245 <br><br><hr>
246
247 <a name="LogFile"><b>LogFile</b></a><br>
248 <b>Version : </b>1.0+<br>
249 3.1+ for tags %YYYY-n,%YY-n,%MM-n,%DD-n,%HH-n<br>
250 3.2+ for tag %WM-n<br>
251 4.0+ for tag %DW-n<br>
252 4.1+ for tag %NS-n<br>
253 rizwank 1.1 5.0+ for tag %WY-n<br>
254 5.1+ for tag %Wm-n, %Wy-n, %Dw-n<br>
255 <br># "LogFile" contains the web, ftp or mail server logfile to analyze.
256 <br># You can use a full path or relative path from awstats.pl directory.
257 <br># Example: "/var/log/apache/access.log"
258 <br># Example: "../logs/mycombinedlog.log"
259 <br># You can also use tags in this filename if you need a dynamic file name
260 <br># depending on date or time (Replacement is made by AWStats at the beginning
261 <br># of its execution). This is available tags :
262 <br># %YYYY-n is replaced with 4 digits year we were n hours ago
263 <br># %YY-n is replaced with 2 digits year we were n hours ago
264 <br># %MM-n is replaced with month we were n hours ago
265 <br># %MO-n is replaced with 3 letters month we were n hours ago
266 <br># %DD-n is replaced with day we were n hours ago
267 <br># %HH-n is replaced with hour we were n hours ago
268 <br># %NS-n is replaced with number of seconds at 00:00 since 1970
269 <br># %WM-n is replaced with the week number in month (1-5)
270 <br># %Wm-n is replaced with the week number in month (0-4)
271 <br># %WY-n is replaced with the week number in year (01-52)
272 <br># %Wy-n is replaced with the week number in year (00-51)
273 <br># %DW-n is replaced with the day number in week (1-7, 1=sunday)
274 rizwank 1.1 <br># use n=24 if you need (1-7, 1=monday)
275 <br># %Dw-n is replaced with the day number in week (0-6, 0=sunday)
276 <br># use n=24 if you need (0-6, 0=monday)
277 <br># Use 0 for n if you need current year, month, day, hour...
278 <br># Example: "/var/log/access_log.%YYYY-0%MM-0%DD-0.log"
279 <br># Example: "C:/WINNT/system32/LogFiles/W3SVC1/ex%YY-24%MM-24%DD-24.log"
280 <br># You can also use a pipe if log file come from a pipe.
281 <br># Example: "gzip -d </var/log/apache/access.log.gz |"
282 <br># If there is several log files from load balancing servers :
283 <br># Example: "/pathtotools/logresolvemerge.pl *.log |"
284 <br>#
285 <br>LogFile="/var/log/httpd/mylog.log"
286
287 <br><br><hr>
288
289 <a name="LogType"><b>LogType</b></a><br>
290 <b>Version : </b>5.7+<br>
291 <br># Enter the log file type you want to analyze.
292 <br># Possible values:
293 <br># W - For a web log file
294 <br># M - For a mail log file
295 rizwank 1.1 <br># F - For a ftp log file
296 <br># Example: W
297 <br># Default: W
298 <br>#
299 <br>LogType=W
300
301 <br><br><hr>
302
303 <a name="LogFormat"><b>LogFormat</b></a><br>
304 <b>Version : </b>2.1+<br>
305 3.1+ for tags %host,%logname,%time1,%time2,%methodurl,%methodurlnoprot,%method,%url,
306 %query,%code,%bytesd,%refererquot,%referer,%uaquot,%ua,%other<br>
307 3.2+ for tags %gzipin,%gzipout<br>
308 4.0+ for tags %gzipratio,%syslog<br>
309 4.1+ for tag %virtualname<br>
310 5.6+ for tag %deflateratio<br>
311 6.1+ for tag %time4<br>
312 6.2+ for tag %time3<br>
313 <br># Enter here your log format (Must agree with your web server. See setup
314 <br># instructions in README.txt to know how to configure your web server to have
315 <br># the required log format).
316 rizwank 1.1 <br># Possible values: 1,2,3,4 or "your_own_personalized_log_format"
317 <br># 1 - Apache or Lotus Notes/Domino native combined log format (NCSA combined/XLF/ELF log format)
318 <br># 2 - Old IIS log format (IIS W3C log format). See FAQ for IIS 6.x.
319 <br># 3 - Webstar native log format.
320 <br># 4 - Apache or Squid native common log format (NCSA common/CLF log format)
321 <br># With LogFormat=4, some features (browsers, os, keywords...) can't work.
322 <br># "your_own_personalized_log_format" = If your log is ftp, mail or other format,
323 <br># you must use following keys to define the log format string (See FAQ
324 <br># for ftp, mail or exotic web log format examples):
325 <br># %host Host client name or IP address
326 <br># %lognamequot Authenticated login/user with format: "alex"
327 <br># %logname Authenticated login/user with format: alex
328 <br># %time1 Date and time with format: [dd/mon/yyyy:hh:mm:ss +0000] or [dd/mon/yyyy:hh:mm:ss]
329 <br># %time2 Date and time with format: yyyy-mm-dd hh-mm-ss
330 <br># %time3 Date and time with format: Mon dd hh:mm:ss or Mon dd hh:mm:ss yyyy
331 <br># %time4 Date and time with unix timestamp format: dddddddddd
332 <br># %methodurl Method and URL with format: "GET /index.html HTTP/x.x"
333 <br># %methodurlnoprot Method and URL with format: "GET /index.html"
334 <br># %method Method with format: GET
335 <br># %url URL only with format: /index.html
336 <br># %query Query string (used by URLWithQuery option)
337 rizwank 1.1 <br># %code Return code status (with format for web log: 999)
338 <br># %bytesd Size of document in bytes
339 <br># %refererquot Referer page with format: "http://from.com/from.htm"
340 <br># %referer Referer page with format: http://from.com/from.htm
341 <br># %uaquot User agent with format: "Mozilla/4.0 (compatible, ...)"
342 <br># %ua User agent with format: Mozilla/4.0_(compatible...)
343 <br># %gzipin mod_gzip compression input bytes: In:XXX
344 <br># %gzipout mod_gzip compression output bytes & ratio: Out:YYY:ZZpct.
345 <br># %gzipratio mod_gzip compression ratio: ZZpct.
346 <br># %deflateratio mod_deflate compression ratio with format: (ZZ)
347 <br># %email EMail sender (for mail log)
348 <br># %email_r EMail receiver (for mail log)
349 <br># %virtualname Web sever virtual hostname. Use this tag when same log
350 <br># contains data of several virtual web servers. AWStats
351 <br># will discard records not in SiteDomain nor HostAliases
352 <br># %cluster If log file is provided from several computers (merged by
353 <br># logresolvemerge.pl), this tag define field of cluster id.
354 <br># If your log format has some fields not included in this list, use
355 <br># %other Means another field
356 <br>#
357 <br># Examples for Apache combined logs (following two examples are equivalent):
358 rizwank 1.1 <br># LogFormat = 1
359 <br># LogFormat = "%host %other %logname %time1 %methodurl %code %bytesd %refererquot %uaquot"
360 <br>#
361 <br># Examples for IIS (following two examples are equivalent):
362 <br># LogFormat = 2
363 <br># LogFormat = "%time2 %host %logname %method %url %code %bytesd %other %ua %referer"
364 <br>#
365 <br>LogFormat=1
366
367 <br><br><hr>
368
369 <a name="LogSeparator"><b>LogSeparator</b></a><br>
370 <b>Version : </b>5.0+<br>
371 <br># If your log field's separator is not a space, you can change this parameter.
372 <br># This parameter is not used if LogFormat is a predefined value (1,2,3,4)
373 <br># Example: " "
374 <br># Example: "\t"
375 <br># Example: "|"
376 <br># Default: " "
377 <br>#
378 <br>LogSeparator=" "
379 rizwank 1.1
380 <br><br><hr>
381
382 <a name="DNSLookup"><b>DNSLookup</b></a><br>
383 <b>Version : </b>1.0+ (5.0+ for value 2) <br>
384 <br># If you want to have hosts reported by name instead of ip address, AWStats
385 <br># need to make reverse DNS lookups (if not already done in your log file).
386 <br># With DNSLookup to 0, all hosts will be reported by their IP addresses and
387 <br># not by the full hostname of visitors (except if names are already available
388 <br># in log file).
389 <br># If you want/need to set DNSLookup to 1, don't forget that this will reduce
390 <br># dramatically AWStats update process speed. Do not use on large web sites.
391 <br># Note: Reverse DNS lookup is done on IPv4 only (Enable ipv6 plugin for IPv6).
392 <br># Note: Result of DNS Lookup can be used to build the Country report. However
393 <br># it is highly recommanded to enable the plugin 'geoipfree' or 'geoip' to
394 <br># have an accurate Country report with no need of DNS Lookup.
395 <br># Possible values:
396 <br># 0 - No DNS Lookup
397 <br># 1 - DNS Lookup is fully enabled
398 <br># 2 - DNS Lookup is made only from static DNS cache file (if it exists)
399 <br># Default: 2
400 rizwank 1.1 <br>#
401 <br>DNSLookup=2
402
403 <br><br><hr>
404
405 <a name="DirData"><b>DirData</b></a><br>
406 <b>Version : </b>1.0+<br>
407 <br># When AWStats updates its statistics, it stores results of its analysis in
408 <br># files (AWStats database). All those files are written in the directory
409 <br># defined by the "DirData" parameter. Set this value to the directory where
410 <br># you want AWStats to save its database and working files into.
411 <br># Warning: If you want to be able to use the "AllowToUpdateStatsFromBrowser"
412 <br># feature (see later), you need write permissions by webserver user on this
413 <br># directory.
414 <br># Example: "/var/lib/awstats"
415 <br># Example: "../data"
416 <br># Example: "C:/awstats_data_dir"
417 <br># Default: "." (means same directory as awstats.pl)
418 <br>#
419 <br>DirData="."
420
421 rizwank 1.1 <br><br><hr>
422
423 <a name="DirCgi"><b>DirCgi</b></a><br>
424 <b>Version : </b>1.0+<br>
425 <br># Relative or absolute web URL of your awstats cgi-bin directory.
426 <br># This parameter is used only when AWStats is ran from command line
427 <br># with -output option (to generate links in HTML reported page).
428 <br># Example: "/awstats"
429 <br># Default: "/cgi-bin" (means awstats.pl is in "/yourwwwroot/cgi-bin")
430 <br>#
431 <br>DirCgi="/cgi-bin"
432
433 <br><br><hr>
434
435 <a name="DirIcons"><b>DirIcons</b></a><br>
436 <b>Version : </b>1.0+<br>
437 <br># Relative or absolute web URL of your awstats icon directory.
438 <br># If you build static reports ("... -output > outputpath/output.html"), enter
439 <br># path of icon directory relative to the output directory 'outputpath'.
440 <br># Example: "/awstatsicons"
441 <br># Example: "../icon"
442 rizwank 1.1 <br># Default: "/icon" (means you must copy icon directories in "/mywwwroot/icon")
443 <br>#
444 <br>DirIcons="/icon"
445
446 <br><br><hr>
447
448 <a name="SiteDomain"><b>SiteDomain</b></a><br>
449 <b>Version : </b>3.2+<br>
450 <br># "SiteDomain" must contain the main domain name or the main intranet web
451 <br># server name used to reach the web site.
452 <br># If you share the same log file for several virtual web servers, this
453 <br># parameter is used to tell AWStats to filter record that contains records for
454 <br># this virtual host name only (So check that this virtual hostname can be
455 <br># found in your log file and use a personalized log format that include the
456 <br># %virtualname tag).
457 <br># But for multi hosting a better solution is to have one log file for each
458 <br># virtual web server. In this case, this parameter is only used to generate
459 <br># full URL's links when ShowLinksOnUrl option is set to 1.
460 <br># If analysing mail log, enter here the domain name of mail server.
461 <br># Example: "myintranetserver"
462 <br># Example: "www.domain.com"
463 rizwank 1.1 <br># Example: "ftp.domain.com"
464 <br># Example: "domain.com"
465 <br>#
466 <br>SiteDomain=""
467
468 <br><br><hr>
469
470 <a name="HostAliases"><b>HostAliases</b></a><br>
471 <b>Version : </b>1.0+ (5.6+ for REGEX syntax)<br>
472 <br># Enter here all other possible domain names, addresses or virtual host
473 <br># aliases someone can use to access your site. Try to keep only the minimum
474 <br># number of possible names/addresses to have the best performances.
475 <br># You can repeat the "SiteDomain" value in this list.
476 <br># This parameter is used to analyze referer field in log file and to help
477 <br># AWStats to know if a referer URL is a local URL of same site or an URL of
478 <br># another site.
479 <br># Note: Use space between each value.
480 <br># Note: You can use regular expression values writing value with REGEX[value].
481 <br># Example: "www.myserver.com localhost 127.0.0.1 REGEX[\.mydomain\.(net|org)$]"
482 <br>#
483 <br>HostAliases="localhost 127.0.0.1 REGEX[^.*\.myserver\.com$]"
484 rizwank 1.1
485 <br><br><hr>
486
487 <a name="AllowToUpdateStatsFromBrowser"><b>AllowToUpdateStatsFromBrowser</b></a><br>
488 <b>Version : </b>3.0+<br>
489 <br># When this parameter is set to 1, AWStats add a button on report page to
490 <br># allow to "update" statistics from a web browser. Warning, when "update" is
491 <br># made from a browser, AWStats is ran as a CGI by the web server user
492 <br># defined in your web server (user "nobody" by default with Apache, "IUSR_XXX"
493 <br># with IIS), so the "DirData" directory and all already existing history files
494 <br># (awstatsMMYYYY[.xxx].txt) must be writable by this user. Change permissions
495 <br># if required.
496 <br># Warning: Update process can be long so you might experience "time out"
497 <br># browser errors if you don't launch AWStats enough frequently.
498 <br># When set to 0, update is only made when AWStats is ran from the command
499 <br># line interface (or a task scheduler).
500 <br># Possible values: 0 or 1
501 <br># Default: 0
502 <br>#
503 <br>AllowToUpdateStatsFromBrowser=0
504
505 rizwank 1.1 <br><br><hr>
506
507 <a name="AllowFullYearView"><b>AllowFullYearView</b></a><br>
508 <b>Version : </b>5.9+<br>
509 <br># AWStats save and sort its database on a month basis, this allows to build
510 <br># build a report quickly. However, if you choose the -month=all from command
511 <br># line or value '-Year-' from CGI combo form to have a report for all year,
512 <br># AWStats needs to reload all data for full year, and resort them completely,
513 <br># requiring a large amount of time, memory and CPU. This might be a problem
514 <br># for web hosting providers that offer AWStats for large sites on shared
515 <br># servers to non CPU cautious customers.
516 <br># For this reason, the 'full year' is only enable on Command Line by default.
517 <br># You can change this by setting this parameter to 0, 1, 2 or 3.
518 <br># Possible values:
519 <br># 0 - Never allowed
520 <br># 1 - Allowed on CLI only, -Year- value in combo is not visible
521 <br># 2 - Allowed on CLI only, -Year- value in combo is visible but not allowed
522 <br># 3 - Possible on CLI and CGI
523 <br># Default: 2
524 <br>#
525 <br>AllowFullYearView=2
526 rizwank 1.1
527 <br><br><hr>
528
529 <a name="EnableLockForUpdate"><b>EnableLockForUpdate</b></a><br>
530 <b>Version : </b>5.0+<br>
531 <br># When the update process run, AWStats can set a lock file in TEMP or TMP
532 <br># directory. This lock is to avoid to have 2 update processes running at the
533 <br># same time to prevent unknown conflicts problems and avoid DoS attacks when
534 <br># AllowToUpdateStatsFromBrowser is set to 1.
535 <br># Because, when you use lock file, you can experience sometimes problems in
536 <br># lock file not correctly removed (killed process for example requires that
537 <br># you remove the file manualy), this option is not enabled by default (Do
538 <br># not enable this option with no console server access).
539 <br># Possible values: 0 or 1
540 <br># Default: 0
541 <br>#
542 <br>EnableLockForUpdate=0
543
544 <br><br><hr>
545
546 <a name="DNSStaticCacheFile"><b>DNSStaticCacheFile</b></a><br>
547 rizwank 1.1 <b>Version : </b>5.0+<br>
548 <br># AWStats can do reverse DNS lookups through a static DNS cache file that was
549 <br># previously created manually. If no path is given in static DNS cache file
550 <br># name, AWStats will search DirData directory. This file is never changed.
551 <br># This option is not used if DNSLookup=0.
552 <br># Note: DNS cache file format is 'minsince1970 ipaddress resolved_hostname'
553 <br># or just 'ipaddress resolved_hostname'
554 <br># Example: "/mydnscachedir/dnscache"
555 <br># Default: "dnscache.txt"
556 <br>#
557 <br>DNSStaticCacheFile="dnscache.txt"
558
559 <br><br><hr>
560
561 <a name="DNSLastUpdateCacheFile"><b>DNSLastUpdateCacheFile</b></a><br>
562 <b>Version : </b>5.0+<br>
563 <br># AWStats can do reverse DNS lookups through a DNS cache file that was created
564 <br># by a previous run of AWStats. This file is erased and recreated after each
565 <br># statistics update process. You don't need to create and/or edit it.
566 <br># AWStats will read and save this file in DirData directory.
567 <br># This option is used only if DNSLookup=1.
568 rizwank 1.1 <br># Note: If a DNSStaticCacheFile is available, AWStats will check for DNS
569 <br># lookup in DNSLastUpdateCacheFile after checking into DNSStaticCacheFile.
570 <br># Example: "/mydnscachedir/dnscachelastupdate"
571 <br># Default: "dnscachelastupdate.txt"
572 <br>#
573 <br>DNSLastUpdateCacheFile="dnscachelastupdate.txt"
574
575 <br><br><hr>
576
577 <a name="SkipDNSLookupFor"><b>SkipDNSLookupFor</b></a><br>
578 <b>Version : </b>3.0+ (5.6+ for REGEX syntax)<br>
579 <br># You can specify specific IP addresses that should NOT be looked up in DNS.
580 <br># This option is used only if DNSLookup=1.
581 <br># Note: Use space between each value.
582 <br># Note: You can use regular expression values writing value with REGEX[value].
583 <br># Change : Effective for new updates only
584 <br># Example: "123.123.123.123 REGEX[^192\.168\.]"
585 <br># Default: ""
586 <br>#
587 <br>SkipDNSLookupFor=""
588
589 rizwank 1.1 <br><br><hr>
590
591 <a name="AllowAccessFromWebToAuthenticatedUsersOnly"><b>AllowAccessFromWebToAuthenticatedUsersOnly</b></a><br>
592 <b>Version : </b>4.0+<br>
593 <br># The following two parameters allow you to protect a config file from being
594 <br># read by AWStats when called from a browser if web user has not been
595 <br># authenticated. Your AWStats program must be in a web protected "realm" (With
596 <br># Apache, you can use .htaccess files to do so. With other web servers, see
597 <br># your server setup manual).
598 <br># Change : Effective immediatly
599 <br># Possible values: 0 or 1
600 <br># Default: 0
601 <br>#
602 <br>AllowAccessFromWebToAuthenticatedUsersOnly=0
603
604 <br><br><hr>
605
606 <a name="AllowAccessFromWebToFollowingAuthenticatedUsers"><b>AllowAccessFromWebToFollowingAuthenticatedUsers</b></a><br>
607 <b>Version : </b>4.0+<br>
608 <br># This parameter gives the list of all authorized authenticated users to view
609 <br># statistics for this domain/config file. This parameter is used only if
610 rizwank 1.1 <br># AllowAccessToAuthenticatedUsersOnly is set to 1.
611 <br># Change : Effective immediatly
612 <br># Example: "user1 user2"
613 <br># Default: ""
614 <br>#
615 <br>AllowAccessFromWebToFollowingAuthenticatedUsers=""
616
617 <br><br><hr>
618
619 <a name="AllowAccessFromWebToFollowingIPAddresses"><b>AllowAccessFromWebToFollowingIPAddresses</b></a><br>
620 <b>Version : </b>5.0+<br>
621 <br># When this parameter is defined to something, the IP address of the user that
622 <br># read its statistics from a browser (when AWStats is used as a CGI) is
623 <br># checked and must match one of the IP address values or ranges.
624 <br># Change : Effective immediatly
625 <br># Example: "127.0.0.1 123.123.123.1-123.123.123.255"
626 <br># Default: ""
627 <br>#
628 <br>AllowAccessFromWebToFollowingIPAddresses=""
629
630 <br><br><hr>
631 rizwank 1.1
632 <a name="CreateDirDataIfNotExists"><b>CreateDirDataIfNotExists</b></a><br>
633 <b>Version : </b>4.0+<br>
634 <br># If the "DirData" directory (see above) does not exists, AWStats return an
635 <br># error. However, you can ask AWStats to create it.
636 <br># This option can be used by some Web Hosting Providers that has defined a
637 <br># dynamic value for DirData (for example DirData="/home/__REMOTE_USER__") and
638 <br># don't want to have to create a new directory each time they add a new user.
639 <br># Change : Effective immediatly
640 <br># Possible values: 0 or 1
641 <br># Default: 0
642 <br>#
643 <br>CreateDirDataIfNotExists=1
644
645 <br><br><hr>
646
647 <a name="BuildHistoryFormat"><b>BuildHistoryFormat</b></a><br>
648 <b>Version : </b>6.0+<br>
649 <br># You can choose in which format the Awstats history database is saved.
650 <br># Note: Using "xml" format make AWStats building database files three times
651 <br># larger than using "text" format.
652 rizwank 1.1 <br># Change : Database format is switched after next update
653 <br># Possible values: text or xml
654 <br># Default: text
655 <br>#
656 <br>BuildHistoryFormat=text
657
658 <br><br><hr>
659
660 <a name="BuildReportFormat"><b>BuildReportFormat</b></a><br>
661 <b>Version : </b>6.0+<br>
662 <br># If you prefer having the report output pages be built as XML compliant pages
663 <br># instead of simple HTML pages, you can set this to 'xhtml' (May not works
664 <br># properly with old browsers).
665 <br># Possible values: html or xhtml
666 <br># Default: html
667 <br>#
668 <br>BuildReportFormat=html
669
670 <br><br><hr>
671
672 <a name="SaveDatabaseFilesWithPermissionsForEveryone"><b>SaveDatabaseFilesWithPermissionsForEveryone</b></a><br>
673 rizwank 1.1 <b>Version : </b>4.0+<br>
674 <br># AWStats databases can be updated from command line of from a browser (when
675 <br># used as a cgi program). So AWStats database files need write permission
676 <br># for both command line user and default web server user (nobody for Unix,
677 <br># IUSR_xxx for IIS/Windows,...).
678 <br># To avoid permission's problems between update process (run by an admin user)
679 <br># and CGI process (ran by a low level user), AWStats can save its database
680 <br># files with read and write permissions for everyone.
681 <br># By default, AWStats keep default user permissions on updated files. If you
682 <br># set AllowToUpdateStatsFromBrowser to 1, you can change this parameter to 1.
683 <br># Change : Effective for new updates only
684 <br># Possible values: 0 or 1
685 <br># Default: 0
686 <br>#
687 <br>SaveDatabaseFilesWithPermissionsForEveryone=0
688
689 <br><br><hr>
690
691 <a name="PurgeLogFile"><b>PurgeLogFile</b></a><br>
692 <b>Version : </b>2.23+<br>
693 <br># AWStats can purge log file, after analyzing it. Note that AWStats is able
694 rizwank 1.1 <br># to detect new lines in a log file, to process only them, so you can launch
695 <br># AWStats as often as you want, even with this parameter to 0.
696 <br># With 0, no purge is made, so you must use a scheduled task or a web server
697 <br># that make this purge frequently.
698 <br># With 1, the purge of the log file is made each time AWStats is ran.
699 <br># This parameter doesn't work with IIS (This web server doesn't let its log
700 <br># file to be purged).
701 <br># Possible values: 0 or 1
702 <br># Default: 0
703 <br>#
704 <br>PurgeLogFile=0
705
706 <br><br><hr>
707
708 <a name="ArchiveLogRecords"><b>ArchiveLogRecords</b></a><br>
709 <b>Version : </b>2.1+<br>
710 <br># When PurgeLogFile is setup to 1, AWStats will clean your log file after
711 <br># processing it. You can however keep an archive file (saved in "DirData") of
712 <br># all processed log records by setting this to 1 (For example if you want to
713 <br># use another log analyzer).
714 <br># This parameter is not used if PurgeLogFile=0
715 rizwank 1.1 <br># Possible values: 0 or 1
716 <br># Default: 0
717 <br>#
718 <br>ArchiveLogRecords=0
719
720 <br><br><hr>
721
722 <a name="KeepBackupOfHistoricFiles"><b>KeepBackupOfHistoricFiles</b></a><br>
723 <b>Version : </b>3.2+<br>
724 <br># Each time you run the update process, AWStats overwrite the 'historic file'
725 <br># for the month (awstatsMMYYYY[.*].txt) with the updated one.
726 <br># When write errors occurs (IO, disk full,...), this historic file can be
727 <br># corrupted and must be deleted. Because this file contains information of all
728 <br># past processed log files, you will loose old stats if removed. So you can
729 <br># ask AWStats to save last non corrupted file in a .bak file. This file is
730 <br># stored in "DirData" directory with other 'historic files'.
731 <br># Possible values: 0 or 1
732 <br># Default: 0
733 <br>#
734 <br>KeepBackupOfHistoricFiles=0
735
736 rizwank 1.1 <br><br><hr>
737
738 <a name="DefaultFile"><b>DefaultFile</b></a><br>
739 <b>Version : </b>1.0+ (5.0+ can accept several values)<br>
740 <br># Default index page name for your web server.
741 <br># Change : Effective for new updates only
742 <br># Example: "index.php index.html default.html"
743 <br># Default: "index.html"
744 <br>#
745 <br>DefaultFile="index.html"
746
747 <br><br><hr>
748
749 <a name="SkipHosts"><b>SkipHosts</b></a><br>
750 <b>Version : </b>1.0+ (5.6+ for REGEX syntax)<br>
751 <br># Do not include access from clients that match following criteria.
752 <br># If your log file contains IP adresses in host field, you must enter here
753 <br># matching IP adresses criteria.
754 <br># If DNS lookup is already done in your log file, you must enter here hostname
755 <br># criteria, else enter ip address criteria.
756 <br># The opposite parameter of "SkipHosts" is "OnlyHosts".
757 rizwank 1.1 <br># Note: Use space between each value.
758 <br># Note: You can use regular expression values writing value with REGEX[value].
759 <br># Change : Effective for new updates only
760 <br># Example: "127.0.0.1 REGEX[^192\.168\.] REGEX[^10\.0\.0\.]"
761 <br># Example: "localhost REGEX[^.*\.localdomain$]"
762 <br># Default: ""
763 <br>#
764 <br>SkipHosts=""
765
766 <br><br><hr>
767
768 <a name="SkipUserAgents"><b>SkipUserAgents</b></a><br>
769 <b>Version : </b>5.1+ (5.6+ for REGEX syntax)<br>
770 <br># Do not include access from clients with a user agent that match following
771 <br># criteria. If you want to exclude a robot, you should update the robots.pm
772 <br># file instead of this parameter.
773 <br># The opposite parameter of "SkipUserAgents" is "OnlyUserAgents".
774 <br># Note: Use space between each value. This parameter is not case sensitive.
775 <br># Note: You can use regular expression values writing value with REGEX[value].
776 <br># Change : Effective for new updates only
777 <br># Example: "konqueror REGEX[ua_test_v\d\.\d]"
778 rizwank 1.1 <br># Default: ""
779 <br>#
780 <br>SkipUserAgents=""
781
782 <br><br><hr>
783
784 <a name="SkipFiles"><b>SkipFiles</b></a><br>
785 <b>Version : </b>1.0+ (5.6+ for REGEX syntax)<br>
786 <br># Use SkipFiles to ignore access to URLs that match one of following entries.
787 <br># You can enter a list of not important URLs (like framed menus, hidden pages,
788 <br># etc...) to exclude them from statistics. You must enter here exact relative
789 <br># URL as found in log file, or a matching REGEX value.
790 <br># For example, to ignore /badpage.html, just add "/badpage.html". To ignore
791 <br># all pages in a particular directory, add "REGEX[^\/directorytoexclude]".
792 <br># The opposite parameter of "SkipFiles" is "OnlyFiles".
793 <br># Note: Use space between each value. This parameter is or not case sensitive
794 <br># depending on URLNotCaseSensitive parameter.
795 <br># Note: You can use regular expression values writing value with REGEX[value].
796 <br># Change : Effective for new updates only
797 <br># Example: "/badpage.html REGEX[^\/excludedirectory]"
798 <br># Default: ""
799 rizwank 1.1 <br>#
800 <br>SkipFiles=""
801
802 <br><br><hr>
803
804 <a name="OnlyHosts"><b>OnlyHosts</b></a><br>
805 <b>Version : </b>5.2+ (5.6+ for REGEX syntax)<br>
806 <br># Include in stats, only accesses from hosts that match one of following
807 <br># entries. For example, if you want AWStats to filter access to keep only
808 <br># stats for visits from particular hosts, you can add those hosts names in
809 <br># this parameter.
810 <br># If DNS lookup is already done in your log file, you must enter here hostname
811 <br># criteria, else enter ip address criteria.
812 <br># The opposite parameter of "OnlyHosts" is "SkipHosts".
813 <br># Note: Use space between each value. This parameter is not case sensitive.
814 <br># Note: You can use regular expression values writing value with REGEX[value].
815 <br># Change : Effective for new updates only
816 <br># Example: "127.0.0.1 REGEX[^192\.168\.] REGEX[^10\.0\.0\.]"
817 <br># Default: ""
818 <br>#
819 <br>OnlyHosts=""
820 rizwank 1.1
821 <br><br><hr>
822
823 <a name="OnlyUserAgents"><b>OnlyUserAgents</b></a><br>
824 <b>Version : </b>5.8+<br>
825 <br># Include in stats, only accesses from user agent that match one of following
826 <br># entries. For example, if you want AWStats to filter access to keep only
827 <br># stats for visits from particular browsers, you can add their user agents
828 <br># string in this parameter.
829 <br># The opposite parameter of "OnlyUserAgents" is "SkipUserAgents".
830 <br># Note: Use space between each value. This parameter is not case sensitive.
831 <br># Note: You can use regular expression values writing value with REGEX[value].
832 <br># Change : Effective for new updates only
833 <br># Example: "msie"
834 <br># Default: ""
835 <br>#
836 <br>OnlyUserAgents=""
837
838 <br><br><hr>
839
840 <a name="OnlyFiles"><b>OnlyFiles</b></a><br>
841 rizwank 1.1 <b>Version : </b>3.0+ (5.6+ for REGEX syntax)<br>
842 <br># Include in stats, only accesses to URLs that match one of following entries.
843 <br># For example, if you want AWStats to filter access to keep only stats that
844 <br># match a particular string, like a particular directory, you can add this
845 <br># directory name in this parameter.
846 <br># The opposite parameter of "OnlyFiles" is "SkipFiles".
847 <br># Note: Use space between each value. This parameter is or not case sensitive
848 <br># depending on URLNotCaseSensitive parameter.
849 <br># Note: You can use regular expression values writing value with REGEX[value].
850 <br># Change : Effective for new updates only
851 <br># Example: "REGEX[marketing_directory] REGEX[office\/.*\.(csv|sxw)$]"
852 <br># Default: ""
853 <br>#
854 <br>OnlyFiles=""
855
856 <br><br><hr>
857
858 <a name="NotPageList"><b>NotPageList</b></a><br>
859 <b>Version : </b>3.2+<br>
860 <br># Add here a list of kind of url (file extension) that must be counted as
861 <br># "Hit only" and not as a "Hit" and "Page/Download". You can set here all
862 rizwank 1.1 <br># images extensions as they are hit downloaded that must be counted but they
863 <br># are not viewed pages. URLs with such extensions are not included in the TOP
864 <br># Pages/URL report.
865 <br># Note: If you want to exclude particular URLs from stats (No Pages and no
866 <br># Hits reported), you must use SkipFiles parameter.
867 <br># Example: "css js class gif jpg jpeg png bmp zip arj gz z wav mp3 wma mpg"
868 <br># Example: ""
869 <br># Default: "css js class gif jpg jpeg png bmp"
870 <br>#
871 <br>NotPageList="css js class gif jpg jpeg png bmp"
872
873 <br><br><hr>
874
875 <a name="ValidHTTPCodes"><b>ValidHTTPCodes</b></a><br>
876 <b>Version : </b>4.0+<br>
877 <br># By default, AWStats considers that records found in log file are successful
878 <br># hits if HTTP code returned by server is a valid HTTP code (200 and 304).
879 <br># Any other code are reported in HTTP error chart.
880 <br># However in some specific environment, with web server HTTP redirection,
881 <br># you can choose to also accept other codes.
882 <br># Example: "200 304 302 305"
883 rizwank 1.1 <br># Default: "200 304"
884 <br>#
885 <br>ValidHTTPCodes="200 304"
886 <br>
887 <br><u>This is examples of current HTTP codes</u>
888 <br><i>
889 <br>#[Miscellaneous successes]
890 <br>"2xx", "[Miscellaneous successes]",
891 <br>"200", "OK", # HTTP request OK
892 <br>"201", "Created",
893 <br>"202", "Request recorded, will be executed later",
894 <br>"203", "Non-authoritative information",
895 <br>"204", "Request executed",
896 <br>"205", "Reset document",
897 <br>"206", "Partial Content",
898 <br>#[Miscellaneous redirections]
899 <br>"3xx", "[Miscellaneous redirections]",
900 <br>"300", "Multiple documents available",
901 <br>"301", "Moved Permanently",
902 <br>"302", "Found",
903 <br>"303", "See other document",
904 rizwank 1.1 <br>"304", "Not Modified since last retrieval", # HTTP request OK
905 <br>"305", "Use proxy",
906 <br>"306", "Switch proxy",
907 <br>"307", "Document moved temporarily",
908 <br>#[Miscellaneous client/user errors]
909 <br>"4xx", "[Miscellaneous client/user errors]",
910 <br>"400", "Bad Request",
911 <br>"401", "Unauthorized",
912 <br>"402", "Payment required",
913 <br>"403", "Forbidden",
914 <br>"404", "Document Not Found",
915 <br>"405", "Method not allowed",
916 <br>"406", "ocument not acceptable to client",
917 <br>"407", "Proxy authentication required",
918 <br>"408", "Request Timeout",
919 <br>"409", "Request conflicts with state of resource",
920 <br>"410", "Document gone permanently",
921 <br>"411", "Length required",
922 <br>"412", "Precondition failed",
923 <br>"413", "Request too long",
924 <br>"414", "Requested filename too long",
925 rizwank 1.1 <br>"415", "Unsupported media type",
926 <br>"416", "Requested range not valid",
927 <br>"417", "Failed",
928 <br>#[Miscellaneous server errors]
929 <br>"5xx", "[Miscellaneous server errors]",
930 <br>"500", "Internal server Error",
931 <br>"501", "Not implemented",
932 <br>"502", "Received bad response from real server",
933 <br>"503", "Server busy",
934 <br>"504", "Gateway timeout",
935 <br>"505", "HTTP version not supported",
936 <br>"506", "Redirection failed",
937 <br>#[Unknown]
938 <br>"xxx" ,"[Unknown]"
939 </i>
940
941 <br><br><hr>
942
943 <a name="ValidSMTPCodes"><b>ValidSMTPCodes</b></a><br>
944 <b>Version : </b>5.0+<br>
945 <br># By default, AWStats considers that records found in mail log file are
946 rizwank 1.1 <br># successful mail transfers if field that represent return code in analyzed
947 <br># log file match values defined by this parameter.
948 <br># Change : Effective for new updates only
949 <br># Example: "1 250 200"
950 <br># Default: "1 250"
951 <br>#
952 <br>ValidSMTPCodes="1 250"
953
954 <br><br><hr>
955
956 <a name="AuthenticatedUsersNotCaseSensitive"><b>AuthenticatedUsersNotCaseSensitive</b></a><br>
957 <b>Version : </b>5.3+<br>
958 <br># Some web servers on some Operating systems (IIS-Windows) considers that a
959 <br># login with same value but different case are the same login. To tell AWStats
960 <br># to also considers them as one, set this parameter to 1.
961 <br># Possible values: 0 or 1
962 <br># Default: 0
963 <br>#
964 <br>AuthenticatedUsersNotCaseSensitive=0
965
966 <br><br><hr>
967 rizwank 1.1
968 <a name="URLNotCaseSensitive"><b>URLNotCaseSensitive</b></a><br>
969 <b>Version : </b>5.1+<br>
970 <br># Some web servers on some Operating systems (IIS-Windows) considers that two
971 <br># URLs with same value but different case are the same URL. To tell AWStats to
972 <br># also considers them as one, set this parameter to 1.
973 <br># Possible values: 0 or 1
974 <br># Default: 0
975 <br>#
976 <br>URLNotCaseSensitive=0
977
978 <br><br><hr>
979
980 <a name="URLWithAnchor"><b>URLWithAnchor</b></a><br>
981 <b>Version : </b>5.4+<br>
982 <br># Keep or remove the anchor string you can find in some URLs.
983 <br># Possible values: 0 or 1
984 <br># Default: 0
985 <br>#
986 <br>URLWithAnchor=0
987
988 rizwank 1.1 <br><br><hr>
989
990 <a name="URLQuerySeparators"><b>URLQuerySeparators</b></a><br>
991 <b>Version : </b>5.2+<br>
992 <br># In URL links, "?" char is used to add parameter's list in URLs. Syntax is:
993 <br># /mypage.html?param1=value1
994 <br># However, some servers/sites have also others chars to isolate dynamic part of
995 <br># their URLs. You can complete this list with all such characters.
996 <br># Example: "?;,"
997 <br># Default: "?;"
998 <br>#
999 <br>URLQuerySeparators="?;"
1000
1001 <br><br><hr>
1002
1003 <a name="URLWithQuery"><b>URLWithQuery</b></a><br>
1004 <b>Version : </b>3.2+<br>
1005 <br># Keep or remove the query string to the URL in the statistics for individual
1006 <br># pages. This is primarily used to differentiate between the URLs of dynamic
1007 <br># pages. If set to 1, mypage.html?id=x and mypage.html?id=y are counted as two
1008 <br># different pages.
1009 rizwank 1.1 <br># Warning, when set to 1, memory required to run AWStats is dramatically
1010 <br># increased if you have a lot of changing URLs (for example URLs with a random
1011 <br># id inside). Such web sites should not set this option to 1 or use seriously
1012 <br># the next parameter URLWithQueryWithoutFollowingParameters.
1013 <br># Possible values:
1014 <br># 0 - URLs are cleaned from the query string (ie: "/mypage.html")
1015 <br># 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y")
1016 <br># Default: 0
1017 <br>#
1018 <br>URLWithQuery=0
1019
1020 <br><br><hr>
1021
1022 <a name="URLWithQueryWithOnlyFollowingParameters"><b>URLWithQueryWithOnlyFollowingParameters</b></a><br>
1023 <b>Version : </b>6.0+<br>
1024 <br># When URLWithQuery is on, you will get the full URL with all parameters in
1025 <br># URL reports. But among thoose parameters, sometimes you don't need a
1026 <br># particular parameter because it does not identify the page or because it's
1027 <br># a random ID changing for each access even if URL points to same page. In
1028 <br># such cases, it is higly recommanded to ask AWStats to keep only parameters
1029 <br># you need (if you know them) before counting, manipulating and storing URL.
1030 rizwank 1.1 <br># Enter here list of wanted parameters. For example, with "param", one hit on
1031 <br># /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r
1032 <br># will be reported as 2 hits on /mypage.cgi?param=abc
1033 <br># This parameter is not used when URLWithQuery is 0 and can't be used with
1034 <br># URLWithQueryWithoutFollowingParameters.
1035 <br># Change : Effective for new updates only
1036 <br># Example: "param"
1037 <br># Default: ""
1038 <br>#
1039 <br>URLWithQueryWithOnlyFollowingParameters=""
1040
1041 <br><br><hr>
1042
1043 <a name="URLWithQueryWithoutFollowingParameters"><b>URLWithQueryWithoutFollowingParameters</b></a><br>
1044 <b>Version : </b>5.1+<br>
1045 <br># When URLWithQuery is on, you will get the full URL with all parameters in
1046 <br># URL reports. But among thoose parameters, sometimes you don't need a
1047 <br># particular parameter because it does not identify the page or because it's
1048 <br># a random ID changing for each access even if URL points to same page. In
1049 <br># such cases, it is higly recommanded to ask AWStats to remove such parameters
1050 <br># from the URL before counting, manipulating and storing URL. Enter here list
1051 rizwank 1.1 <br># of all non wanted parameters. For example, if you enter "id", one hit on
1052 <br># /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r
1053 <br># will be reported as 2 hits on /mypage.cgi?param=abc
1054 <br># This parameter is not used when URLWithQuery is 0 and can't be used with
1055 <br># URLWithQueryWithOnlyFollowingParameters.
1056 <br># Change : Effective for new updates only
1057 <br># Example: "PHPSESSID jsessionid"
1058 <br># Default: ""
1059 <br>#
1060 <br>URLWithQueryWithoutFollowingParameters=""
1061
1062 <br><br><hr>
1063
1064 <a name="URLReferrerWithQuery"><b>URLReferrerWithQuery</b></a><br>
1065 <b>Version : </b>5.1+<br>
1066 <br># Keep or remove the query string to the referrer URL in the statistics for
1067 <br># external referrer pages. This is used to differentiate between the URLs of
1068 <br># dynamic referrer pages. If set to 1, mypage.html?id=x and mypage.html?id=y
1069 <br># are counted as two different referrer pages.
1070 <br># Possible values:
1071 <br># 0 - Referrer URLs are cleaned from the query string (ie: "/mypage.html")
1072 rizwank 1.1 <br># 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y")
1073 <br># Default: 0
1074 <br>#
1075 <br>URLReferrerWithQuery=0
1076
1077 <br><br><hr>
1078
1079 <a name="WarningMessages"><b>WarningMessages</b></a><br>
1080 <b>Version : </b>1.0+<br>
1081 <br># AWStats can detect setup problems or show you important informations to have
1082 <br># a better use. Keep this to 1, except if AWStats says you can change it.
1083 <br># Possible values: 0 or 1
1084 <br># Default: 1
1085 <br>#
1086 <br>WarningMessages=1
1087
1088 <br><br><hr>
1089
1090 <a name="ErrorMessages"><b>ErrorMessages</b></a><br>
1091 <b>Version : </b>5.2+<br>
1092 <br># When an error occurs, AWStats output a message related to errors. If you
1093 rizwank 1.1 <br># want (in most cases for security reasons) to have no error messages, you
1094 <br># can set this parameter to your personalized generic message.
1095 <br># Example: "An error occured. Contact your Administrator"
1096 <br># Default: ""
1097 <br>#
1098 <br>ErrorMessages=""
1099
1100 <br><br><hr>
1101
1102 <a name="DebugMessages"><b>DebugMessages</b></a><br>
1103 <b>Version : </b>5.2+<br>
1104 <br># AWStat can be run with debug=x parameter to ouput various informations
1105 <br># to help in debugging or solving troubles. If you want (in most cases for
1106 <br># security reasons) to disable debugging, set this parameter to 0.
1107 <br># Possible values: 0 or 1
1108 <br># Default: 1
1109 <br>#
1110 <br>DebugMessages=1
1111
1112 <br><br><hr>
1113
1114 rizwank 1.1 <a name="NbOfLinesForCorruptedLog"><b>NbOfLinesForCorruptedLog</b></a><br>
1115 <b>Version : </b>3.2+<br>
1116 <br># To help you to detect if your log format is good, AWStats report an error
1117 <br># if all the first NbOfLinesForCorruptedLog lines have a format that does not
1118 <br># match the LogFormat parameter.
1119 <br># However, some worm virus attack on your web server can result in a very high
1120 <br># number of corrupted lines in your log. So if you experience awstats stop
1121 <br># because of bad virus records at the beginning of your log file, you can
1122 <br># increase this parameter (very rare).
1123 <br># Default: 50
1124 <br>#
1125 <br>NbOfLinesForCorruptedLog=50
1126
1127 <br><br><hr>
1128
1129 <a name="SplitSearchString"><b>SplitSearchString</b></a><br>
1130 <font color="#808080">
1131 <b>Version : </b>2.24 - 4.0 (deprecated since 4.1)<br>
1132 This parameter has been removed since 4.1.<br>
1133 AWStats 4.1+ supports both keywords AND keyphrases by default with no need of any parameter.<br>
1134 </font>
1135 rizwank 1.1
1136 <br><br><hr>
1137
1138 <a name="WrapperScript"><b>WrapperScript</b></a><br>
1139 <b>Version : </b>4.0+<br>
1140 <br># For some particular integration needs, you may want to have CGI links to
1141 <br># point to another script than awstats.pl.
1142 <br># Use the name of this script in WrapperScript parameter.
1143 <br># Example: "awstatslauncher.pl"
1144 <br># Default: ""
1145 <br>#
1146 <br>WrapperScript=""
1147
1148 <br><br><hr>
1149
1150 <a name="DecodeUA"><b>DecodeUA</b></a><br>
1151 <b>Version : </b>5.0+<br>
1152 <br># DecodeUA must be set to 1 if you use Roxen web server. This server converts
1153 <br># all spaces in user agent field into %20. This make the AWStats robots, os
1154 <br># and browsers detection fail in some cases. Just change it to 1 if and only
1155 <br># if your web server is Roxen.
1156 rizwank 1.1 <br># Possible values: 0 or 1
1157 <br># Default: 0
1158 <br>#
1159 <br>DecodeUA=0
1160
1161 <br><br><hr>
1162
1163 <a name="MiscTrackerUrl"><b>MiscTrackerUrl</b></a><br>
1164 <b>Version : </b>5.6+<br>
1165 <br># MiscTrackerUrl can be used to make AWStats able to detect some miscellanous
1166 <br># things, that can not be tracked on other way like:
1167 <br># - Screen size
1168 <br># - Screen color depth
1169 <br># - Java enabled
1170 <br># - Macromedia Director plugin
1171 <br># - Macromedia Shockwave plugin
1172 <br># - Realplayer G2 plugin
1173 <br># - QuickTime plugin
1174 <br># - Mediaplayer plugin
1175 <br># - Acrobat PDF plugin
1176 <br># To enable all this features, you must copy the awstats_misc_tracker.js file
1177 rizwank 1.1 <br># into a /js/ directory stored in your web document root and add the following
1178 <br># HTML code at the end of your index page (before </BODY>) :
1179 <br># <i><script language=javascript src="/js/awstats_misc_tracker.js"></script></i>
1180 <br># If code is not added in index page, all this detection capabilities will be
1181 <br># disabled. You must also check that ShowScreenSizeStats and ShowMiscStats
1182 <br># parameters are set to 1 to make results appear in report page.
1183 <br># If you want to use another directory than /js/, you must also change the
1184 <br># awstatsmisctrackerurl variable into the awstats_misc_tracker.js file.
1185 <br># Change : Effective for new updates only.
1186 <br># Possible value: Full URL of javascript tracker file added in HTML code
1187 <br># Default: "/js/awstats_misc_tracker.js"
1188 <br>#
1189 <br>MiscTrackerUrl="/js/awstats_misc_tracker.js"
1190
1191 <br><br><hr>
1192
1193 <a name="LevelFor"><b>LevelFor</b></a><br>
1194 <b>Version : </b>4.0+<br>
1195 6.0+ for LevelForFileTypesDetection, LevelForSearchEnginesDetection, LevelForKeywordsDetection, LevelForWormsDetection<br>
1196 <br># Following values allows you to define accuracy of AWStats entities (robots,
1197 <br># browsers, os, referers, file types) detection.
1198 rizwank 1.1 <br># It might be a good idea for large web sites or ISP that provides AWStats to
1199 <br># high number of customers, to set this parameter to 1 (or 0), instead of 2.
1200 <br># Possible values:
1201 <br># 0 = No detection,
1202 <br># 1 = Medium/Standard detection
1203 <br># 2 = Full detection
1204 <br># Change : Effective for new updates only
1205 <br># Default: 2 (0 for LevelForWormsDetection)
1206 <br>#
1207 <br>LevelForBrowsersDetection=2 # 0 disables Browsers detection.
1208 <br> # 2 reduces AWStats speed by 2%
1209 <br>LevelForOSDetection=2 # 0 disables OS detection.
1210 <br> # 2 reduces AWStats speed by 3%
1211 <br>LevelForRefererAnalyze=2 # 0 disables Origin detection.
1212 <br> # 2 reduces AWStats speed by 14%
1213 <br>LevelForRobotsDetection=2 # 0 disables Robots detection.
1214 <br> # 2 reduces AWStats speed by 2.5%
1215 <br>LevelForSearchEnginesDetection=2 # 0 disables Search engines detection.
1216 <br> # 2 reduces AWStats speed by 9%
1217 <br>LevelForKeywordsDetection=2 # 0 disables Keyphrases/Keywords detection.
1218 <br> # 2 reduces AWStats speed by 1%
1219 rizwank 1.1 <br>LevelForFileTypesDetection=2 # 0 disables File types detection.
1220 <br> # 2 reduces AWStats speed by 1%
1221 <br>LevelForWormsDetection=0 # 0 disables Worms detection.
1222 <br> # 2 reduces AWStats speed by 15%
1223
1224 <br><br><hr>
1225
1226 <a name="UseFramesWhenCGI"><b>UseFramesWhenCGI</b></a><br>
1227 <b>Version : </b>5.0+<br>
1228 <br># When you use AWStats as a CGI, you can have the reports shown in HTML views.
1229 <br># Frames are only available for report viewed dynamically. When you build
1230 <br># pages from command line, this option is not used and no frames are built.
1231 <br># Possible values: 0 or 1
1232 <br># Default: 1
1233 <br>#
1234 <br>UseFramesWhenCGI=1
1235
1236 <br><br><hr>
1237
1238 <a name="DetailedReportsOnNewWindows"><b>DetailedReportsOnNewWindows</b></a><br>
1239 <b>Version : </b>4.1+ (5.0+ for value 2)<br>
1240 rizwank 1.1 <br># This parameter ask your browser to open detailed reports into a different
1241 <br># window than the main page.
1242 <br># Possible values:
1243 <br># 0 - Open all in same browser window
1244 <br># 1 - Open detailed reports in another window except if using frames
1245 <br># 2 - Open always in a different window even if reports are framed
1246 <br># Default: 1
1247 <br>#
1248 <br>DetailedReportsOnNewWindows=1
1249
1250 <br><br><hr>
1251
1252 <a name="Expires"><b>Expires</b></a><br>
1253 <b>Version : </b>3.1+<br>
1254 <br># You can add, in the HTML report page, a cache lifetime (in seconds) that
1255 <br># will be returned to browser in HTTP header answer by server.
1256 <br># This parameter is not used when report are built with -staticlinks option.
1257 <br># Example: 3600
1258 <br># Default: 0
1259 <br>#
1260 <br>Expires=0
1261 rizwank 1.1
1262 <br><br><hr>
1263
1264 <a name="MaxRowsInHTMLOutput"><b>MaxRowsInHTMLOutput</b></a><br>
1265 <b>Version : </b>4.0+<br>
1266 <br># To avoid too large web pages, you can ask AWStats to limit number of rows of
1267 <br># all reported charts to this number when no other limit apply.
1268 <br># Default: 1000
1269 <br>#
1270 <br>MaxRowsInHTMLOutput=1000
1271
1272 <br><br><hr>
1273
1274 <a name="Lang"><b>Lang</b></a><br>
1275 <b>Version : </b>2.1+<br>
1276 <br># Set your primary language.
1277 <br># Possible value:
1278 <br># Albanian=al, Bosnian=ba, Bulgarian=bg,
1279 <br># Chinese (Taiwan)=tw, Chinese (Simpliefied)=cn, Czech=cz,
1280 <br># Danish=dk, Dutch=nl, English=en, Estonian=et, Finnish=fi, French=fr,
1281 <br># German=de, Greek=gr, Hebrew=he, Hungarian=hu, Indonesian=id, Italian=it,
1282 rizwank 1.1 <br># Japanese=jp, Korean=kr, Latvian=lv, Norwegian (Nynorsk)=nn,
1283 <br># Norwegian (Bokmal)=nb, Polish=pl, Portuguese=pt, Portuguese (Brazilian)=br,
1284 <br># Romanian=ro, Russian=ru, Serbian=sr, Slovak=sk, Spanish=es,
1285 <br># Spanish (Catalan)=es_cat, Swedish=se, Turkish=tr, Ukrainian=ua, Welsh=wlk.
1286 <br># First available language accepted by browser=auto
1287 <br># Default: "auto"
1288 <br>#
1289 <br>Lang="auto"
1290
1291 <br><br><hr>
1292
1293 <a name="DirLang"><b>DirLang</b></a><br>
1294 <b>Version : </b>2.1+<br>
1295 <br># Set the location of language files.
1296 <br># Example: "/usr/share/awstats/lang"
1297 <br># Default: "./lang" (means lang directory is in same location than awstats.pl)
1298 <br>#
1299 <br>DirLang="./lang"
1300
1301 <br><br><hr>
1302
1303 rizwank 1.1 <a name="Show"><b>Show...</b></a><br>
1304 <b>Version : </b><br>
1305 <font color="#808080">3.2 - 5.3 for ShowHeader (deprecated since 5.4)</font><br>
1306 3.2+ for ShowMenu,ShowMonthStats,ShowDaysOfWeekStats,ShowHoursStats,
1307 ShowDomainsStats,ShowHostsStats,ShowAuthenticatedUsers,ShowRobotsStats,
1308 ShowPagesStats,ShowFileTypesStats,ShowFileSizesStats,ShowBrowsersStats,
1309 ShowOSStats,ShowOriginStats,ShowKeyphrasesStats,ShowKeywordsStats,ShowHTTPErrorsStats<br>
1310 <font color="#808080">3.2 - 5.0 for ShowCompressionStats (deprecated since 5.1, use code C with ShowFileTypesStats instead)</font><br>
1311 4.1+ for ShowSessionsStats, ShowKeywordsStats<br>
1312 5.1+ for all letters codes<br>
1313 5.5+ for ShowDaysOfMonthStats<br>
1314 5.6+ for ShowMiscStats,ShowSTMPErrorsStats<br>
1315 5.8+ for ShowClusterStats<br>
1316 6.0+ for ShowWormsStats<br>
1317 <br># You choose here which reports you want to see in the main page and what you
1318 <br># want to see in those reports.
1319 <br># Possible values:
1320 <br># 0 - Topic is not shown at all
1321 <br># 1 - Report is shown with default informations
1322 <br># XYZ - Report is shown with only informations defined by code X,Y,Z...
1323 <br># X,Y,Z... are code letters among the following:
1324 rizwank 1.1 <br># U = Unique visitors
1325 <br># V = Visits
1326 <br># P = Number of pages
1327 <br># H = Number of hits (or mails)
1328 <br># B = Bandwith (or total mail size for mail logs)
1329 <br># L = Last access date
1330 <br># E = Entry pages
1331 <br># X = Exit pages
1332 <br># C = Web compression (mod_gzip,mod_deflate)
1333 <br># M = Average mail size (mail logs)
1334 <br>#
1335 <br># Show menu header with report links
1336 <br># Default: 1, Possible codes: None
1337 <br>ShowMenu=1
1338 <br># Show monthly chart
1339 <br># Default: UVPHB, Possible codes: UVPHB
1340 <br>ShowMonthStats=UVPHB
1341 <br># Show days of month chart
1342 <br># Default: VPHB, Possible codes: VPHB
1343 <br>ShowDaysOfMonthStats=VPHB
1344 <br># Show days of week chart
1345 rizwank 1.1 <br># Default: PHB, Possible codes: PHB
1346 <br>ShowDaysOfWeekStats=PHB
1347 <br># Show hourly chart
1348 <br># Default: PHB, Possible codes: PHB
1349 <br>ShowHoursStats=PHB
1350 <br># Show domains/country chart
1351 <br># Default: PHB, Possible codes: PHB
1352 <br>ShowDomainsStats=PHB
1353 <br># Show hosts chart
1354 <br># Default: PHBL, Possible codes: PHBL
1355 <br>ShowHostsStats=PHBL
1356 <br># Show authenticated users chart
1357 <br># Default: 0, Possible codes: PHBL
1358 <br>ShowAuthenticatedUsers=0
1359 <br># Show robots chart
1360 <br># Default: HBL, Possible codes: HBL
1361 <br>ShowRobotsStats=HBL
1362 <br># Show worms chart
1363 <br># Default: 0 (See also LevelForWormsDetection if set), Possible codes: HBL
1364 <br>ShowWormsStats=0
1365 <br># Show email senders chart (For use when analyzing mail log files)
1366 rizwank 1.1 <br># Default: 0, Possible codes: HBML
1367 <br>ShowEMailSenders=0
1368 <br># Show email receivers chart (For use when analyzing mail log files)
1369 <br># Default: 0, Possible codes: HBML
1370 <br>ShowEMailReceivers=0
1371 <br># Show session chart
1372 <br># Default: 1, Possible codes: None
1373 <br>ShowSessionsStats=1
1374 <br># Show pages-url chart.
1375 <br># Default: PBEX, Possible codes: PBEX
1376 <br>ShowPagesStats=PBEX
1377 <br># Show file types chart.
1378 <br># Default: HB, Possible codes: HBC
1379 <br>ShowFileTypesStats=HB
1380 <br># Show file size chart (Not yet available)
1381 <br># Default: 1, Possible codes: None
1382 <br>ShowFileSizesStats=0
1383 <br># Show operating systems chart
1384 <br># Default: 1, Possible codes: None
1385 <br>ShowOSStats=1
1386 <br># Show browsers chart
1387 rizwank 1.1 <br># Default: 1, Possible codes: None
1388 <br>ShowBrowsersStats=1
1389 <br># Show screen size chart
1390 <br># Default: 0 (See also MiscTrackerUrl if set to 1), Possible codes: None
1391 <br>ShowScreenSizeStats=0
1392 <br># Show origin chart
1393 <br># Default: PH, Possible codes: HB
1394 <br>ShowOriginStats=PH
1395 <br># Show keyphrases chart
1396 <br># Default: 1, Possible codes: None
1397 <br>ShowKeyphrasesStats=1
1398 <br># Show keywords chart
1399 <br># Default: 1, Possible codes: None
1400 <br>ShowKeywordsStats=1
1401 <br># Show misc chart
1402 <br># Default: a (See also MiscTrackerUrl parameter), Possible codes: ajdfrqwp
1403 <br>ShowMiscStats=a
1404 <br># Show http errors chart
1405 <br># Default: 1, Possible codes: None
1406 <br>ShowHTTPErrorsStats=1
1407 <br># Show smtp errors chart (For use when analyzing mail log files)
1408 rizwank 1.1 <br># Default: 0, Possible codes: None
1409 <br>ShowSMTPErrorsStats=0
1410 <br># Show the cluster report (Your LogFormat must contains the %cluster tag)
1411 <br># Default: 0, Possible codes: PHB
1412 <br>ShowClusterStats=0
1413
1414 <br><br><hr>
1415
1416 <a name="AddDataArray"><b>AddDataArray...</b></a><br>
1417 <b>Version : </b><br>
1418 5.4+ for AddDataArrayMonthStats,AddDataArrayShowDaysOfWeekStats,AddDataArrayShowHoursStats<br>
1419 5.5+ for AddDataArrayShowDaysOfMonthStats<br>
1420 <br># Some graphical reports are followed by the data array of values.
1421 <br># If you don't want this array (to reduce report size for example), you can
1422 <br># set thoose options to 0.
1423 <br># Possible values: 0 or 1
1424 <br># Default: 1
1425 <br>#
1426 <br># Data array values for the ShowMonthStats report
1427 <br>AddDataArrayMonthStats=1
1428 <br># Data array values for the ShowDaysOfMonthStats report
1429 rizwank 1.1 <br>AddDataArrayShowDaysOfMonthStats=1
1430 <br># Data array values for the ShowDaysOfWeekStats report
1431 <br>AddDataArrayShowDaysOfWeekStats=1
1432 <br># Data array values for the ShowHoursStats report
1433 <br>AddDataArrayShowHoursStats=1
1434
1435 <br><br><hr>
1436
1437 <a name="IncludeInternalLinksInOriginSection"><b>IncludeInternalLinksInOriginSection</b></a><br>
1438 <b>Version : </b>6.1+<br>
1439 <br># In the Origin chart, you have stats on where your hits came from. You can
1440 <br># includes hits on pages that comes from pages of same sites in this chart.
1441 <br># Possible values: 0 or 1
1442 <br># Default: 0
1443 <br>#
1444 <br>IncludeInternalLinksInOriginSection=0
1445
1446 <br><br><hr>
1447
1448 <a name="Max"><b>Max...</b></a><br>
1449 <b>Version : </b>1.0+<br>
1450 rizwank 1.1 <br># This value can be used to choose maximum number of lines shown for each
1451 <br># particular reporting.
1452 <br>#
1453 <br># Stats by domains
1454 <br>MaxNbOfDomain = 10
1455 <br>MinHitDomain = 1
1456 <br># Stats by hosts
1457 <br>MaxNbOfHostsShown = 10
1458 <br>MinHitHost = 1
1459 <br># Stats by authenticated users
1460 <br>MaxNbOfLoginShown = 10
1461 <br>MinHitLogin = 1
1462 <br># Stats by robots
1463 <br>MaxNbOfRobotShown = 10
1464 <br>MinHitRobot = 1
1465 <br># Stats by pages
1466 <br>MaxNbOfPageShown = 10
1467 <br>MinHitFile = 1
1468 <br># Stats by OS
1469 <br>MaxNbOfOsShown = 10
1470 <br>MinHitOs = 1
1471 rizwank 1.1 <br># Stats by browsers
1472 <br>MaxNbOfBrowsersShown = 10
1473 <br>MinHitBrowser = 1
1474 <br># Stats by screen size
1475 <br>MaxNbOfScreenSizesShown = 5
1476 <br>MinHitScreenSize = 1
1477 <br># Stats by referers
1478 <br>MaxNbOfRefererShown = 10
1479 <br>MinHitRefer = 1
1480 <br># Stats for keywords
1481 <br>MaxNbOfKeywordsShown = 10
1482 <br>MinHitKeyword = 1
1483 <br># Stats for sender or receiver emails
1484 <br>MaxNbOfEMailsShown = 20
1485 <br>MinHitEMail = 1
1486
1487 <br><br><hr>
1488
1489 <a name="FirstDayOfWeek"><b>FirstDayOfWeek</b></a><br>
1490 <b>Version : </b>3.2+<br>
1491 <br># Choose if you want week to start on sunday or monday
1492 rizwank 1.1 <br># Possible values:
1493 <br># 0 - Week start on sunday
1494 <br># 1 - Week start on monday
1495 <br># Default: 1
1496 <br>#
1497 <br>FirstDayOfWeek=1
1498
1499 <br><br><hr>
1500
1501 <a name="ShowFlagLinks"><b>ShowFlagLinks</b></a><br>
1502 <b>Version : </b>3.2+<br>
1503 <br># List of visible flags with link to other language translations.
1504 <br># See Lang parameter for list of allowed flag/language codes.
1505 <br># If you don't want any flag link, set ShowFlagLinks to "".
1506 <br># This parameter is used only if ShowMenu parameter is set to 1.
1507 <br># Possible values: "" or "language_codes_separated_by_space"
1508 <br># Default: "en es fr it nl es"
1509 <br>#
1510 <br>ShowFlagLinks="en fr de it nl es"
1511
1512 <br><br><hr>
1513 rizwank 1.1
1514 <a name="ShowLinksOnUrl"><b>ShowLinksOnUrl</b></a><br>
1515 <b>Version : </b>3.1+<br>
1516 <br># Each URL shown in stats report views are links you can click.
1517 <br># Possible values: 0 or 1
1518 <br># Default: 1
1519 <br>#
1520 <br>ShowLinksOnUrl=1
1521
1522 <br><br><hr>
1523
1524 <a name="UseHTTPSLinkForUrl"><b>UseHTTPSLinkForUrl</b></a><br>
1525 <b>Version : </b>4.0+<br>
1526 <br># When AWStats build HTML links in its report pages, it starts thoose link
1527 <br># with "http://". However some links might be HTTPS links, so you can enter
1528 <br># here the root of all your HTTPS links. If all your site is a SSL web site,
1529 <br># just enter "/".
1530 <br># This parameter is not used if ShowLinksOnUrl is 0.
1531 <br># Example: "/shopping"
1532 <br># Example: "/"
1533 <br># Default: ""
1534 rizwank 1.1 <br>#
1535 <br>UseHTTPSLinkForUrl=""
1536
1537 <br><br><hr>
1538
1539 <a name="MaxLengthOfShownURL"><b>MaxLengthOfShownURL</b></a><br>
1540 <b>Version : </b>1.0+<br>
1541 <br># Maximum length of URL part shown on stats page (number of characters).
1542 <br># This affects only URL visible text, larger links still work.
1543 <br># Default: 64
1544 <br>#
1545 <br>MaxLengthOfShownURL=64
1546
1547 <br><br><hr>
1548
1549 <a name="ShowLinksToWhoIs"><b>ShowLinksToWhoIs</b></a><br>
1550 <font color="#808080">
1551 <b>Version : </b>4.0 - 5.6 (deprecated since 5.7, replaced by plugin 'hostinfo')<br>
1552 This parameter has been removed since 5.7.<br>
1553 You must enable the plugin 'hostinfo' to get the same result if you were using this
1554 parameter.
1555 rizwank 1.1 </font>
1556
1557 <br><br><hr>
1558
1559 <a name="LinksToWhoIs"><b>LinksToWhoIs</b></a><br>
1560 <font color="#808080">
1561 <b>Version : </b>4.0 - 5.9 (deprecated since 6.0, replaced by plugin 'hostinfo')<br>
1562 This parameter has been removed since 6.0.<br>
1563 This parameter is no more required.
1564 </font>
1565
1566 <br><br><hr>
1567
1568 <a name="LinksToIPWhoIs"><b>LinksToIPWhoIs</b></a><br>
1569 <font color="#808080">
1570 <b>Version : </b>5.0 - 5.9 (deprecated since 6.0, replaced by plugin 'hostinfo')<br>
1571 This parameter has been removed since 6.0.<br>
1572 This parameter is no more required.
1573 </font>
1574
1575 <br><br><hr>
1576 rizwank 1.1
1577 <a name="HTMLHeadSection"><b>HTMLHeadSection</b></a><br>
1578 <b>Version : </b>3.2+<br>
1579 <br># You can enter HTML code that will be added at the top of AWStats reports.
1580 <br># Default: ""
1581 <br>#
1582 <br>HTMLHeadSection=""
1583
1584 <br><br><hr>
1585
1586 <a name="HTMLEndSection"><b>HTMLEndSection</b></a><br>
1587 <b>Version : </b>3.2+<br>
1588 <br># You can enter HTML code that will be added at the end of AWStats reports.
1589 <br># Great to add advert ban.
1590 <br># Default: ""
1591 <br>#
1592 <br>HTMLEndSection=""
1593
1594 <br><br><hr>
1595
1596 <a name="Bar"><b>Bar...</b></a><br>
1597 rizwank 1.1 <b>Version : </b>1.0+<br>
1598 <br># Value of maximum bar width/height for horizontal/vertical HTML graphics bar.
1599 <br># Default: 260/90
1600 <br>#
1601 <br>BarWidth = 260
1602 <br>BarHeight = 90
1603
1604 <br><br><hr>
1605
1606 <a name="Logo"><b>Logo...</b></a><br>
1607 <b>Version : </b>3.1+<br>
1608 <br># You can set Logo and LogoLink to use your own logo.
1609 <br># Logo must be the name of image file (must be in $DirIcons/other directory).
1610 <br># LogoLink is the expected URL when clicking on Logo.
1611 <br># Default: "awstats_logo1.png"
1612 <br>#
1613 <br>Logo="awstats_logo1.png"
1614 <br>LogoLink="http://awstats.sourceforge.net"
1615
1616 <br><br><hr>
1617
1618 rizwank 1.1 <a name="StyleSheet"><b>StyleSheet</b></a><br>
1619 <b>Version : </b>5.6+<br>
1620 <br># You can ask AWStats to use a particular CSS (Cascading Style Sheet) to
1621 <br># change its look. To create a style sheet, you can use samples provided with
1622 <br># AWStats in wwwroot/css directory.
1623 <br># Example: "/awstatscss/awstats_bw.css"
1624 <br># Example: "/css/awstats_bw.css"
1625 <br># Default: ""
1626 <br>#
1627 <br>StyleSheet=""
1628
1629 <br><br><hr>
1630
1631 <a name="color_"><b>color_...</b></a><br>
1632 <b>Version : </b><br>
1633 3.1 for color_Background,color_TableBGTitle,color_TableTitle,color_TableBG,
1634 color_TableRowTitle,color_TableBGRowTitle,color_TableBorder,color_text,
1635 color_textpercent,color_titletext,color_weekend,color_link,color_hover,
1636 color_u,color_v,color_p,color_h,color_k,color_s<br>
1637 4.1 for color_e,color_x<br>
1638 5.0 for color_other<br>
1639 rizwank 1.1 <br># Those colors parameters can be used (if StyleSheet parameter is not used)
1640 <br># to change AWStats look.
1641 <br># Example: color_name="RRGGBB" # RRGGBB is Red Green Blue components in Hex
1642 <br>#
1643 <br>color_Background="FFFFFF" # Background color for main page (Default = "FFFFFF")
1644 <br>color_TableBGTitle="CCCCDD" # Background color for table title (Default = "CCCCDD")
1645 <br>color_TableTitle="000000" # Table title font color (Default = "000000")
1646 <br>color_TableBG="CCCCDD" # Background color for table (Default = "CCCCDD")
1647 <br>color_TableRowTitle="FFFFFF" # Table row title font color (Default = "FFFFFF")
1648 <br>color_TableBGRowTitle="ECECEC" # Background color for row title (Default = "ECECEC")
1649 <br>color_TableBorder="ECECEC" # Table border color (Default = "ECECEC")
1650 <br>color_text="000000" # Color of text (Default = "000000")
1651 <br>color_textpercent="606060" # Color of text for percent values (Default = "606060")
1652 <br>color_titletext="000000" # Color of text title within colored Title Rows (Default = "000000")
1653 <br>color_weekend="EAEAEA" # Color for week-end days (Default = "EAEAEA")
1654 <br>color_link="0011BB" # Color of HTML links (Default = "0011BB")
1655 <br>color_hover="605040" # Color of HTML on-mouseover links (Default = "605040")
1656 <br>color_other="666688" # Color of text for 'other' record in charts (Default = "666688")
1657 <br>color_u="FFB055" # Background color for number of unique visitors (Default = "FFB055")
1658 <br>color_v="F8E880" # Background color for number of visites (Default = "F8E880")
1659 <br>color_p="4477DD" # Background color for number of pages (Default = "4477DD")
1660 rizwank 1.1 <br>color_h="66F0FF" # Background color for number of hits (Default = "66F0FF")
1661 <br>color_k="2EA495" # Background color for number of bytes (Default = "2EA495")
1662 <br>color_s="8888DD" # Background color for number of search (Default = "8888DD")
1663 <br>color_e="CEC2E8" # Background color for number of entry pages (Default = "CEC2E8")
1664 <br>color_x="C1B2E2" # Background color for number of exit pages (Default = "C1B2E2")
1665
1666 <br><br><hr>
1667
1668 <a name="LoadPlugin"><b>LoadPlugin</b></a><br>
1669 <b>Version : </b>5.0+<br>
1670 <br># Add here all plugins file you want to load.
1671 <br># Plugin files must be .pm files stored in 'plugins' directory.
1672 <br># Uncomment LoadPlugin lines to enable a plugin after checking that plugin
1673 <br># required perl modules are installed.
1674 <br>
1675 <br># Plugin: PluginName
1676 <br># PluginName description
1677 <br># Perl modules required: ...
1678 <br>#
1679 <br>LoadPlugin="pluginname"
1680
1681 rizwank 1.1 <br><br><hr>
1682
1683 <a name="Extra"><b>Extra...</b></a><br>
1684 <b>Version : </b><br>
1685 5.2+<br>
1686 5.8 for ExtraSectionFirstColumnFormatX, ExtraSectionAddAverageRowX, ExtraSectionAddSumRowX<br>
1687 <br>You can see the <a href="awstats_extra.html">following page</a> for explanation of
1688 all ExtraSection...X directives and how to use them.
1689
1690 <br><br><hr>
1691
1692 <a name="ExtraTrackedRowsLimit"><b>ExtraTrackedRowsLimit</b></a><br>
1693 <b>Version : </b>6.1<br>
1694 <br># There is also a global parameter ExtraTrackedRowsLimit that limit the
1695 <br># number of possible rows an ExtraSection can report. This parameter is
1696 <br># here to protect too much memory use when you make a bad setup in your
1697 <br># ExtraSection. It applies to all ExtraSection independently meaning that
1698 <br># none ExtraSection can report more rows than value defined by ExtraTrackedRowsLimit.
1699 <br># If you know an ExtraSection will report more rows than its value, you should
1700 <br># increase this parameter or AWStats will stop with an error.
1701 <br># Example: 2000
1702 rizwank 1.1 <br># Default: 500
1703 <br>#
1704 <br>ExtraTrackedRowsLimit=500
1705
1706 <br><br><hr>
1707
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
1711 <br># config file.
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 for parameters that
1716 <br># contains one value and AWStats will concat all values from both files for
1717 <br># parameters that are lists of value.
1718 <br>#
1719 <br>Include ""
1720
1721
1722 <!-- -------------------------------------------------------------------------------------- -->
1723 rizwank 1.1
1724 <br><br><hr>
1725
1726 <script language=javascript>
1727 var date='$Date: 2005/01/22 15:38:04 $';
1728 document.writeln("Last revision: "+date);
1729 </script>
1730
1731 </body>
1732 </html>
|
Return to
awstats_config.html
CVS log
Up to [RizwankCVS] / geekymedia_web / awstats-6.3 / docs