mroovcastats
SourceForge.net Logo

    main page    features    todo    demo    download   
    changelog    manual/doc    f.a.q.   
    SF project page    bugs    requests    e-mail   




mroovca stats quick guide.

updated 07.05.2006 for mroovcastats 0.5.3


0. Preamble

This quick guide provides the most important informations
about mroovca stats.

There are 2 ways to write it: 'mroovca stats' or 'mroovcastats',
both of them means the same.


0a. Requirements

mroovca stats 0.5.2 requires:
- PHP 4.0.5 or above,
- MySQL module installed and enabled,
- optionally GD/GD2 module (but not needed),
- MySQL 4.1.1 or above.

It would be nice if you put my 80x15 logo*
(file mroovcastats.php) on your site.
There are 2 ways to do it:

- as a link to my mroovca stats page:
<a href="http://mroovcastats.sourceforge.net"><img src="mroovcastats/mroovcastats.png"
width=80 height=15 alt="mroovcastats" title="mroovcastats homepage" border="0"></a>

- as a link* to your statistics:
<a href="mroovcastats/index.php"><img src="mroovcastats/mroovcastats.png"
width=80 height=15 alt="mroovcastats" title="mroovcastats" border="0"></a>

* - link to image and statistics are show for default installation,
you can change these URLs for your configuration. Any other
(address to other pages, resizing, changing alt or title description,
changing colours of logo) changes are prohibited.


0b. Compability with previous version

mroovca stats >=0.4.0 isn't compatible with previous versions.
This version works with MySQL database, not flat-files.
You also can't import previous data (from <=0.3.0).
Sorry for that, but i have changed the way it works.
Maybe in future I'll make import for <=0.3.0 initial values,
so you can keep your log files.

This version of mroovca stats is full compatible with
all versions >=0.4.0. you just need to overrite files
and update settings (see below).


1. How to install/update mroovca stats ??

Unpack archive, rename mroovcastats-x.x.x
to mroovcastats, copy to destination.
Decide - manual or automatic install/update
and look for 1a or 1b.


1a. Manual installation/update

If install copy 'default_config.inc.php' to 'config.inc.php' first.

Edit your 'config.inc.php'. Put correct values to:
- dbhost
- dbname
- dbuser
- dbpass
- dbprefix
- rootpassword

Create or update database in your MySQL server,
script are in subdir "install". When updating run
scripts starting from your version or if not find -
one below, look at examples:

Ex: File are: mysql_update040.sql, mysql_update044.sql, mysql_update050.sql

Ex: You have 0.4.4
Ex: Start with mysql_update044.sql (you have 044), and then run mysql_update050.sql

Ex: You have 0.4.5
Ex: Start with mysql_update044.sql (you have 045, but it's not found - find one below),
Ex: and then run mysql_update050.sql

Ex: You have >=0.5.0
Ex: Just run mysql_update050.sql (you have 050)

Delete 'install_update' file because it has been changed to 'manual'


1b. Automatic installation

Give write permission to 'mroovcastats' forlder for this step.
Run mroovcastats/index.php. It will read previous config (if exists),
and ask you for changes or new features. Choose install or update radio
button (script tries to recognize your current version, but may not
check correctly), check and change if needed settings, enter
current rootpassword and click on a 'install/update' button.
Red colour messages will inform you about failure.

After success remove write permission to this folder/file.
For security reasons you can delete or change access permission
to index.php file.


If something goes wrong and you still think, that is O.K.
from your and server side - try manual configuration
or write an email to mroovcastats author.


2. How to run mroovca stats after install ?? (Skip if only updated)

Run in your browser http://my.website.com/mroovcastats/root.php .
Enter rootpassword, than create first account.
It should be named "main", but not necessary.
If you choose other name you may need to do little
modifications in 'mroovcastats.php'.
Don't forget to logout after creating account(s)!

Run in your browser http://my.website.com/mroovcastats/admin.php .
Enter your account name and password. Initialy password is
the same as account, so for login:"main" password:"main".
After login please change your password, than change
settings as you wish. Excluded hosts/subdomains works
with wildcart "*" (asterisk). Logout after all.

Put this PHP command on your website:
include( "mroovcastats/mroovcastats.php" );

or put it's content:

include("mroovcastats/cstat.inc.php"); # include the ClassFile
$stat = new CStat(); # create, read, and save data
$login = "main"; # login/account name
$stat->run( $login ); # collect data :-D

As you see, mroovcastats can work with multiple websites.
Method Cstat->run() needs one parameter - name of account.
So if your name differs that 'main' - modify and use yours.


3. How to see stats??

Just run in your browser http://my.website.com/mroovcastats/index.php .
If account if protected by password - enter login and password.
After all you should logout.

Previous versions users show.php - for compability you can still use that file.


4. Must I show mroovcastats logo?

No. But it would be nice if you put it. You can link it to show statistics
or to mroovcastats homepage. See chapter "0a. Requirements" for details.
Showing mroovcastats logo on site that is using it may be required in future.


5. Contact info

At this moment all informations are available at:
http://mroovcastats.sourceforget.net
or SF.net project page:
http://sourceforge.net/projects/mroovcastats