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