Polski plik ReadMe dla eStats v4.9

Spis treści

Wstęp
Cechy
Wymagania
Instalacja
Aktualizacja z poprzedniej wersji
Licencja
Kontakt

Wstęp

eStats jest skryptem umożliwiającym prowadzenie kompleksowych statystyk odwiedzin witryny, zbierającym wiele różnych danych na temat użytkowników oraz ich aktywności.

Cechy

Skrypt umożliwia:

zbieranie i wyświetlanie danych na temat używanych systemów operacyjnych, przeglądarek, robotów sieciowych, hostów, słów kluczowych, odwołań, rozdzielczości ekranu, najpopularniejszych podstron, wersji wtyczki flash, itd.;
zbieranie danych o lokalizacji odwiedzających, generowanie map;
generowanie wykresów graficznych (GD);
konfigurację działania skryptu za pomocą panelu administracyjnego zabezpieczonego hasłem;
wykluczanie zliczania wizyt z wybranych adresów IP;
zabezpieczenie przeglądania statystyk hasłem;
łatwa zmiana wyglądu dzięki obsłudze motywów;
gromadzenie i wyświetlanie informacji na temat odwiedzin w ciągu ostatniej doby, miesiąca i roku, ponadto archiwum statystyk;
wyświetlanie szczegółowych danych na temat określonej liczby ostatnich gości;
użycie swego bogatego API do budowy własnych aplikacji;
i wiele innych.

Wymagania

Wymagana wersja PHP to co najmniej 5.2.0.

Wymagana jest dostępność na serwerze przynajmniej jednego z następujących typów baz danych: SQLite, MySQL lub PostgreSQL.

Opcjonalne zależności to rozszerzenia PHP: gd, geoip, gettext, mbstring, bzip, zip, zlib.

Instalacja

Skopiuj cały katalog estats na swój serwer;
Katalogom data/, data/backups/, data/cache/ oraz data/tmp/ nadaj CHMOD 777, a plikowi conf/config.php CHMOD 666 (utwórz je jeśli nie istnieją);
Otwórz w przeglądarce katalog, do którego skopiowałeś pliki;
Postępuj zgodnie z wyświetlanymi instrukcjami;
Aby statystyki zaczęły zliczać odwiedziny musisz umieścić na monitorowanych stronach kod (aby skrypt działał prawidłowo serwer musi umożliwiać wykonywanie kodu PHP w pliku strony!):
```
<?php
define('ESTATS_COUNT', 1);
define('ESTATS_ADDRESS', 'ADDRESS'); // opcjonalnie
define('ESTATS_TITLE', 'TITLE'); // opcjonalnie
@include ('PATH');
?>
```
Gdzie:

ADDRESS - adres podstrony (bez http://adres.strony.pl, np. /index.php?strona=glowna) (opcjonalnie);
TITLE - jeśli kodowanie znaków podstrony jest inne niż UTF-8, to nie używaj w nim znaków spoza angielskiego alfabetu (opcjonalnie);
PATH - ścieżka dostępu do pliku stats.php w katalogu estats/, np. ../katalog/estats/stats.php.

Linie z parametrami oznaczonymi jako opcjonalne można usunąć, wtedy użyte zostaną wartości pobrane ze strony lub domyślne.
Aby działało zbieranie informacji o rozdzielczościach ekranu, wersji wtyczki flash itd. należy umieścić ponadto gdzieś na stronie następujący kod:
```
<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'; // opcjonalnie
var eAddress = 'ADDRESS'; // opcjonalnie
var eAntipixel = 'ANTIPIXEL'; // opcjonalnie
</script>
<script type="text/javascript" src="PATHstats.js"></script>
```
Gdzie:

PATH - ścieżka dostępu do katalogu estats/, np. /katalog/estats/;
COUNT - 0 - zbieraj tylko dane techniczne, 1 - zbieraj wszystkie dane (tylko gdy nie można użyć kodu PHP);
ADDRESS - adres podstrony, np. /katalog/podstrona.html (opcjonalnie);
TITLE - tytuł podstrony (opcjonalnie);
ANTIPIXEL - wybrany antypixel dla podstrony, np. default/silver.png (opcjonalnie).

Linii z parametrami oznaczonymi jako opcjonalne nie można usunąć, należy pozostawić puste wartości dla użycia wartości pobranych ze strony lub domyślnych.

Aktualizacja z poprzednich wersji

Aktualizacja ze starszych wersji serii 4.9.xx polega na zwykłej podmianie plików.

W przypadku używania bazy danych SQLite oraz wersji starszych od 4.9.50 wymagana jest ręczna konwersja bazy danych do formatu wersji 3.x (ze względu na wycofanie obsługi wersji 2.x od PHP 5.3).

Pamiętaj aby zawsze utworzyć kopię zapasową danych przed aktualizacją!

Licencja

Skrypt jest rozpowszechniany na licencji GPL;
Jedynym warunkiem jego użytkowania jest nieusuwanie żadnych danych umożliwiających identyfikację skryptu i jego autora (komentarze, informacje o wersji i odnośniki do strony domowej);
Możesz wykorzystywać fragmenty kodu we własnych projektach oraz dowolnie modyfikować kod, chyba, że jest to sprzeczne z punktem drugim;
Autor nie ponosi żadnej odpowiedzialności w przypadku ewentualnego wadliwego działania skryptu.

Kontakt

Jeśli znajdziesz jakieś błędy w skrypcie (choćby to była zwykła literówka) lub masz jakieś pomysły, które mogłyby uatrakcyjnić go, to napisz o tym na forum projektu.