7
7
<meta name="title" content="AWStats Documentation - Configuration directives and parameters">
8
8
<title>AWStats Documentation - Configuration directives and parameters</title>
9
9
<link rel="stylesheet" href="styles.css" type="text/css">
10
<!-- $Revision: 1.174 $ - $Author: eldy $ - $Date: 2005/02/18 19:39:58 $ -->
10
<!-- $Revision: 1.182 $ - $Author: eldy $ - $Date: 2005/09/21 19:25:47 $ -->
13
13
<body topmargin=10 leftmargin=5>
20
20
<td bgcolor=#9999cc align=center><a href="/"><img src="images/awstats_logo4.png" border=0></a></td>
21
21
<td bgcolor=#9999cc align=center>
23
<font style="font: 16pt arial,helvetica,sans-serif" color=#EEEEFF><b>AWStats logfile analyzer 6.4 Documentation</b></font><br>
23
<font style="font: 16pt arial,helvetica,sans-serif" color=#EEEEFF><b>AWStats logfile analyzer 6.5 Documentation</b></font><br>
26
26
<td bgcolor=#9999cc align=center>
34
34
<br><br><H1 style="font: 26px arial,helvetica,sans-serif">AWStats configuration directives/options</H1>
35
35
<!-- -------------------------------------------------------------------------------------- -->
37
<br>Each directives available in the AWStats config file (.conf) is listed here.<br>
38
They are described using a consistent format.<br>
37
<br>Each directives available in the AWStats config file (.conf) is listed here (with examples and default values).<br>
41
40
To include an environment variable in any parameter (AWStats will replace it with its value
105
104
<li><a href="#MiscTrackerUrl">MiscTrackerUrl</a>
108
<br><b>OPTIONAL ACCURACY SETUP SECTION (Not required but increase AWStats features)</b><br>
107
<br><b>DIRECTIVES IN OPTIONAL ACCURACY SETUP SECTION (Not required but increase AWStats features)</b><br>
110
109
<li><a href="#LevelFor">LevelForBrowsersDetection</a>
111
110
<li><a href="#LevelFor">LevelForOSDetection</a>
215
214
<li><a href="#color_">color_x</a>
218
<br><b>PLUGINS</b><br>
217
<br><b>DIRECTIVES FOR PLUGINS</b><br>
220
219
<li><a href="#LoadPlugin">LoadPlugin</a>
222
<br><b>DIRECTIVES IN EXTRA SECTIONS</b><br>
225
224
<li><a href="#Extra">ExtraSectionNameX</a>
226
225
<li><a href="#Extra">ExtraSectionCodeFilterX</a>
316
315
<br># the required log format).
317
316
<br># Possible values: 1,2,3,4 or "your_own_personalized_log_format"
318
317
<br># 1 - Apache or Lotus Notes/Domino native combined log format (NCSA combined/XLF/ELF log format)
319
<br># 2 - Old IIS log format (IIS W3C log format). See FAQ for IIS 6.x.
318
<br># 2 - IIS or ISA format (IIS W3C log format). See FAQ-COM115 For ISA.
320
319
<br># 3 - Webstar native log format.
321
320
<br># 4 - Apache or Squid native common log format (NCSA common/CLF log format)
322
321
<br># With LogFormat=4, some features (browsers, os, keywords...) can't work.
323
322
<br># "your_own_personalized_log_format" = If your log is ftp, mail or other format,
324
<br># you must use following keys to define the log format string (See FAQ
325
<br># for ftp, mail or exotic web log format examples):
326
<br># %host Host client name or IP address
323
<br># you must use following keys to define the log format string (See FAQ for
324
<br># ftp, mail or exotic web log format examples):
325
<br># %host Client hostname or IP address (or Sender host for mail log)
326
<br># %host_r Receiver hostname or IP address (for mail log)
327
327
<br># %lognamequot Authenticated login/user with format: "alex"
328
328
<br># %logname Authenticated login/user with format: alex
329
329
<br># %time1 Date and time with format: [dd/mon/yyyy:hh:mm:ss +0000] or [dd/mon/yyyy:hh:mm:ss]
352
352
<br># will discard records not in SiteDomain nor HostAliases
353
353
<br># %cluster If log file is provided from several computers (merged by
354
354
<br># logresolvemerge.pl), this tag define field of cluster id.
355
<br># %extraX Another field that you plan to use for building a
356
<br># personalized report with ExtraSection feature (See later).
355
357
<br># If your log format has some fields not included in this list, use
356
358
<br># %other Means another field
359
<br># %otherquot Means another not used double quoted field
358
361
<br># Examples for Apache combined logs (following two examples are equivalent):
359
362
<br># LogFormat = 1
360
363
<br># LogFormat = "%host %other %logname %time1 %methodurl %code %bytesd %refererquot %uaquot"
362
<br># Examples for IIS (following two examples are equivalent):
365
<br># Example for IIS:
363
366
<br># LogFormat = 2
364
<br># LogFormat = "%time2 %host %logname %method %url %code %bytesd %other %ua %referer"
709
711
<a name="ArchiveLogRecords"><b>ArchiveLogRecords</b></a><br>
710
<b>Version : </b>2.1+<br>
712
<b>Version : </b>2.1+ (6.4+ to use tags for suffix)<br>
711
713
<br># When PurgeLogFile is setup to 1, AWStats will clean your log file after
712
<br># processing it. You can however keep an archive file (saved in "DirData") of
713
<br># all processed log records by setting this to 1 (For example if you want to
714
<br># use another log analyzer).
714
<br># processing it. You can however keep an archive file of all processed log
715
<br># records by setting this parameter (For example if you want to use another
716
<br># log analyzer). The archived log file is saved in "DirData" with name
717
<br># awstats_archive.configname[.suffix].log
715
718
<br># This parameter is not used if PurgeLogFile=0
716
<br># Possible values: 0 or 1
719
<br># Change : Effective for new updates only
720
<br># Possible values: 0, 1, or tags (See LogFile parameter) for suffix
722
<br># Example: %YYYY%MM%DD
719
725
<br>ArchiveLogRecords=0
787
793
<br># Use SkipFiles to ignore access to URLs that match one of following entries.
788
794
<br># You can enter a list of not important URLs (like framed menus, hidden pages,
789
795
<br># etc...) to exclude them from statistics. You must enter here exact relative
790
<br># URL as found in log file, or a matching REGEX value.
791
<br># For example, to ignore /badpage.html, just add "/badpage.html". To ignore
792
<br># all pages in a particular directory, add "REGEX[^\/directorytoexclude]".
796
<br># URL as found in log file, or a matching REGEX value. Check apply on URL with
797
<br># all its query paramaters.
798
<br># For example, to ignore /badpage.php, just add "/badpage.php". To ignore all
799
<br># pages in a particular directory, add "REGEX[^\/directorytoexclude]".
793
800
<br># The opposite parameter of "SkipFiles" is "OnlyFiles".
794
801
<br># Note: Use space between each value. This parameter is or not case sensitive
795
802
<br># depending on URLNotCaseSensitive parameter.
796
803
<br># Note: You can use regular expression values writing value with REGEX[value].
797
804
<br># Change : Effective for new updates only
798
<br># Example: "/badpage.html REGEX[^\/excludedirectory]"
805
<br># Example: "/badpage.php /page.php?param=x REGEX[^\/excludedirectory]"
799
806
<br># Default: ""
812
<a name="SkipReferrersBlackList"><b>SkipReferrersBlackList</b></a><br>
813
<b>Version : </b>6.5+<br>
814
<br># Use SkipReferrersBlackList if you want to exclude records coming from a SPAM
815
<br># referrer. Parameter must receive a local file name containing rules applied
816
<br># on referrer field. If parameter is empty, no filter is applied.
817
<br># An example of such a file is available in lib/blacklist.txt
818
<br># You can download updated version at http://www.jayallen.org/comment_spam/
819
<br># Change : Effective for new updates only
820
<br># Example: "/mylibpath/blacklist.txt"
823
<br># WARNING!! Using this feature make AWStats running very slower (5 times slower
824
<br># with black list file provided with AWStats !
826
<br>SkipReferrersBlackList=""
805
830
<a name="OnlyHosts"><b>OnlyHosts</b></a><br>
806
831
<b>Version : </b>5.2+ (5.6+ for REGEX syntax)<br>
807
832
<br># Include in stats, only accesses from hosts that match one of following
1103
1128
<a name="DebugMessages"><b>DebugMessages</b></a><br>
1104
1129
<b>Version : </b>5.2+<br>
1105
<br># AWStat can be run with debug=x parameter to ouput various informations
1106
<br># to help in debugging or solving troubles. If you want (in most cases for
1107
<br># security reasons) to disable debugging, set this parameter to 0.
1130
<br># AWStat can be run with debug=x parameter to output various informations
1131
<br># to help in debugging or solving troubles. If you want to allow this (not
1132
<br># enabled by default for security reasons), set this parameter to 0.
1133
<br># Change : Effective immediatly
1108
1134
<br># Possible values: 0 or 1
added
removed
docs/awstats_config.html
