English ReadMe file for eStats v4.9
Introduction
eStats is a script that allows to manage complex website statistics, it collects very many different information about users and their activity.
Features
Script allows to:
-
collect and display information about used operating systems, browsers, robots, hosts, keywords, referrers, screen resolutions, websites popularity, flash plugin version, etc.;
-
collect data about location of visitors, maps generation;
-
generation of graphical charts (GD);
-
configure the script by the control panel with password protection;
-
exclude counting visits from chosen IP addresses;
-
protect preview of stats by password;
-
easy change of look thanks to themes;
-
collect and display informations about visits in the last twenty - four hours, month and year, in addition stats archive;
-
displays detailed informations about specified amount of last visitors;
-
use of it's powerful API to build own applications;
-
and many others.
Requirements
Required PHP version is 5.2.0 or higher.
Server support for at least one of the following databases is required: SQLite, MySQL or PostgreSQL.
Optional requirements are PHP extensions: gd, geoip, gettext, mbstring, bzip, zip, zlib.
Installation
-
Copy whole estats directory into your server;
-
Set up CHMOD 777 for directories data/, data/backups/, data/cache/ and data/tmp/ and CHMOD 666 for file conf/config.php (create them if do not exist);
-
Open in the browser directory where you copied files;
-
Follow displayed instructions;
-
You must put into sources of monitored websites this code (script will work correctly only if the server allows to execute PHP code in the website file!):
<?php
define('ESTATS_COUNT', 1);
define('ESTATS_ADDRESS', 'ADDRESS'); // optional
define('ESTATS_TITLE', 'TITLE'); // optional
@include ('PATH');
?>
Where:
ADDRESS - website address (without http://website.address.com, example: /index.php?page=main) (optional);
TITLE - if file text encoding is different than UTF-8, you should not use characters outside English alphabet (optional);
PATH - path to file stats.php in estats/ directory, example: ../directory/estats/stats.php.
Lines with parameters marked as optional could be safely removed.
-
Collecting informations about screen resolutions, flash plugin version etc. will work only if you put this code into the website source:
<noscript>
<div>
<a href="http://estats.emdek.cba.pl/">
<img src="PATHantipixel.php?count=COUNT" alt="eStats" title="eStats" />
</a>
</div>
</noscript>
<script type="text/javascript">
var eCount = COUNT;
var ePath = 'PATH';
var eTitle = 'TITLE'; // optional
var eAddress = 'ADDRESS'; // optional
var eAntipixel = 'ANTIPIXEL'; // optional
</script>
<script type="text/javascript" src="PATHstats.js"></script>
Where:
PATH - path to estats directory, example: /directory/estats/,
COUNT - 0 - collect only technical data, 1 - collect all data (only if you can not use PHP code).
ADDRESS - website address, example: /directory/website.html (optional);
TITLE - website title (optional);
ANTIPIXEL - selected antipixel for website, example default/silver.png (optional).
Lines with parameters marked as optional can not be removed, you should leave these values blank if you want use values taken from website or defaults.
Upgrading from previous versions
To upgrade from older versions of 4.9.xx series just replace files.
In case if you were using version older than 4.9.50 and SQLite database then manual conversion of database file to version 3.x is required (because of PHP 5.3 dropping support for version 2.8).
Remember to always backup data before upgrading!
License
-
Script is circulated on GPL license;
-
The only one condition of use is do not erasing any data that allow to identify the author of the script and the script itself (comments, information about version and links to the homepage);
-
You can use parts of the code in your own projects and modify the code if it is not at variance with the second point;
-
Author does not bear in case of script malfunction.
If you find any bugs in the script (though this was only a typo), or have any ideas, that might enhance it, then post your ideas on project forum.
Last modified: 2011-01-28 16:12:10 CET