This page last changed on May 07, 2008 by smaddox.
Before running the Setup Wizard described below, please follow the instructions on installing Crowd.
When you access the Crowd Administration Console for the first time, you will see the Crowd Setup Wizard. This is a series of screens which will prompt you to configure your database connection and to supply some default values (which you can change later if necessary).
On this page:
Error formatting macro: toc: java.lang.NullPointerException
Step 1. Starting the Setup Wizard
Go to the following URL in your web browser: http://localhost:8095/crowd or http://localhost:8095/crowd/console.
- If there are no errors, you should see the 'License' screen described below.
- If there is an error in your configuration, you will see the 'Crowd Checklist' screen. Read more about troubleshooting your installation.
Step 2. Licensing

Crowd licenses are based on the number of end-users who will log in to the applications that are integrated with Crowd.
You can obtain an evaluation license from the Atlassian website. When you obtain an evaluation license — or purchase, renew or upgrade your license — you will receive a license key via email or on the Atlassian website.
Type or paste your license key into the 'License' field, shown on the screenshot above.
Step 3. Installation Type

In this step, you will choose whether to set up a new Crowd database or restore an existing database. Choose an option as follows:
- 'New Installation' — Set up a new Crowd database.
Hint: Choose this option if you are evaluating Crowd.
- 'Import data from an XML Backup' — Import your Crowd data from an XML backup file, which has been exported from your existing Crowd installation.
- 'Upgrade the Database from Crowd Version 1.2.x or Earlier' — Select this option if your Crowd installation is earlier than Crowd 1.3.0 and you don't want to import your data from an XML backup. This option is provided for backwards-compatibility with earlier versions of Crowd. It allows you to upgrade a pre-1.3.0 Crowd database.
If your current Crowd installation is for Crowd 1.3.0 or later, you cannot use this option. Instead, please follow the upgrade instructions.
Step 4. Database Configuration
The 'Database Configuration' screen allows you to choose the type of database connection, as described below.
 | If in any doubt, choose the default 'Embedded' option for evaluation purposes.
|
Option 1: Embedded HSQLDB Database (For Evaluation Purposes Only)

Crowd 'Standalone' is shipped with an embedded HSQLDB database. If you choose the 'Embedded' option, the data files are stored in the Crowd Home directory, as configured on installation.
The HSQLDB database is fine for evaluation purposes, but for production installations you should connect Crowd to an enterprise database using the JDBC or JNDI datasource connections described below. This also lets you take advantage of your existing database backup and recovery procedures.
Option 2: JDBC Connection

Select the 'JDBC Connection' if you want to connect to an external database via a JDBC connection. (If you have not yet created your database for Crowd, follow the database setup instructions.)
Supply the details for your database:
Field |
Description |
Database |
Select your database server type. |
Driver Class Name |
Enter the class name for your database driver. Make sure that the class is in the class path on your application server. See guidelines on creating your specific database. |
JDBC URL |
Enter the URL at which Crowd can access the database JDBC connection. |
Username |
Enter the username which Crowd will use to access the database. |
Password |
Enter the password corresponding to the above username. |
Hibernate Dialect |
This is the Hibernate configuration for the selected database type. The Crowd installation will supply a default dialect for the database type you have chosen. You should only alter this dialect if you need an alternative for the database type or are using an unsupported database type. |
Overwrite Existing Data |
Crowd will ask you to confirm that existing data should be overwritten, if both of the following are true:
- You chose 'New Installation' or 'Import data from an XML Backup' in Step 3 above, and
- The database configured on the above screen already exists and contains Crowd data.
|
Option 3: JNDI Datasource

Select the 'JNDI Datasource' if you want to connect to an external database via a datasource managed by your application server.
Supply the details for your database:
Field |
Description |
Database |
Select your database server type. |
JNDI Name |
Enter the datasource name, e.g. jdbc/CrowdDS or java:comp/env/jdbc/CrowdDS. |
Hibernate Dialect |
This is the Hibernate configuration for the selected database type. The Crowd installation will supply a default dialect for the database type you have chosen. You should only alter this dialect if you need an alternative for the database type or you have selected an unsupported database type. |
Overwrite Existing Data |
Crowd will prompt you to confirm that existing data should be overwritten, if both of the following are true:
- You chose 'New Installation' or 'Import data from an XML Backup' in Step 3 above, and
- The database configured on the above screen already exists and contains Crowd data.
|
Step 5. (Optional) Import Existing Crowd Data

This screen will appear only if you selected 'Import data from an XML Backup' in Step 3 above.
In 'File Location', enter the full path to your XML backup file including the name of the XML file.
 | Upgrading from an existing Crowd installation?
If you have connected to an existing database or imported your data from XML, the setup will be complete once you have clicked 'Continue' on the above screen. See Step 11 below and read more about upgrading Crowd. |
Step 6. Options

This part of the setup process allows you to specify general options for the Crowd server. You can change these values later, via the Crowd Administration Console.
- The deployment title specifies a unique name for your Crowd instance. The deployment title can be used when sending email notifications.
- The session timeout determines how long a session will be considered valid during any period of inactivity. This value is specified in minutes and must be greater than 0.
Step 7. Mail Server

Crowd can send email notifications to users for specific events, such as when a password is reset.
Enter the details of your mail server, and the username and password (if required) that Crowd will use to log in to your mail server, then click the 'Update' button:
- Notification Email — The email address which will receive notifications about server events.
- SMTP Host — The hostname of the SMTP mail server, e.g. 'localhost' or 'smtp.acme.com'.
- From — The email address from which password notifications will be sent to users.
- Subject Prefix — The prefix which will appear at the start of the email subject, for all emails generated by Crowd. This can be useful for email client programs that offer filtering rules.
- Username — The username that your Crowd server will use when it logs in to your mail server.
- Password — The password that your Crowd server will use when it logs in to your mail server.
Step 8. Default Directory

Please configure a default user directory. For information about configuring different types of directories (Internal, LDAP, Delegated Authentication or Custom) refer to Adding a Directory.
 | Crowd administrators group is in default directory The default group crowd-administrators will be automatically created in the default directory. Members of this group have rights to administer Crowd. |
Step 9. Default Administrator

Please specify a default Crowd administrator. The default administrator will be automatically added to the default group crowd-administrators, thereby giving them rights to access the Crowd Administration Console.
Step 10. Integrated Applications

You have the option to auto-configure two applications. We recommend that you select 'True' for both:
Step 11. Setup Complete

You are now ready to use the Crowd Administration Console. For details, please see the Crowd Administration Guide.
RELATED TOPICS
|