This page last changed on Jun 19, 2007 by shamid.

Note: Crowd versions 1.1 and later include CrowdID. Installing Crowd will also install CrowdID. 

Installing Crowd

  1. Download Crowd.
  2. Unzip the download archive (Note: do not specify directory names that contain spaces).
  3. Run the start-up script: 
    • start_crowd.bat for Windows;
      or:
    • start_crowd.sh for Unix environment.
  4. Point a web browser at http://localhost:8095/ where you will see the Setup Wizard.

Configuring Crowd

You can configure Crowd to suit your environment, as described in:

Important Files 

When configuring Crowd, there are two important files to be aware of:

  • build.properties — this is a configuration file that stores various deployment properties of Crowd and the demo application.
  • build.xml — this is an Ant script that loads properties from the build.properties configuration file.

When you change the port that Crowd uses or connect Crowd to an external database, you will need to edit  build.properties  and run  build.bat  (or  build.sh).

build.properties

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

Parameter Description
hibernate.dialect This parameter controls the database dialect the Hibernate persistence system will use when executing commands versus your database server.
hibernate.transaction.factory_class This parameter controls the transaction factory to use when executing transactions at run-time:
Hibernate provides two genertic options, additional application server specific options are available:
  • org.hibernate.transaction.JDBCTransactionFactory delegates to database (JDBC) transactions (default).
  • org.hibernate.transaction.JTATransactionFactory delegates to JTA (if an existing transaction is under way, the work performed is done in that context. Otherwise a new transaction is started).
crowd.url The path and port for the root of the Crowd Administration Console web-application.
demo.url The path and port for the root of the Crowd demo web-application
openidserver.url The path and port for the root of the CrowdID web-application

build.xml

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.sh) 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

Related Topics







Document generated by Confluence on Jun 20, 2007 20:58