English ReadMe file for eStats v4.9

Table of contents

  1. Introduction
  2. Features
  3. Requirements
  4. Installation
  5. Upgrade from previous version
  6. Licence
  7. Contact

Introduction

eStats is a script that allows to manage complex website statistics, it collects very many different informations about users and theirs activity.

Features

Script allows to:

Requirements

Required PHP version is 5.2.0 or higher.
Optional requirements are PHP extensions: gd, geoip, gettext, mbstring, bzip, zip, zlib.

Support on the server at least one of the following databases is required:
SQLite, MySQL or PostgreSQL.

Installation

  1. Copy whole estats directory into Your server;
  2. 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);
  3. Open in the browser directory where You copied files;
  4. Follow displayed instructions;
  5. You must put into sources of monitored websites this code (script will work correctly only if the server alllows 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 shouldn't 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.
  6. 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 could 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.

Upgrade from previous version

Upgrade from older versions (older than 4.9.50) of serie 4.9.xx requires complementing of options in Advanced Configuration (Tools / Configuration / Advanced).

In case if you are using SQLite database then manual conversion of database file to version 3 is required (because of PHP 5.3 dropping support for format 2).

License

Contact

If You found errors in the script (though this was only a letter mistake) or You have ideas, that can make the script more atractive, You can post Your ideas at project's forum.

Last modified: 2011-01-01 10:43:17 CET