~ubuntu-branches/ubuntu/breezy/awstats/breezy

« back to all changes in this revision

Viewing changes to README.TXT

  • Committer: Bazaar Package Importer
  • Author(s): Jonas Smedegaard
  • Date: 2004-05-05 05:12:07 UTC
  • Revision ID: james.westby@ubuntu.com-20040505051207-wfi8hydpa89pvuoi
Tags: upstream-6.0
ImportĀ upstreamĀ versionĀ 6.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
------------- AWStats --------------
 
3
         Advanced Web Statistics
 
4
------------------------------------
 
5
 
 
6
AWStats (Advanced Web Statistics) is a powerfull and featurefull web server
 
7
logfile analyzer that shows you all your Web statistics including visitors,
 
8
pages, hits, hours, search engines, keywords used to find your site, broken
 
9
links, robots and more...
 
10
It works with IIS 5.0+, Apache and all major web, wap, proxy, streaming
 
11
server log files (and even ftp servers or mail logs) on all Operating Systems.
 
12
 
 
13
License: GNU GPL (GNU General Public License. See LICENSE file),
 
14
         OSI Certified Open Source Software license.
 
15
Version: 6.0
 
16
Release date: January 2004
 
17
Platforms: All (Linux, NT, SCO, BSD, Solaris and other *NIX's, BeOS, OS/2...)
 
18
Author: Laurent Destailleur <eldy@users.sourceforge.net>
 
19
AWStats official web site and latest version: http://awstats.sourceforge.net
 
20
 
 
21
I   - Features and requirements of AWStats
 
22
          I - 1) Features, what AWStats can show you
 
23
          I - 2) Requirements for using AWStats
 
24
          I - 3) Files
 
25
II  - Install, Setup and Use AWStats
 
26
III - Benchmark
 
27
IV  - About the author, license and support
 
28
 
 
29
 
 
30
 
 
31
I - FEATURES AND REQUIREMENTS
 
32
------------------------------------
 
33
 
 
34
I - 1) Features
 
35
 
 
36
        A full log analysis enables AWStats to show you the following information:
 
37
        * Number of VISITS and UNIQUE VISITORS,
 
38
        * Visits duration and last visits,
 
39
        * Authenticated users, and last authenticated visits,
 
40
        * Days of week and rush hours (pages, hits, KB for each day and hour),
 
41
        * Domains/countries of hosts visitors (pages, hits, KB),
 
42
        * Hosts list, last visits and unresolved IP addresses list,
 
43
        * Most viewed, entry and exit pages,
 
44
        * File types,
 
45
        * Web compression statistics (for mod_gzip or mod_deflate),
 
46
        * Browsers used (pages, hits, kb for each browser),
 
47
        * OS used (pages, hits, KB for each OS),
 
48
        * Visits of robots,
 
49
        * Worms attacks,
 
50
        * Search engines, keyphrases and keywords used to find your site,
 
51
        * HTTP errors (Page not found with last referer, ...),
 
52
        * Other personalized reports,
 
53
        * Screen size report,
 
54
        * Number of times your site is "added to favourites bookmarks",
 
55
        * Ratio of Browsers that support: Java, Flash, RealG2 reader,
 
56
          Quicktime reader, WMA reader, PDF reader
 
57
        * Cluster report for load balanced servers ratio.
 
58
 
 
59
        It supports the following features as well:
 
60
        * Can analyze all log formats.
 
61
        * Works from command line and from a browser as a CGI (with dynamic
 
62
          filters capabilities for some charts),
 
63
        * Update of statistics can be made on demand from the web interface and
 
64
          not only from your scheduler,
 
65
        * Unlimited log file size, support split log files (load balancing system),
 
66
        * Support 'nearly sorted' log files even for entry and exit pages,
 
67
        * Reverse DNS lookup before or during analysis, support DNS cache files,
 
68
        * Country detection from IP location or domain name.
 
69
        * WhoIS Links,
 
70
        * A lot of options/filters and plugins can be used,
 
71
        * Multi-named web sites supported (virtual servers),
 
72
        * Cross Site Scripting Attacks protection,
 
73
        * Several languages,
 
74
        * No need of rare perl libraries,
 
75
        * Dynamic reports as CGI output.<br>
 
76
        * Static reports in one or framed HTML/XML pages, experimental PDF export,
 
77
        * Look and colors can match your site design, can use CSS,
 
78
        * Help and tooltips on HTML reported pages,
 
79
        * Experimental PDF export,
 
80
        * Easy to use (Just one configuration file to edit),
 
81
        * Free (GNU GPL), with sources (perl scripts),
 
82
        * A Webmin module also provided,
 
83
        * Available on all platforms.
 
84
 
 
85
 
 
86
I - 2) Requirements
 
87
 
 
88
        To use AWStats CGI script, you need the following requirements:
 
89
        * Your server must log web access in a log file you can read.
 
90
        * To run awstats, from command line, your operating system must be able
 
91
          to run perl scripts (.pl files). To run awstats as a CGI (for real-time
 
92
          statistics), your web server must also be able to run such scripts.
 
93
          If not, you can solve this by downloading last Perl version at:
 
94
          http://www.activestate.com/ActivePerl/ (Windows)
 
95
          http://www.perl.com/pub/language/info/software.html (All OS)
 
96
 
 
97
 
 
98
I - 3) Files
 
99
 
 
100
        The distribution of AWStats package includes the following files:
 
101
        README.TXT                          This file
 
102
        docs/LICENSE                        GNU General Public Licence
 
103
        docs/*                              AWStats documentation (setup/usage...)
 
104
        wwwroot/cgi-bin/awstats.pl          THE MAIN AWSTATS PROGRAM (CLI/CGI)
 
105
        wwwroot/cgi-bin/awredir.pl          A tool to track click that exit site
 
106
        wwwroot/cgi-bin/awstats.model.conf  An example of AWStats configure file
 
107
        wwwroot/cgi-bin/lang                Directory with languages files
 
108
        wwwroot/cgi-bin/lib                 Directory with awstats reference info
 
109
        wwwroot/cgi-bin/plugins             Directory with optional plugins
 
110
        wwwroot/icon/browser                Directory with browsers icons
 
111
        wwwroot/icon/clock                  Directory with clocks icons
 
112
        wwwroot/icon/cpu                    Directory with cpu icons
 
113
        wwwroot/icon/flags                  Directory with country flags icons
 
114
        wwwroot/icon/os                     Directory with os icons
 
115
        wwwroot/icon/other                  Directory with all others icons
 
116
        wwwroot/css                         Samples of CSS files
 
117
        wwwroot/js                          Javascript sources for "Misc" feature
 
118
        tools/*                             Other provided tools
 
119
        tools/webmin/awstats-x.x.wbm        A webmin module for AWStats
 
120
 
 
121
 
 
122
 
 
123
II - INSTALL, SETUP AND USE AWSTATS
 
124
-----------------------------------
 
125
 
 
126
The documentation available as of the date of this release is included, in
 
127
HTML format, in the docs/ directory.
 
128
You can find a most up-to-date documentation at:
 
129
http://awstats.sourceforge.net
 
130
 
 
131
 
 
132
 
 
133
III - BENCHMARK
 
134
-----------------------------------
 
135
 
 
136
Tests and results are available in AWStats documentation, in docs/ directory.
 
137
 
 
138
 
 
139
 
 
140
IV - ABOUT THE AUTHOR, LICENSE AND SUPPORT
 
141
-----------------------------------------
 
142
Copyright (C) 2000-2003 - Laurent Destailleur - eldy@users.sourceforge.net
 
143
 
 
144
This program is free software; you can redistribute it and/or
 
145
modify it under the terms of the GNU General Public License
 
146
version 2 as published by the Free Software Foundation.
 
147
 
 
148
This program is distributed in the hope that it will be useful,
 
149
but WITHOUT ANY WARRANTY; without even the implied warranty of
 
150
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
151
GNU General Public License for more details, in COPYING.TXT file.
 
152
 
 
153
If you have not received a copy of this file along with this program, write to
 
154
the Free Software Foundation, Inc.,
 
155
59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.