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.2.x or earlier, and
- You want to upgrade to the latest version of Crowd.
If your current installation is Crowd 1.3.0 or later, follow the instructions on upgrading from Crowd 1.3.0 or later.
There are two options for upgrading your pre-1.3.0 installation:
- Allow the Crowd upgrade process to upgrade your existing Crowd database.
- Or export your database to XML, then re-import it into your new Crowd installation.
Further details are given in the instructions below. Follow the steps and choose your preferred option when prompted.
On this page:
Error formatting macro: toc: java.lang.NullPointerException
Step 1. Optional Export your Crowd Database to XML
You can choose to export your Crowd database to XML and then re-import it when upgrading. You might choose this option if you want to use a different database configuration in your new Crowd installation, such as when you are moving from the HSQLDB evaluation database to an external database.
If you choose this option, follow the instructions on backing up your Crowd database to an XML file.
Step 2. Shut down Crowd and All Integrated Applications
Shut down Crowd and all Crowd-connected applications.
Step 3. Back Up your Crowd Files
- 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.
- Make backup copies of the following files:
- 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.
- If you have installed Crowd on a separate application server, you need to back up your customised configuration files.
- 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 4. Re-Install Crowd
- Download Crowd.
- 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.
- Specify a Crowd Home directory for your new Crowd installation, 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,
- Save the crowd-init.properties file.
- Copy the following files, saved in Step 3 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 5. Start Crowd and Run the Setup Wizard
- 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.
- Point a web browser at http://localhost:8095/crowd where you will see the Crowd Setup Wizard.
- Enter your license key on the 'License' screen, as described in the instructions on the Setup Wizard.
- When asked for your Installation Type, choose one of the following options:
- 'Import data from an XML Backup' — Choose this option if you want to import your Crowd data from an XML file which you exported in Step 1 above.
- 'Upgrade the Database from Crowd Version 1.2.x or Earlier' — Choose this option if you want the Crowd upgrade process to automatically upgrade your existing database.
- The Setup Wizard will now ask you to configure your database.
- If you want the upgrade process to update your existing Crowd database, supply the JNDI datasource or JDBC connection details of your existing database.
- If you are planning to import your data from an XML backup, supply connection details to a new database or to your existing database.
If you decide to import directly into your existing database, please ensure that you have made a backup first.
- If you have chosen to import from XML, the Import Existing Crowd Data screen will now appear. Enter the location of your XML backup file.
- The Setup Wizard is now complete. You are now ready to log in to the Crowd Administration Console, using your administrator account from your existing Crowd installation.
Step 6. Update your Integrated Applications
- From Crowd 1.3.0 onwards, there is just a single Crowd integration library. You will need to remove the legacy integration libraries. Perform the following steps in the WEB-INF/lib folder of each Crowd-integrated application:
- Copy the new {CROWD_INSTALL}\client\crowd-integration-client-X.X.X.jar file into the folder.
- Remove the existing crowd-core-X.X.X.jar and crowd-atlassian-user-X.X.X.jar files from the folder.
For details please see the configuration instructions for each application:
- 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.
- 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.
RELATED TOPICS
|