Introduction
PsychoStats version 3.x is very easy and quick to install on any system. It includes an online installation wizard that you run through your browser. Follow these simple steps and you'll be up and running in no time. This documentation is for VERSION 3.x. All documentation for version 2.x is gone. Upgrade to v3 as support for v2 is depreciated.
People are often very confused about how PsychoStats actually works. PsychoStats is software that relies on other technologies such as a WebServer like Apache and a database server like MySQL. You must be familar with these types of servers in order to use PsychoStats. And you must have access to a web and mysql server.
There are 2 parts to PsychoStats:
* Backend Perl Scripts
o The backend takes care of the actual log parsing and updates. This is where the primary "stats.pl" perl script is run to fetch, parse and record log data from the game server(s) into the database.
o Note: The system that runs these updates (Windows or Linux) is what defines which archive you should download and install.
* Frontend PHP Website
o The frontend takes care of the interface that the user actually see's and interacts with. This is a set of PHP pages that interact with the same database as the backend so users can view the stats online.
[edit] Minimum Requirements
* PHP v4.3 (or 5.0+)
* MySQL v4.1.11 (or v5.0+)
* Perl v5.8 (Windows users: ActivePerl 5.8+)
o Required Perl modules
+ DBI
+ DBD::mysql
o Optional Perl modules
+ Net::SFTP - This is only required if you need to download logs via an SFTP server. Note: This module has a lot of extra dependencies. Too many to list here.
These requirements are the bare minimum that ensure PsychoStats will work. If you attempt to use older versions you run the risk of stats updates crashing or invalid statistics from being recorded. Users having problems with the software that are running older versions of these requirements can not be supported.
[edit] Download
Download the current release from the PsychoStats Downloads. Be sure to download the correct version for your operating system. Download the Windows archive if you are going to run the software from a Window server. Otherwise download the Linux archive instead.
The following links are static and will always download the most recent version of PsychoStats for your operating system.
* PsychoStats
o Windows
o Linux
[edit] Unzip the archive
Unzip the archive somewhere on your system. It does not matter where you do this. It's not required (nor desirable) to put this directory inside your web server directory root. Having the full unzipped archive in your web server's document tree means that users could potentially view your stats.cfg and get your database information. Or in severe cases a user could perform a DOS attack on your server by running the stats.pl via the Internet.
[edit] Frontend Installation
Before you can run the Installation Wizard to finalize your installation you need to copy the frontend web files to your web server. This should be the only manual part of the installation you have to perform.
When you unzipped the PsychoStats archive it created a directory resembling: psychostatsV.x.y (where V.x.y is the current major.minor version and code state revision, ie: 3.0.0b). Inside that directory will be lots of files and sub-directories. The directory you're interested here is upload. The upload directory is the entire frontend (note: PsychoStats prior to v3.0.5 had a web directory instead. They are both the same thing just with different names). The contents of this directory need to be copied over to somewhere on your web server directory root, a common place is a sub-directory called stats. Below are examples for Windows and Linux of how you would copy this directory to your web site.
[edit] Windows
Most users running web servers on Windows tend to use the IIS web server from Microsoft. The document root for IIS is usually something like: c:\wwwroot. Thats the directory where you want to copy the PsychoStats web directory into.
* Browse to the PsychoStats directory from the archive you unzipped.
* Right click on the upload directory and select "Copy".
* Browse to the document root of your website (ie: c:\wwwroot).
* Right click somewhere in the window of that directory and select "Paste". The files should copy over in a few seconds.
You should now have the upload directory copied into your web server document root. You probably don't want that directory to stay with the name of upload. So rename it to something more meaningful like stats. You can right click on the directory and select "Rename" to change the name of it.
So in the end you should have a directory of something like: c:\wwwroot\stats and in that directory will be all the PHP files and sub-directories that make up the PsychoStats frontend website.
[edit] Windows IIS
Currently certain issues exist that cause the PsychoStats installation to fail when running under IIS on Windows. The basic problem stems from improper user permissions that do not allow the website to write to the system TEMP directory for the themes. If you have a solution, everyone would love to hear it.
In order for the web server to write to the system temp directory you need to give IIS anonymous user write privileges to your C:\Windows\temp directory. Another option is to change the directory during installation to a temp directory inside the website directory. Either way, you should be able to install without any problems.
[edit] WAMP
I strongly suggest users that are attempting to use PsyhcoStats on their home computers to use a WAMP system. WAMP is an acronym for Windows Apache Mysql Php. It's a software bundle that automatically installs all the servers and services you need to have a fully functional website w/o worrying about any of the mess.
It comes with it's own little control panel interface to allow you to change settings and stop and start the services. It's an extremely easy system to use, even for new users.
Goto wampserver.com to download.
[edit] Linux
Apache is generally the web server of choice for Linux users. The document root of the website can be almost anywhere on the system. Some common locations include: /usr/local/apache/htdocs, /usr/www/htdocs, ~/public_html. Consult your web server configuration or your web host support for information on where your document root is.
To copy the frontend files to your website do this:
First change your directory to where the PsychoStats archive was untar'd. Then do the commands below.
For PsychoStats 3.0.4 or lower
mkdir /path/to/document/root/stats
cp -rf web/* /path/to/document/root/stats
For PsychoStats versions 3.0.5 or higher
mkdir /path/to/document/root/stats
cp -rf upload/* /path/to/document/root/stats
Change the stats directory name to whatever you want it to be.
[edit] Run the Install Wizard
Installation Wizard opening page
Installation Wizard opening page
I'll assume you copied the frontend files to a directory called "stats" in your web server document root. All you have to do now is browse to the /stats/install/index.php with your browser pointing to your website. The installation wizard will guide you through the rest of the installation. But just so you know what it will look like here's a screen shot of the opening screen to the left.
For example, to start the installation use a URL like this: http://your.domain.com/stats/install/index.php
Be sure to use a proper domain name in the URL to where your website is actually hosted.
[edit] What to do next?
Once the Install Wizard has fully completed the first thing you need to do is login to the stats website that was just setup for you using the administrator login you created during installation. Once logged in you absolutely need to configure a logsource so PsychoStats will know how and where to read your game logs.
Log sources can be configured in the ACP of the stats website. Login using the admin user you created, go to the ACP and find the Logsources in the menu on the left. Once you've added a proper logsource to your config you can then proceed to the next step below.
[edit] Backend Installation
The 'backend' is what makes up the rest of the PsychoStats software. Mainly comprised of perl scripts and other files. Everything in the backend never gets accessed from a web server. These files can be installed (or copied) anywhere you want them. Once the frontend is fully installed and your stats website is visible (but with no stats in it) you're ready to finish the final steps of installation as outlined below.
[edit] Edit stats.cfg
The stats.cfg is a very small configuration file. It has 7 settings defined in it that you must set and thats it.
Setting Default Purpose
dbtype mysql Specify the type of DB to use
dbhost localhost Hostname or IP of the DB server (localhost for the same machine)
dbport Port for the DB server. Leave blank for server default
dbname psychostats Name of the database to use
dbuser Username to connect as. Leave blank for none
dbpass Password for authentication. Leave blank for none
dbtblprefix ps_ Prefix to use for all tables related to PsychoStats. ps_ is a good default.
Edit the settings so "stats.pl" can properly run.
[edit] Run stats.pl
Once the Installation Wizard has completed and you can view your stats website (with no stats on it) you can begin running the stats.pl to actually have stats populate in your database. Simply go to the directory where you unzipped PsychoStats and run the stats.pl file.
New Bee
Posting Permissions
LinkBack URL
About LinkBacks
Reply With Quote