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