AgileSoup installation guide.

AgileSoup is a 'web application', meaning it runs on a server, and users interact with it through web browsers.

Software Requirements

Browser

AgileSoup runs on any major browser (Firefox 3+, Chrome 4+, Safari 4+, IE 7+)

 

If you have disabled Javascript in your browser or are using a script blocker like NoScript, you will need to enable Javascript for AgileSoup.

 

Operating System

• Microsoft Windows
• Linux/Solaris
• Apple Mac OS

Java

AgileSoup runs on Java6 platform, so you must have JRE or JDK version 1.6 installed on your machine. You also need to set JAVA_HOME system environment variable to point to where the JDK software is located

• To download JDK go to http://java.sun.com/javase/downloads/index.jsp select the JDK version 6 and click Download
• To set JAVA_HOME system variable:
  • on a Windows System

    Right click My Computer and select Properties. On the Advanced tab, select Environment Variables, and then edit JAVA_HOME to point to where the JDK software is located

  • on a UNIX System

    One way that you can set your JAVA_HOME variable and add it to your PATH, is be doing the following.

    As 'sudo' open up /etc/bash.bashrc and add the following to the end of the file. NOTE: Set the java path to whatever the actual path is on your environment if it does not match /usr/lib/jvm/java

    Code Block
    JAVA_HOME=/usr/lib/jvm/java
    export JAVA_HOME
    PATH=$PATH:$JAVA_HOME/bin
    export PATH
    

MySQL

You need MySQL version 5.x to run AgileSoup.

 

• Download and install MySQL server 5.x from http://www.mysql.com/downloads/mysql/
• Create a database user which AgileSoup will connect as (e.g. agilesoupuser with password agilesouppassword)
• Create a database for AgileSoup (e.g. agilesoupdb). The database must have a character set of UTF8. To create it - enter the following command from within the MySQL command client:
  Code Block
  create database agilesoupdb character set utf8;

• Ensure that the user has permission to connect to the database, and permission to create and populate tables.
• You need to ensure that your MySQL database will use the InnoDB storage engine.

Download AgileSoup

AgileSoup Standalone ships pre-configured with the Apache Tomcat 6 application server.

 

• Download a bundle which suits your system (toward the top/left of this page)

Unpack bundle

 

Go to install-dir/conf and edit server.xml file. At the bottom you'll find agilesoup datasource configuration section (which looks like the example below)

Set database name, username and password you have chosen for mysql user and, if necessary, change the port mysql server is running on.

 

So in case you used example values specified above and mysql server runs on default port datasource configuration will look like.

 

Start/stop AgileSoup

To start AgileSoup server - go to the install-dir/bin folder and execute startup.bat (startup.sh for UNIX users).
Agilesoup will be available at http://localhost:8080/agilesoup url.

 

To stop AgileSoup server - go to the install-dir/bin folder and execute shutdown.bat (shutdown.sh for UNIX users).