Documentation for Crowd 2.0.x. Documentation for other versions of Crowd is available too.

Skip to end of metadata
Go to start of metadata

You can back up your Crowd data by exporting it to an XML file. The data includes:

  • Your Crowd server configuration details, including connection details for all your directories and applications.
  • Any internal directories that exist.

Important Note about Crowd Backup Functionality

Icon

At present, Crowd does not allow you to schedule periodic backups. We do have an open feature request for this. Until this feature is added to Crowd, we recommend using alternative backup methods such as:

  • A periodic backup or dump of your database using tools provided by your database.
  • A backup of your Crowd Home directory using external backup tools.

We recommend that you back up your data regularly, especially after any significant configuration changes. You should also perform regular backups of your database.

To back up your Crowd data,

  1. Log in to the Crowd Administration Console.
  2. Click the 'Administration' tab in the top navigation bar.
  3. Click 'Backup' in the left-hand menu.
  4. Select the 'Reset Domain' checkbox if the backup file will be restored onto a different server. Selecting 'Reset Domain' will reset the domain to blank. (After you restore the data, you can change the domain as described in Domain.)
  5. Enter an appropriate 'Backup File Name'. This will be the name of the XML file that Crowd will create. When the backup process has finished, you will find the backup file in the /backups directory under your Crowd Home directory.
  6. Click the 'Submit' button.

To restore your Crowd data,

(info) Before you begin: If you created the XML backup file on a different server, edit the crowd.properties file and change the password to match the password of the server on which you created the XML backup file.

  1. Log in to the Crowd Administration Console.
  2. Click the 'Administration' tab in the top navigation bar.
  3. Click 'Restore' in the left-hand menu.
  4. In the 'Restore File Path' field, type the path to the backup file, including the name of the XML file.
  5. Click the 'Submit' button.

Screenshot 1: 'Backup'



Screenshot 2: 'Restore'



RELATED TOPICS

Crowd Documentation