Installing CrowdID WAR Distribution

Below is a summary of the steps required to install the CrowdID WAR distribution.

The Crowd and CrowdID WAR distributions are intended for deployment onto an existing J2EE application server. This documentation assumes 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 distribution instead.

The standard Crowd installation guide tells you how to install the Crowd distribution, 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.

Step 1. Check the System Requirements

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

Supported Platforms

See Supported Platforms.

Dependencies

Ensure that the following JAR files are deployed in the shared lib folder on the application server:

  • JTA (Java Transaction API)

    The JTA specifies standard Java interfaces between a transaction manager and the parties involved in a distributed transaction system: the resource manager, the application server and the transactional applications. Refer to the Sun documentation for more information.

  • JavaMail classes
  • Java Beans Activation Framework (for those using Sun JDK 1.5.x only, this is included in JDK 1.6)

    All of these JAR files are available in the Crowd Standalone Distribution zip file, available on the Crowd download centre. The files are: activation-1.1.jar, jta-1.0.1B.jar and mail-1.4.jar. You will find them in {CROWD_INSTALL}\apache-tomcat\lib (for Crowd 2.0.2 or later) or in {CROWD_INSTALL}\apache-tomcat\common\lib (for Crowd 2.0.1 or earlier).

Step 2. Install CrowdID WAR

Below is a summary of the CrowdID WAR installation steps:

  1. Download the CrowdID WAR distribution from the Crowd download centre.
    (info) You will find the WAR archives for the Crowd and the CrowdID applications. You will need to deploy each application separately. For the rest of these instructions, we assume you are deploying CrowdID WAR.
  2. Please check your unzip program before extracting the downloaded archive – see the note on the Crowd installation front page.
  3. Unzip the download archive into a directory of your choice. We'll call it CROWDID-INSTALLATION in the rest of these instructions.
  4. Modify file CROWDID-INSTALLATION/WEB-INF/classes/crowd.properties to point to the port of your application server. The default is 8080, as shown in the example below:

    crowd.server.url=http://localhost:8080/crowd/services/
    application.login.url=http://localhost:8080/crowd/console/
    
  5. Deploy the CrowdID files to your Tomcat application server. Depending upon your application server, you may need to zip up the WAR file again before deploying it. Place the CROWDID-INSTALLATION directory or the WAR file into your application server's deployment directory. Please consult your application server's documentation on this point.
  6. Configure a CrowdID context in your Tomcat application server:
    • Create a file called openidserver.xml that contains the following context:

      <Context path="/openidserver" docBase="/path/to/atlassian-crowd-openid-war-directory" reloadable="false" />
      
    • Modify the '/path/to/atlassian-crowd-openid-war-directory' in the above element to reflect the actual path to your CrowdID WAR distribution. To avoid problems with your deployment, this should NOT be Tomcat's webapps directory. If you are installing CrowdID on Windows, make sure that the paths you specify for the location of the WAR file and database are full paths including drive letters.
    • Place the file in Tomcat's conf/Catalina/localhost/ directory.
  7. Create a database in your chosen database server, copy the database driver to your application server, add the required datasource definition and edit the jdbc.properties file, as described in Connecting CrowdID to a Database.
  8. Optional: Modify Tomcat's server.xml to allow for a Unicode character set. If your user directory contains usernames or group names with Unicode characters, you need to modify your Tomcat distribution's conf/server.xml file. For example, you need to do this if your user directory allows for internationalized characters in usernames.
    • In your Tomcat distribution's conf/server.xml file, find the connector definition for your HTTP protocol. The connector definition looks very much like this:
      <Connector port="8080" maxHttpHeaderSize="8192"
      maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
      enableLookups="false" redirectPort="8443" acceptCount="100"
      connectionTimeout="20000" disableUploadTimeout="true"/>
      
    • Add a URIEncoding="UTF-8" property to the connector:
      <Connector port="8080" maxHttpHeaderSize="8192"
      maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
      enableLookups="false" redirectPort="8443" acceptCount="100"
      connectionTimeout="20000" disableUploadTimeout="true" URIEncoding="UTF-8"/>
      

      This setting affects all web applications

      Because you must define this property at the connector level, this setting will affect all web applications you have deployed under the connector. This should not adversely affect the other web applications, but please be aware of this fact. Crowd and CrowdID will run fine without this property set, but you will run into issues if a username or group contains internationalized characters.

  9. Restart your application server.
  10. 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

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport