----------------------------------------------------
| Installing instructions for the improve! program |
----------------------------------------------------

Requirements:

- On the server side, improve! requires a JSP/Servlet Container like
  Apache Tomcat, and a MySQL data base.

- On the client side, it requires any web browser. Java and JavaScript are not
  required on the client machine.

Installing instructions:

- Install Java 2 Standard Edition 1.4.2 or higher.
  Please refer to the respective installing instructions.
  More information about Java and a download can be found on the Sun Java
  home page: http://java.sun.com.

- Install a JSP/Servlet container that supports the Servlet API 2.4 or higher
  and the JSP API 2.0 or higher, e.g. Tomcat 5.0.
  Please refer to the respective installing instructions.
  More information about Tomcat and a download can be found on the Jakarta
  home page: http://jakarta.apache.org.

- Install MySQL 4.1 or higher.
  Please refer to the respective installing instructions.
  More information about MySQL and a download can be found on the MySQL
  home page: http://www.mysql.com.

- Create a data base user and assign a password. Create a data base named
  'improve'. If using MySQL 4.1 or higher, it is recommended to use InnoDB,
  because it supports transactions. To enable it, execute:
  mysql improve
  set table_type = InnoDB

- Execute the SQL init files schema-init.sql and data-init.sql in the src/sql
  folder, e.g.:
  mysql improve <src/sql/schema-init.sql
  mysql improve <src/sql/data-init.sql

- Copy the improve.war file located the bin directory (repacked if you opened
  it) into the webapps directory of the JSP container.

- Copy the MySQL driver, as well as lib/j2ee/activation.jar,
  lib/j2ee/mailapi.jar, lib/j2ee/smtp.jar, and lib/j2ee/jta.jar
  (if not provided by the JSP/Servlet Container) into the external library
  folder of the Container.
  For Tomcat, this is common/lib, for Resin, this is lib.

- Configure the J2EE DataSource (for data base connections) and Mail Session
  (for email notifications). The DataSource must be available under JNDI key
  'jdbc/DataSource' and the Mail Session under key 'mail/Session'. You can
  find Container configuration examples in the conf/tomcat-example and
  conf/resin-example folders that only need minimal adjustments for your
  installation.

- Start both the mysqld and the JSP/Servlet container.

Client access:

  You can you access improve! from any machine that has sufficient rights to
  access the server. When using Tomcat, the default URL is

  http://<hostname>:8080/improve

  If you installed the SSL service into the JSP container, the improve! can
  also be accessed via SSL.

Administrator:

  The default administrator credentials are 'root', password 'root'. He has
  full administration rights. You should change this account immediately after
  successful installation.

Used components:

  The improve.war file also contains a version of

  - Jakarta Struts: Web presentation framework
    http://jakarta.apache.org/struts

  - JBoss Hibernate: OR mapping framework
    http://www.hibernate.org

  - Spring Framework: Bean container and AOP implementation
    http://www.springframework.org

  - Jakarta Commons: Generic tools
    http://jakarta.apache.org/commons

  - MySQL JDBC driver: Data base driver
    http://www.mysql.com

  - others

  If you unpack the improve.war (a ZIP archive with a different file extension,
  so it can be renamed), you can exchange these files with different versions.
