The crowd.properties File

The crowd.properties file, containing application configuration settings for the Crowd Administration Console application, is located at the root of your Crowd Home directory.

For more information, refer to the page about the crowd.properties File.

The crowd.cfg.xml File

This file stores configuration information for the Crowd Administration Console application, including:

• License information
• Server ID
• Database configuration properties
• Setup phase reached.

The contents of this file is automatically generated when you run the Crowd Setup Wizard.

The file is located at the root of your Crowd Home directory.

Here's an example of the content of crowd.cfg.xml, when the embedded HSQL database was specified at setup:

<?xml version="1.0" encoding="UTF-8"?>

<application-configuration>
  <setupStep>complete</setupStep>
  <setupType>install.new</setupType>
  <buildNumber>320</buildNumber>
  <properties>
    <property name="crowd.server.id">B9AN-B9AN-B9AN-B9AN</property>
    <property name="hibernate.c3p0.acquire_increment">1</property>
    <property name="hibernate.c3p0.idle_test_period">100</property>
    <property name="hibernate.c3p0.max_size">15</property>
    <property name="hibernate.c3p0.max_statements">0</property>
    <property name="hibernate.c3p0.min_size">0</property>
    <property name="hibernate.c3p0.timeout">30</property>
    <property name="hibernate.connection.driver_class">org.hsqldb.jdbcDriver</property>
    <property name="hibernate.connection.password"></property>
    <property name="hibernate.connection.url">jdbc:hsqldb:C:/data/crowd-home-15/database/defaultdb</property>
    <property name="hibernate.connection.username">sa</property>
    <property name="hibernate.dialect">org.hibernate.dialect.HSQLDialect</property>
    <property name="hibernate.setup">true</property>
    <property name="license">AAABGQ0ODAoPeNpdkF1LwzAUhu/plus-some-more-stuff</property>
  </properties>
</application-configuration>

The bundled-plugins Directory in Crowd Home

The bundled-plugins directory is a sub-directory of your Crowd Home directory. It contains plugins which are shipped with your Crowd installation, such as:

• The SAML integration plugin which provides the Google Apps SSO feature.
• The Shared Access Layer (SAL) plugins.
• The REST module plugin.
• And more.

The plugins are a collection of jars generated when you install the Crowd web application. The jars are obtained by unzipping atlassian-bundled-plugins.zip from {CROWD_INSTALL}\crowd-webapp\WEB-INF\classes.

The caches Directory in Crowd Home

The caches directory is a sub-directory of your Crowd Home directory. It contains various files that Crowd caches to improve performance. The files in sub-directories of this directory are either created or updated generated when you install or restart the Crowd web application.

Do not modify or remove these files while Crowd is running. It should be safe for you to delete these files between application restarts.

It may improve Crowd's performance if you link this sub-directory to a fast disk.

The database Directory in Crowd Home

If you are using the embedded HSQL database, supplied for evaluation purposes, Crowd will store its database in this directory. (Note however that the CrowdID database will be in the Crowd Installation directory, not the Crowd Home directory.)

The plugin-data Directory in Crowd Home

The plugin-data directory is a sub-directory of your Crowd Home directory. This is a place for plugins to store their data. The directory will be created the first time a plugin needs it. For example, if you configure the Google Apps Connector, then the connector's SSO Keys will be stored in the plugin-data directory.

The plugins Directory in Crowd Home

The plugins directory is a sub-directory of your Crowd Home directory. This directory will contain plugins that are not shipped with Crowd and that you have installed separately onto your Crowd instance.

The crowd-init.properties File

This is where you specify your Crowd Home directory (described above). You can set the location during installation.

The crowd-init.properties file is located in the Crowd Installation directory at {CROWD_INSTALL}\crowd-webapp\WEB-INF\classes\crowd-init.properties

The file content looks something like this before it has been customised:

## You can specify your crowd.home property here or in your system environment variables.

# On Windows-based operating systems, uncomment the following 
# line and set crowd.home to a directory Crowd should use to 
# store its configuration.
# NOTE: use forward slashes instead of backward slashes

#crowd.home=c:/data/crowd-home

# On Unix-based operating systems, uncomment the following
# line and set crowd.home to a directory Crowd should use to 
# store its configuration.

#crowd.home=/var/crowd-home

The build.properties File

This configuration file stores various deployment properties of Crowd and the 'demo' application.

The file is located at the root of your Crowd Installation directory (described above).

The default build.properties file will look similar to the following:

# Modify the attributes of this file to quickly adjust the deployment values of Crowd.

# The Hibernate database dialect to use.
hibernate.dialect=org.hibernate.dialect.HSQLDialect

# The Hibernate transaction factory to use.
hibernate.transaction.factory_class=org.hibernate.transaction.JDBCTransactionFactory

# The http port you wish to run crowd from, ie: http://localhost:8095/crowd
crowd.tomcat.connector.port=8095

# Tomcat requires a unique port for shutdown
crowd.tomcat.shutdown.port=8020

# Crowd context root
crowd.url=http://localhost:8095/crowd

# Demo context root
demo.url=http://localhost:8095/demo

# OpenID server context root
openidserver.url=http://localhost:8095/openidserver

The build.xml File

This is an Ant script that loads properties from the build.properties configuration file.

The file is located at the root of your Crowd Installation directory (described above).

If configuring Crowd and/or the demo application to run on a port and context path other than the default, you will need to run the command build.sh (or build.bat) against the build.xml configuration file. This process will then edit all of the necessary Crowd configuration files for your deployment.

The sample output from running build.xml will look similar to the following:

shamid@mocha:~/atlassian-crowd-1.1.0$ ./build.sh
Buildfile: build.xml

init:

assistant:
 Changing Tomcat's connector port to 8095
 Changing Tomcat's shutdown port to 8020
Configuring the Crowd Console
Copying crowd.properties to: crowd-webapp/WEB-INF/classes
Copying 1 file to /home/shamid/atlassian-crowd-1.1.0/crowd-webapp/WEB-INF/classes
Configuring the Crowd hibernate configuration
Updating the HibernateDialect and TransactionFactory in crowd-webapp/WEB-INF/classes/jdbc.properties
Updating property file: /home/shamid/atlassian-crowd-1.1.0/crowd-webapp/WEB-INF/classes/jdbc.properties
Configuring the demo application
Renaming and copying demo.properties to: demo-webapp/WEB-INF/classes/crowd.properties
Copying 1 file to /home/shamid/atlassian-crowd-1.1.0/demo-webapp/WEB-INF/classes
Configuring the OpenID server application
Renaming and copying openidserver.properties to: crowd-openidserver-webapp/WEB-INF/classes/crowd.properties
Copying 1 file to /home/shamid/atlassian-crowd-1.1.0/crowd-openidserver-webapp/WEB-INF/classes
Configuring the OpenID hibernate configuration
Updating the HibernateDialect and TransactionFactory in crowd-openidserver-webapp/WEB-INF/classes/jdbc.properties
Updating property file: /home/shamid/atlassian-crowd-1.1.0/crowd-openidserver-webapp/WEB-INF/classes/jdbc.properties

BUILD SUCCESSFUL
Total time: 2 seconds

The database Directory in the Crowd Installation Directory

If you are using the embedded HSQL database, supplied for evaluation purposes, CrowdID will store its database in this directory. (Note however that the Crowd database will be in the Crowd Home directory, not the Installation directory.)