From: eldy <> Date: Sun, 9 Dec 2001 20:33:03 +0000 (+0000) Subject: Provided with an HTML documentation. X-Git-Tag: AWSTATS_1_0~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=41db3fced504e50072bdcec73d8f6d086f31fecd;p=thirdparty%2FAWStats.git Provided with an HTML documentation. --- diff --git a/docs/awstats_license.html b/docs/awstats_license.html new file mode 100644 index 00000000..befe3ce1 --- /dev/null +++ b/docs/awstats_license.html @@ -0,0 +1,64 @@ + + + + + + + +AWStats - FAQs + + + + + + + + + + + + + + + + + +
+
+AWStats logfile analyzer 3.2 Documentation
+
+
+  +
+ +

AWStats License / Copyright

+ +
+AWStats is distributed under the GNU General Public License (GPL).
+So you must follow the line "Free software - Copylefted - GPL" to know what are major license agreements with AWStats.
+
+ +
+
+ +
+
+ +
+ + + + + diff --git a/docs/awstats_setup.html b/docs/awstats_setup.html new file mode 100644 index 00000000..7d177b1d --- /dev/null +++ b/docs/awstats_setup.html @@ -0,0 +1,227 @@ + + + + + + + +AWStats - Votes and awards page + + + + + + + + + + + + + + + + + +
+
+AWStats logfile analyzer 3.2 Documentation
+
+
+  +
+ + +

Setup / Install and Run AWStats

+ + +
+1) With Apache Server (on Unix/Linux, Windows, MacOS...)
+
+* Configure your apache web server to have "combined" log format.
+You can do this by changing, in httpd.conf, following directives:
+CustomLog /yourlogpath/yourlogfile common
+into
+CustomLog /yourlogpath/yourlogfile combined
+See your apache manual for more information.
+Stop Apache, remove old log files and restart Apache.
+This is an example of records you should get in new log file:
+62.161.78.73 - - [dd/mmm/yyyy:hh:mm:ss +0000] "GET / HTTP/1.1" 200 1234 "http://www.from.com/from.htm" "Mozilla/4.0 (compatible; MSIE 5.01; Windows NT 5.0)"
+
+* Copy all the content of provided AWStats cgi-bin directory into your web +server cgi-bin directory (this includes awstats.pl, awstats.model.conf, +logresolvemerge.pl and the lang and db sub-directories).
+
+* If necessary (should not with most perl interpreter), in awstats.pl file, edit the first line
+#!/usr/bin/perl
+to reflect the path were your perl interpreter is installed.
+Default value works for most of Unix OS, but it also might be
+#!/usr/local/bin/perl
+With Apache for Windows and Activeperl interpreter, it might be
+#!c:/program files/activeperl/bin/perl
+
+* Move all awstats icon sub-directories into a directory readable by your +web server, for example /yourwwwroot/icon or /yourwwwroot/icons.
+
+* Copy awstats.model.conf into awstats.virtualhostname.conf or awstats.conf +(when you will run AWStats, it will first look for a config file named +awstats.virtualhostname.conf, and, if not found, will look for awstats.conf).
+Whatever the name you choose, this new file must be stored in
+- /etc/opt/awstats or /etc/awstats or /etc for unix/linux users.
+- same directory than awstats.pl (so cgi-bin) for Windows and other OS.
+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).
+- Check if "LogFormat" has the value "1" (it means "NCSA apache combined/ELF/XLF log format").
+- Change "DirIcons" parameter to reflect relative URL of icon directory.
+- Edit "SiteDomain" parameter with the main domain name or the intranet +web server name used to reach the web site to analyze.
+- You can change other parameters if you want.
+
+SETUP IS FINISHED
+
+* To update statistics, launch awstats.pl from the command line interface +like this (the first time, process may be long) :
+awstats.pl -config=virtualhostname -update
+AWStats will read the config file (awstats.virtualhostname.conf, or, if +not found, awstats.conf) and create/update database where AWStats store +all summary information issued from analyzed log files.
+A log analysis process is slow (one second for each 3000 lines of your +logfile with Athlon 1Ghz, plus DNS resolution time for each different IP +address in your logfile if DNSLookup=1).
+See Benchmark page for more accurate information.
+
+* Add instructions in your crontab (Unix/Linux) or your scheduler (for +Windows), to launch frequently this Awstats update process.
+For sites with:
+- 10,000 visitors a month Launch AWStats every day
+- 50,000 visitors a month Launch AWStats every 4 hours
+- 250,000 visitors a month Launch AWStats every hour
+- 1,000,000 visitors a month Launch AWStats every hour
+This is ABSOLUTELY necessary to keep good performances.
+See AWStats Benchmark page for more accurate information.
+
+* To see results of analyze, you can build a HTML report from the command line, like this :
+awstats.pl -config=virtualhostname -output > result.html
+Or, you can view dynamically your statistics from a browser. For this, +if you named your config file awstats.conf, just use URL:
+http://www.myserver.mydomain/cgi-bin/awstats.pl +If you named your config file awstats.virtualhostname.conf, use URL:
+http://www.myserver.mydomain/cgi-bin/awstats.pl?config=virtualhost +where virtualhostname is used to know which config file to use (AWStats +will use awstats.virtualhostname.conf file).
+
+
+
+2) With IIS Server
+
+* 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 +this, start the IIS Snap-in, select the web site and look at its +Properties. Choose W3C Extended Log Format, then Properties, then the +Tab Extended Properties and uncheck everything under Extended Properties.
+Once they are all unchecked, check all following fields:
+ +date
+time
+c-ip
+cs-username
+cs-method
+cs-uri-stem
+sc-status
+sc-bytes
+cs-version
+cs(User-Agent)
+cs(Referer)
+
+Stop IIS, remove old log files and restart IIS.
+This is an example of records you should get in new log file:
+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 +
+* Copy all the content of provided AWStats cgi-bin directory into your web +server cgi-bin directory (this includes awstats.pl, awstats.model.conf, +logresolvemerge.pl and the lang and db sub-directories).
+
+* Move all awstats icon sub-directories into a directory readable by your +web server, for example C:\yourwwwroot\icon.
+
+* Copy awstats.model.conf into awstats.virtualhostname.conf or awstats.conf +(when you will run AWStats, it will first look for a config file named +awstats.virtualhostname.conf, and, if not found, will look for awstats.conf).
+Whatever the name you choose, this new file must be stored in
+- same directory than awstats.pl (so cgi-bin)
+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 "LogFormat" to value "2" (it means "IIS W3C log format").
+- Change "DirIcons" parameter to reflect relative URL of icon directory.
+- Edit "SiteDomain" parameter with the main domain name or the intranet +web server name used to reach the web site to analyze.
+- You can change other parameters if you want.
+
+SETUP IS FINISHED
+
+* To update statistics, launch awstats.pl from the command line interface +like this (the first time, process may be long) :
+awstats.pl -config=virtualhostname -update
+AWStats will read the config file (awstats.virtualhostname.conf, or, if +not found, awstats.conf) and create/update database where AWStats store +all summary information issued from analyzed log files.
+A log analysis process is slow (one second for each 3000 lines of your +logfile with Athlon 1Ghz, plus DNS resolution time for each different IP +address in your logfile if DNSLookup=1).
+See Benchmark page for more accurate information.
+
+* Add instructions in a task scheduler to launch frequently this Awstats +update process.
+For sites with:
+- 10,000 visitors a month Launch AWStats every day
+- 50,000 visitors a month Launch AWStats every 4 hours
+- 250,000 visitors a month Launch AWStats every hour
+- 1,000,000 visitors a month Launch AWStats every hour
+This is ABSOLUTELY necessary to keep good performances.
+See AWStats Benchmark page for more accurate information.
+
+!!! Warning, with IIS, Windows doesn't let AWStats to purge log file +after processing it, so it's very important you purge/rotate your log +file yourself (or setup IIS to do it).
+The more often you clean your log file, the more faster AWStats will be.
+See AWStats Benchmark page for more accurate information.
+
+* To see results of analyze, you can build a HTML report from the command +line, like this :
+awstats.pl -config=virtualhostname -output > result.html
+Or, you can view dynamically your statistics from a browser. For this, +if you named your config file awstats.conf, just use URL:
+http://www.myserver.mydomain/cgi-bin/awstats.pl
+If you named your config file awstats.virtualhostname.conf, use URL:
+http://www.myserver.mydomain/cgi-bin/awstats.pl?config=virtualhostname
+where virtualhostname is used to know which config file to use (AWStats +will use awstats.virtualhostname.conf file).
+
+ + +3) With other web servers
+
+Setup process is similar to setup for Apache or IIS.
+
+ + +
+ + + + +