root/trunk/leaguerunner/README

Leaguerunner - PHP software to run an ultimate league

Leaguerunner is a LAMP application for managing an Ultimate league.  It runs
the Ottawa-Carleton Ultimate Association's summer, fall, and winter indoor
leagues, handling over 500 teams and 6000 registered players in more than 60
different divisions and three seasons of play.

Prerequisites:

  1) Webserver with PHP 4.3.10 or newer.
     You should be running the most up-to-date version of PHP 4.  Leaguerunner
     does not yet work with PHP 5.

  2) MySQL database, and the relevant PHP support for MySQL

  3) PHP PEAR libraries

  4) PHP jpgraph library

  5) (optional) the ability to run Perl scripts from the commandline for
     maintenance tasks.

Once the prerequisites are installed and configured normally (nothing really
special is needed for Leaguerunner), you can install the software.

To install Leaguerunner:
  1) copy all of the src/ directory to some location under your server's web
     root.  If your site's root is at /var/www/html, /var/www/html/leaguerunner
     is a good place to put it.  You can also run it from a user's public_html
     directory if you wish.

  2) initialise the database.  First, you need to create it.  This can be done
     by running: 
        mysql -uroot -p
     and logging in as the MySQL root user.  Once logged in, run the following
     SQL commands:
       CREATE DATABASE leaguerunner;
       GRANT ALL ON leaguerunner.* TO leaguerunner_user@localhost IDENTIFIED BY 'password';
       FLUSH PRIVILEGES;
     Be sure to choose an appropriate username instead of "leaguerunner_user"
     and a better password in place of "password".

     Once this is done, you will need to import the database schema using:
        mysql leaguerunner -u leaguerunner_user -p < db/mysql_schema.sql
     and populate some of the required initial data with:
        mysql leaguerunner -u leaguerunner_user -p < db/mysql_initialdata.sql

     Each time, you  will be prompted for the password of "leaguerunner_user",
     so enter the one you just used when creating it.

  3) Change into the directory in which you installed Leaguerunner, and edit
     the leaguerunner.conf file.  You will need to edit 
     $DB_URL to use the username and password you used when creating the
        database;
     $BASE_URL to set the base URL used to access Leaguerunner.

Once this is complete, you should be able to point your web browser at the base
URL and log in using the user 'admin' with a password of 'admin'.