From: eldy <> Date: Fri, 25 Feb 2005 23:57:32 +0000 (+0000) Subject: Update documentation X-Git-Tag: AWSTATS_WEBMIN_1_6_BETA~75 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b0e91a0a7e8d215746e61178ee8a73ae4ee8fc65;p=thirdparty%2FAWStats.git Update documentation --- diff --git a/docs/awstats_config.html b/docs/awstats_config.html index e84bff42..bf3eb30b 100644 --- a/docs/awstats_config.html +++ b/docs/awstats_config.html @@ -34,8 +34,7 @@

AWStats configuration directives/options

-
Each directives available in the AWStats config file (.conf) is listed here.
-They are described using a consistent format.
+
Each directives available in the AWStats config file (.conf) is listed here (with examples and default values).

Notes To include an environment variable in any parameter (AWStats will replace it with its value @@ -44,7 +43,7 @@ when reading it), follow the example:



-
MAIN SETUP SECTION (Required to make AWStats work)
+
DIRECTIVES IN MAIN SETUP SECTION (Required to make AWStats work)
-
OPTIONAL SETUP SECTION (Not required but increase AWStats features)
+
DIRECTIVES IN OPTIONAL SETUP SECTION (Not required but increase AWStats features)
-
OPTIONAL ACCURACY SETUP SECTION (Not required but increase AWStats features)
+
DIRECTIVES IN OPTIONAL ACCURACY SETUP SECTION (Not required but increase AWStats features)
-
OPTIONAL APPEARANCE SETUP SECTION (Not required but increase AWStats features)
+
DIRECTIVES IN OPTIONAL APPEARANCE SETUP SECTION (Not required but increase AWStats features)
-
PLUGINS
+
DIRECTIVES FOR PLUGINS
-
EXTRA
+
DIRECTIVES IN EXTRA SECTIONS
-* Step 0-2:
+* Step 2:
+
Once a config file has been automatically created (by awstats_configure.pl, by your package installer or just by a manual copy of awstats.model.conf), it's important to edit it manually and change the "MAIN PARAMETERS" to match all your needs:
@@ -137,18 +139,19 @@ web server log files, "S" for a streaming server log file, "M" for mail log file or use a personalized log format if you don't use combined log format.
- Edit SiteDomain parameter with the main domain name or the intranet web server name used to reach the web site to analyze (Example: www.mydomain.com). If you have several -possible name for same site, add list in HostAlias parameter.
-- You can also change other parameters if you want.
+possible name for same site, use the main domain name and add list of others in HostAlias parameter.
+- You can also change other parameters if you want. Full list is available in Configurations/Directives options page.

-Step 0 (Install and Setup) is finished. You can jump to the Build/Update Statistics section.
- +Install and Setup is finished. You can jump to the Building/Updating statistics database section.


+ +
-B) With IIS server
+B) Setup with IIS server

-* Step 0-1:
+* Step 1:

Configure IIS to log in "Extended W3C log format" (You can still use your own log format but setup is easier if made like suggested). So, for @@ -175,33 +178,33 @@ your homepage. This is an example of records you should get then in the new log 2000-07-19 14:14:14 62.161.78.73 - GET / 200 1234 HTTP/1.1 Mozilla/4.0+(compatible;+MSIE+5.01;+Windows+NT+5.0) http://www.from.com/from.htm

-* Step 0-2:
+* Step 2:

Copy the contents of the provided cgi-bin folder from your hard drive to your server's cgi-bin directory (this includes awstats.pl, awstats.model.conf, and the lang, lib and plugins sub-directories).

-* Step 0-3:
+* Step 3:

Move AWStats icon sub-directories and its content into a directory readable by your web server, for example C:\yourwwwroot\icon.

-* Step 0-4:
+* Step 4:

Create a config file by copying awstats.model.conf file into a new file named awstats.myvirtualhostname.conf. You can use the value of your choice instead of "myvirtualhostname". This new file must be stored in
- Same directory than awstats.pl (so cgi-bin)

-* Step 0-5:
+* Step 5:

Edit this new config file with your own setup :
- Change LogFile value with full path of your web server log file (You can also use a relative path from your awstats.pl directory).
- Change LogType value with "W" for analyzing web server log files, "S" for a streaming server log file, "M" for mail log files, "F" for ftp log files, "O" otherwise.
-- Change LogFormat to a value with same field's name defined in step 0-1:
+- Change LogFormat to a value with same field's name defined in step 1:
LogFormat="date time c-ip cs-username cs-method cs-uri-stem cs-uri-query sc-status sc-bytes cs-version cs(User-Agent) cs(Referer)"
- Change DirIcons parameter to reflect relative path of icon directory.
- Edit SiteDomain parameter with the main domain name or the intranet @@ -209,12 +212,12 @@ web server name used to reach the web site to analyze (Example: www.mydomain.com - Set AllowToUpdateStatsFromBrowser parameter to 1 if you don't have command line access and have only cgi access.
- You can change other parameters if you want.

-Step 0 (Install and Setup) is finished. You can jump to the Build/Update Statistics section.
- +Install and Setup is finished. You can jump to the Building/Updating statistics database section.


+
-C) With other web servers
+C) Setup with other web servers

Setup process is similar to setup for Apache or IIS.
Use LogFormat to value "3" if you have WebStar native log format, use @@ -224,19 +227,19 @@ a personalized LogFormat if your log

-

Step 1 : Build/Update Statistics

 +

Statistics update: Building/Updating statistics database
-* Step 1-1:
+* Step 1:

The first analyze/update of statistics should be made the first time manually from the command line since first time, -process may be long and it's easier to solve problems (if you don't have Command Line access, just go to Step 1-2). The +process may be long and it's easier to solve problems (if you don't have Command Line access, just go to Step 2). The AWStats update command line is:
awstats.pl -config=myvirtualhostname -update

AWStats will read the config file awstats.myvirtualhostname.conf (or if not found, awstats.conf) and create/update its database with all summary information issued from analyzed log file.
-AWStats database files are saved in directory defined by DirData parameter in config file.
+AWStats database files are saved in directory defined in config file by DirData parameter.
When update is finished, you should get on screen a result like this:

Update for config "/etc/awstats/awstats.myvirtualhostname.conf"
@@ -251,7 +254,7 @@ Parsed lines in file: 225730
 Found 0 old records,
 Found 225521 new qualifed records.

-Dropped records are records discarded because they were not user HTTP request or requests were not qualified +Dropped records are records discarded because they were not "user HTTP requests" or requests were not qualified by AWStats filters (See SkipHosts, SkipUserAgents, SkipFiles, OnlyHosts, OnlyUserAgents and OnlyFiles parameters). @@ -269,23 +272,23 @@ You understood that it's not necessary to purge your log file after each update if it's highly recommended to do it as often as possible.
New records are records in your log file that were successfully used to build/update statistics.

-Note : A log analysis process is slow (one second for each 4500 lines of your +Note : A log analysis process might be slow (one second for each 4500 lines of your logfile with Athlon 1Ghz, plus DNS resolution time for each different IP address in your logfile if DNSLookup is set to 1 and not already done in your log file).
See Benchmark page for more accurate information.

-* Step 1-2:
+* Step 2:

-AWStats statistics can be updated from a browser, to provide real-time statistics, by clicking -the "Update now" link that appears when AWStats is used as a CGI (Next section 'Read Statistics +AWStats statistics can also be updated from a browser, to provide real-time statistics, by clicking +the "Update now" link that appears when AWStats is used as a CGI (Next section 'Reports build: Building and reading reports dynamically' gives you URL to use for that).
-Warning !!
+
+Warning!!
To enable this link, your parameter AllowToUpdateStatsFromBrowser must be set to 1 in your config file (Link is not enabled by default).
-
Then, using on-line update does not prevent you from running the update process from a scheduler -frequently (command is same than update of first process).
+frequently (command is same than update of first update process).
For this, you have two choices:
- Include the update command in your logrotate process. See FAQ-COM120 for this.
- Or add instructions in your crontab (Unix/Linux) or your task scheduler (for @@ -293,8 +296,10 @@ Windows), to launch frequently the Awstats update process. See Benchmark page for recommanded update/logrotate frequency.

+ +
-

Step 2 : Read Statistics

 +

Reports build: Building and reading reports
To see results of analyze, you have several solutions depending on your security policy.
@@ -328,7 +333,7 @@ This is how to use all other possible output options(1) :
perl awstats.pl -config=myvirtualhostname -output=errors404 -staticlinks > awstats.myvirtualhostname.errors404.html

Note (1): If you prefer, you can use awstats_buildstaticpages tool to -build all those pages in one command or to generate PDF files.
+build all those pages in one command, or to generate PDF files.

Note (2): You can also add a filter on the following output reports:urldetail, urlentry, urlexit, allhosts, refererpages.
filter can be a regexp on the full key you want awstats to present information about and you must use it after the output