LinuxInstallation

Depending on your permissions, you should be able to run the load script from the command line. Note you should replace 'congo' with whatever the name of your database instance is set to.

 $ svn checkout http://svn.stonekeep.com/svn/congo/trunk

 mysqladmin create congo  (you may need to be root, or supply an administrators credentials here)
 mysql congo
 grant all privileges on congo.* to congo@'localhost' identified by 'congo'
 flush privileges
 exit

 $ ./do.sh congo

Ant is a build tool developed specifically for building and manipulating Java products. Download a binary version 1.6 or later from http://ant.apache.org/ and install it in any directory

• MySQL?
  You'll need MySQL? v5.0 or later. Install according to your distribution.
• Apache Webserver
  Apache 2.x is highly recomended.
• PHP
  PHP v4.0 or later is highly recommended.
• SVN
  If you'll be running a source code distribution of CONGO, you'll need an SVN client.

Make sure the path to your JVM (or JDK for source code versions) is on your path, as well as a path to the Ant binary directory.

After setting the paths, check to make sure they work:

 $ ant

Checking out CONGO from SVN via svn command line

You will require a login and password to the SVN repository from Stonekeep. Contact info@stonekeep.com to receive a username and password.

Navigate to a directory where you'd like to unpack CONGO. Check out a working version from SVN using the following command:

$ svn checkout http://svn.stonekeep.com/svn/congo/trunk

This will check out a working copy of the current 'trunk' version of CONGO.

Create the database instance

You should know how to do this already, but the basics for creating a MySQL? instance and setting grant permissions is:

mysqladmin create congo (you may need to be root, or supply an administrators credentials here) mysql congo grant all privileges on congo.* to congo@'localhost' identified by 'congo' flush privileges exit

Creating the database tables

Change to the congo subdirectory 'structs', and look for the 'do.sh' script. This is a skeleton script designed to load all the MySQL? tables into congo.

Depending on your permissions, you may be able to simply do:

$ ./do.sh congo

and the 'congo' MySQL? instance will be populated. If you have set up username and password settings, you may need to modify the 'mysql' line in the script to supply the credentials.

Install pre-requisite software

If you are comfortable with Java development, generic tools can be used to replace the more advanced environments. You may also use your own editor for code modifications and configurations. These are the tools I've found best match the environment CONGO was developed in. In the future, I hope to be able to adapt the code to more traditional Java environments, using Eclipse for better IDE support, as well as using a normal servlet container, but for now, these are the pieces that have to be used.

• Sun Java JDK 1.5 or later
  Because CONGO is a product in constant development, a JDK is highly recommended to allow source code builds on the fly directly from the SVN repository. Download and install the Sun JDK from http://java.sun.com/. For clarification, you want the Sun Java SE JDK.
• Apache ANT
  Ant is a build tool developed specifically for building and manipulating Java products. Download a binary ZIP file of version 1.6 or later from http://ant.apache.org/ and install it in any directory (it has no Windows installation script, we'll reference it in a minute.
• XAMPP
  XAMPP is an excellent 'all in one' Apache + MySQL? + Perl + PHP environment for Windows. Once installed, it gives an Apache server, a MySQL? database, and a fully configured PHP environment.
• Tortoise SVN
  All of CONGO is stored in a Subversion repository. To access the repository, you'll need an SVN client. For windows, Tortoise SVN, available at http://tortoisesvn.tigris.org/ is an excellent Explorer-embedded SVN system for working with SVN repositories directly from Windows. If you're downloading CONGO via a source tarball or zip file from the website, you won't need the Tortoise SVN client.
• JEdit?
  Actually, any editor will do, I like using JEdit?, a pure java editor available from http://www.jedit.org/, but really any decent text editor (even Notepad if you're particularly narcissistic) will do fine.

Setting your system paths

In order to work properly from the command line, your windows shell needs to have the JDK binary directory and the Ant binary directory on the system path. To do this, right click on your "My Computer" icon and open System Properties. On the Advanced tab, click on the button marked Environment Variables.

Under System Variables scroll to find the 'Path' variable, and double-click on it. Be careful you do not wipe out the existing value here, and add to the value the path to the JDK you installed, something like:

 C:\Program Files\Java\jdk1.6.0_01\bin;

Make sure you leave a semicolon (;) between each path. Also add in the path to the Ant binary directory, like this:

 C:\Program Files\ant\apache-ant-1.7.0\bin;

Click 'ok' on up through the windows to close everything out. The path goes active immediately, so you can test to make sure it works by opening up a command shell (start->run, 'cmd'), and typing the word 'ant'. You should see something similar to this:

 C:\>ant
 Buildfile: build.xml does not exist!
 Build failed

The error message is fine, that's just Ant saying it can't start up in the current directory. Don't worry about it for now, we'll give it work to do later.

Checking out CONGO from SVN via TortoiseSVN?

If you don't have an already checked out copy of CONGO, you can use Tortoise SVN to fetch it.

Open up your Windows explorer, and navigate to a directory where you'd like to put CONGO. Right click on the panel, and you should see 'SVN Checkout...' as one of the options. Select that, and for the SVN URL, use 'svn://svn.stonekeep.com/stonekeep/congo/trunk/'. Select a checkout target directory, and click Ok, and you should get a checked out copy of CONGO copied to your computer. Simple!

Creating the database with PHPMyAdmin?

Part of the XAMPP installation included PHPMyAdmin?, which can be used to create the tables CONGO requires.

After creating the database instance, select it, and click on the 'import' tab in PHPMyAdmin?. There will be a prompt for 'Location of the text file'. You can use the Browse button to navigate to your CONGO installation directory, and select the subdirectory 'structs'.

Import and execute every file in that directory. Unfortunately, you'll need to do it one at a time.

Once all the imports are complete, CONGO should be ready to run. Your next step should be setting up the server. See ServerConfiguration for details on that.