^ FIXME WARNING ^
| This page is incomplete. Information presented here may not be complete or entirely reliable. Use at your own risk! |

This page describes the process of installing the Engine on your computer. This page assumes you have a valid installation of Java 1.5 or higher and have opened the necessary ports on your firewall (port 13106 for incoming HTTP traffic - and port 25 and 110 for outgoing SMTP and POP3 connections).

There are two ways to get the Engine - you can download an executable JAR file or you can compile the Engine from source yourself.

====== Requirements ======
  * A Java Runtime Environment (JRE) compatible with version 1.5 or higher (Java SE 6 is recommended)
  * A database supported by Hibernate (for instance [[http://www.mysql.com|MySQL]] or [[http://www.postgresql.org/|PostgreSQL]]), see the [[http://www.hibernate.org/hib_docs/v3/reference/en/html/session-configuration.html#configuration-optional-dialects|Hibernate manual]] for more information
  * A JDBC implementation for the database you are using
  * A web browser
  * Sufficient drive space, and a writable folder to run the Engine in
If you want to compile the Engine, the following things are also required:
  * A Java Development Kit (JDK) compatible with version 1.5 or higher (Java SE 6 is recommended)
  * [[http://maven.apache.org|Apache Maven]], if you want to compile the source yourself
  * [[http://subversion.tigris.org|Subversion]], for getting the source

====== Getting the source and compiling ======

Open up a shell and change to the directory you want to place the source in, execute the following command to check out the source:

<code bash>
$ svn co https://pbemengine.svn.sourceforge.net/svnroot/pbemengine/trunk pbemengine
</code>

This will create a new folder named ''pbemengine'' - you can also change this to ''.'' to put it in the current directory. Please not that this will fetch the latest development version, and is not guaranteed to work. To stay safe you may want to consider checking out a tagged release or downloading a release from the site rather than compiling yourself.

Once the source is checked out, enter the ''pbemengine'' folder:

<code bash>
$ cd pbemengine
</code>

And start up Maven to create an executable:

<code bash>
$ mvn assembly:assembly
</code>

This will create a folder named ''target'' in your directory, which will contain a a file named:

<code>
PBEMEngine-VERSION-bin.jar
</code>

Copy this JAR file to the directory in which you want to install the Engine, change to that directory and proceed with the ''Installing'' section.

====== Installing ======

The PBEM Engine includes support for the [[http://www.postgresql.org/|PostgreSQL]] database by default. If you intend to use PostgreSQL, you can proceed to ''Starting the Engine''.

===== Setting up JDBC =====

Create a new directory named ''lib'' in the directory that contains the Engine JAR:

<code bash>
$ mkdir lib
</code>

Next, copy the JDBC jar library of the database you wish to use to this directory (again: this is not required for PostgreSQL).

===== Starting the Engine =====

<code bash>
$ java -jar jarfile.jar
</code>

Where the word jarfile needs to be replaced by the name of the JAR file you're using. Assuming no errors occur (there's not much that can go wrong at this point), the Engine will notify you that it has started in installer mode. If it starts normally however, the Engine has already been configured and you can skip the rest of this guide.

Next, open up a browser and type in the following URL:

<code>
http://localhost:13106/
</code>

FIXME