This page last changed on May 08, 2008 by smaddox.

Follow the instructions below if both the following are true:

  • Your current version of Crowd is Crowd 1.3.0 or later, and
  • You want to upgrade to the latest version of Crowd.

If your current installation is earlier than Crowd 1.3.0, follow the instructions on upgrading from Crowd 1.2.x or earlier.

On this page:

Error formatting macro: toc: java.lang.NullPointerException

Step 1. Shut Down Crowd and All Integrated Applications

Shut down Crowd and all Crowd-connected applications.

Step 2. Back Up your Crowd Files

  1. Make a backup of your Crowd database and your CrowdID database. We highly recommend this step, in case something goes wrong during the upgrade process and you need to restore your data from backup.

  2. Make backup copies of the following files:
    • Your Crowd Home directory — recommended in case something goes wrong during the upgrade process.
    • The crowd.properties file for the Crowd Administration Console application, located at
      {CROWD_INSTALL}\crowd-webapp\WEB-INF\classes\crowd.properties — you will need to copy this file to your new Crowd installation.
    • The crowd.properties file for the CrowdID application, located at
      {CROWD_INSTALL}/crowd-openidserver-webapp/WEBINF/classes/crowd.properties — you will need to copy this file to your new Crowd installation.

  3. If you have installed Crowd on a separate application server, you need to back up your customised configuration files.

  4. We recommend that you rename your existing {CROWD_INSTALL} directory, as legacy files may cause problems if you unzip the new Crowd installation into an existing directory.

Step 3. Re-Install Crowd

  1. Download Crowd.

  2. Unzip the download archive into a directory of your choice, taking note of the following:
    • Please check your unzip program before extracting the downloaded archive – see the note on the Crowd installation front page.
    • Do not specify directory names that contain spaces.
    • We'll refer to this installation directory as {CROWD_INSTALL}.
    • Please make sure that your new {CROWD_INSTALL} directory has a different name from your old {CROWD_INSTALL} directory.

  3. Point the new Crowd installation at your existing Crowd Home directory by editing the configuration file at {CROWD_INSTALL}\crowd-webapp\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.

    You must make sure you point the new Crowd installation at your existing Crowd Home directory so that the new Crowd can use your existing configuration.


  4. Copy the following files, saved in Step 2 above, to your new Crowd installation:
    • Copy the crowd.properties file for the Crowd Administration Console to your new {CROWD_INSTALL}\crowd-webapp\WEB-INF\classes directory.
    • Copy the crowd.properties file for the CrowdID application to your new {CROWD_INSTALL}/crowd-openidserver-webapp/WEBINF/classes directory.
    • If you have installed Crowd on a separate application server, copy your customised configuration files.

Step 4. Update your Integrated Applications

  1. Copy the new {CROWD_INSTALL}\client\crowd-integration-client-X.X.X.jar file to each Crowd-integrated application's WEB-INF/lib folder, replacing the existing crowd-integration-client-X.X.X.jar file.
    For details please see the configuration instructions for each application:
  2. If you have installed Crowd on a new server, or changed Crowd's URL or port number, you will also need to edit the crowd.properties file in each integrated application accordingly.

  3. For better caching, copy the new {CROWD_INSTALL}\client\conf\crowd-ehcache.xml file to each Crowd-integrated application's WEB-INF/classes/ folder, replacing the existing file.

If you are using CrowdID with an external database, you will still need to use the manual JNDI datasource configuration method to configure an external database connection.

Step 5. Start Crowd

  1. Run the start-up script, found in your {CROWD_INSTALL} directory:
    • start_crowd.bat for Windows.
    • start_crowd.sh for Mac and Unix-based systems.
  2. Point a web browser at http://localhost:8095/crowd. You should now be able to use the Crowd Administration Console.
RELATED TOPICS
Document generated by Confluence on Aug 27, 2008 20:21