Read Me

  ____ _ ____ __  __
 [__  ] |_ __]  \/  \  Stats  -  Version 1.20090309
   / /| || || O  )O  |  ---------------------------
  / /_| || ||   <    |  (c)2009-03-09 Stefan Schulz
 [____]_||_||_|\_\__/       o_zilla@hotmail.com

         http://zitrostats.sourceforge.net/


==[ CONTENT ]======================================

 A. Requirements
  A01. Web Space / Web Server
  A02. PHP
  A03. MySQL

 B. Installation / Update
  B02. Unpacking Source Files
  B03. Access Rights
  B04. Database Initialization

 C. Usage
  C01. Zitro-Stats Setup
  C02. Statistics Update / Reset

 D. Help
  D01. Bugs / Help / Questions


==[ A. Requirements ]==============================

 A01. Web Space / Web Server

  To make statistic web pages available, you need
  a web server or web space of cause. You can also
  run a web server by your own. I recommand
  Apache2 which can be downloaded from
  http://httpd.apache.org/


 A02. PHP
  To run Zitro-Stats scripts, you need PHP version
  4.3 or higher. Most web space provider also
  support PHP. To set up by your own it can be
  downloaded from http://www.php.net/

  Optionaly disable/enable error reporting and
  level of error reporting to debug (hope you
  don't need to) in your PHP config:
   display_errors = on
   error_reporting = 2047


 A03. MySQL

  To store statistics genereted by Zitro-Stats you
  need access to database on a MySQL server.
  There's often one providers with your webspace.
  To set up your own, MySQL can be downloaded from
  http://www.mysql.com/

  For using MySQL database it's nessesary to have
  an account and a database (or rights to create
  one). Ask your webspace provider for it.


==[ B. Installation / Update ]=====================

 B01. Unpacking Source Files

  After downloading the latest version of
  Zitro-Stats source package, you have to
  unpack it to a web accessible destination
  of your choice. E.g. /var/www/zitrostats/ on
  Unix or c:/www/zitrostats on Windows
  
  If you have allready installed an older version
  of Zitro-Stats you can just delete all old files
  and unpack new files. Your complete data is
  stored in MySQL database and will not get lost.
  Continue with installation guide and make sure
  to have NOT checked "drop old tables" on
  datatase initalisation.


 B02. Access Rights

  Make sure that required applications (PHP, web
  server) have enough access rights to work with
  this files:
  - All files should be readable for PHP and
    web server.
  - PHP needs write access for temp directories
    (./temp).
  - The update and reset script (update.php and
    reset.php) should be protected from
	unauthorized requests. With Apache you can use
	.htacccess file to define some restrictions.
	Take a look at this file to see or edit
	default restrictions.


 B03. Database Initialization

  Now Zitro-Stats should be able to run it's
  installer plugin. Open it in a web browser of
  your choice. E.g. http://localhost/zitrostats/

  Follow the instructions to complete Installer.
  Go on reading the next chapter!


==[ C. USAGE ]=====================================

 C01. Zitro-Stats Setup

  To configuere Zitro-Stats open it with web
  browser again. E.g. http://localhost/zitrostats/

  At the bottom of the page you can find a link
  for switching to admin interface. Login with
  your admin password.

  In variables administration you can can set a
  new admin password and customize some settings.
  Save your settings and go back to admin
  interface.

  In servers administration you can set up the
  Soldat servers participating in your stats. For
  "logdir" you have to enter the path of log
  directory. E.g. /usr/local/soldat/logs/ on Unix
  or C:\Games\Soldat\Logs\ on Windows or
  ftp://user:password@soldat.server.net/logs/ for
  a remote server via FTP or
  http://soldat.server.net/logs/ for HTTP logs.


 C02. Statistics Update / Reset

  Finaly it's all ready to do first update: you
  can start update.php to generate/update stats
  or reset.php to reset.

  It's recommanded to make scripts or scheduled
  jobs to initiate automatic updates.


==[ D. CONTACT ]===================================

 D01. Bugs / Help / Questions

  Feel free to contact me via:
  - E-Mail: o_zilla@hotmail.com
  - MSN:    o_zilla@hotmail.com
  - ICQ:    232449
  - Jabber: stefffan@jabber.ccc.de


  Have Fun!