Documentation for Crowd 1.6. Documentation for other versions of Crowd is available too.

The Crowd and CrowdID WAR distributions are intended for deployment onto an existing J2EE application server. It is assumed that you already know how to deploy a web application onto your chosen application server. If not, please contact your system administrator to assist you, or consider installing the Crowd Standalone distribution instead.

The standard Crowd installation guide tells you how to install the Standalone distribution of Crowd, which includes Apache Tomcat. Instead, you may wish to deploy Crowd or CrowdID onto your own existing application server. For this purpose, we provide WAR (Webapp ARchive) distributions of the Crowd and CrowdID server applications.

Crowd supports all the application servers listed in System Requirements.

Below is a generic overview of the steps required to install the Crowd WAR distribution. You will need to perform specific configuration steps depending upon your application server. As well as the generic instructions below, we also provide specific instructions on the following pages:

Step 1. Check the System Requirements

(warning) Please check that your database and server are supported, as outlined in System Requirements, and make sure that all dependencies are installed as described below, otherwise Crowd will not run properly.

  1. Sun JDK 1.5 or higher. You can download the Java SE Development Kit (JDK) from the Sun website.
  2. Note: Once the JDK is installed, you will need to set the JAVA_HOME environment variable, pointing to the root directory of the JDK. Some JDK installers set this automatically (check by typing 'echo %JAVA_HOME%' in a DOS prompt, or 'echo $JAVA_HOME' in a shell). If it is not set, please see Setting JAVA_HOME.
  3. J2EE 1.4 application server or a Servlet 2.4 web container. NOTE: Crowd ships with Apache Tomcat (5.5.x).
  4. JDBC-compliant database that is supported by Hibernate. NOTE: Crowd ships with a built-in HSQL database, which is fine for evaulation purposes. For production environments we recommend configuring Crowd to use an external database.
  5. If you are deploying a WAR installation, ensure that the following JAR files are deployed in the shared lib folder on the application server:

All of these JAR files are available in the Crowd Standalone Distribution zip file, available on the Crowd download centre — jta-1.0.1B.jar, mail-1.4.jar and activation-1.1.jar in CROWD\apache-tomcat-5.5.20\common\lib.

Step 2. Install Crowd WAR

Below is a summary of the Crowd WAR installation steps:

  1. Download the Crowd WAR distribution from the Crowd download centre.
    (info) You will find the WAR archives for the Crowd and the CrowdID applications by clicking the 'Show all' link. You will need to deploy each application separately. For the rest of these instructions, we assume you are deploying Crowd WAR.

  2. Please check your unzip program before extracting the downloaded archive, as some unzip programs can cause errors — see the note on the Crowd installation front page.

  3. Unzip the download archive into a directory of your choice. We'll call it CROWD in the rest of these instructions.

  4. Specify your Crowd Home directory by editing the configuration file at server/default/deploy/crowd.war/WEB-INF/classes/crowd-init.properties.

    The Crowd Home directory is where Crowd will store its configuration information. If you are using the embedded HSQL database, supplied for evaluation purposes, Crowd will also store its database in this directory. To specify the directory:

    • Open the crowd-init.properties file.
    • Choose the appropriate line in the file, depending upon your operating system (see below).
    • Remove the # at the beginning of the line.
    • Enter the name of the directory you want Crowd to use as its Home directory. For example,
      • On Windows: 
        crowd.home=c:/data/crowd-home
        Note: On Windows, make sure you use forward slashes as shown above, not backward slashes.
      • On Mac and Unix-based systems: 
        crowd.home=/var/crowd-home
    • Save the crowd-init.properties file.
  5. Create a database in your chosen database server.

  6. Copy the JDBC driver into your application server's classpath.

  7. Depending upon your application server, you may need to zip up the WAR file again before deploying it. Place the CROWD directory or the WAR file into your application server's deployment directory. Please consult the server-specific documentation on how to do this. A few Atlassian best practice guides are listed here:
  8. Restart your application server.

  9. Point a web browser at the IP address and port that your application server is running on (typically http://localhost:8080). The Crowd Setup Wizard will start.
RELATED TOPICS





Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.