Integrating Crowd with a Custom Application
Crowd ships with out-of-the-box support for a number of applications. You can also integrate Crowd with other applications as follows:
Step 1. Configuring Crowd to talk to your Application
Please see Adding an Application.
Step 2. Configuring your Application to talk to Crowd
2.1 Developing a Crowd Client
If your application is not listed in Supported Applications and Directories then you will need to create your own Crowd client for your application, using the Crowd REST APIs.For assistance, please see the developer's guide to creating a Crowd client for your custom application.
2.2 Configuring your Application
The integration libraries and configuration files are included in the Crowd download, in the client
folder. You will find the Crowd integration library, and the client libraries on which the framework depends, in the lib
folder. An example client properties file crowd.properties
is located in the conf
folder.
To configure your application, perform the following:
- Copy the Crowd client and supporting libraries to your application's classpath, typically
WEB-INF/lib
.
These files will be in Crowd'sclient
folder, with a name similar tocrowd-integration-client-X.X.X.jar
and all supporting JARs in theclient/lib
folder. - Copy the client properties file
crowd.properties
to your application's deployment directory, typicallyWEB-INF/classes
. - Edit the
crowd.properties
file to reflect the values of your deployment parameters. Refer to the description of the attributes in thecrowd.properties
file.
Passing crowd.properties as an environment variable
You can pass the location of a client application'scrowd.properties
file to the client application as an environment variable when starting the client application. This means that you can choose a suitable location for the crowd.properties
file, instead of putting it in the client application's WEB-INF/classes
directory.Example:
-Dcrowd.properties={FILE-PATH}/crowd.properties
RELATED TOPICS
- Using the Application Browser
- Adding an Application
- Integrating Crowd with Atlassian Bamboo
- Integrating Crowd with Atlassian Confluence
- Integrating Crowd with Atlassian CrowdID
- Integrating Crowd with Atlassian Crucible
- Integrating Crowd with Atlassian FishEye
- Integrating Crowd with Atlassian Jira
- Integrating Crowd with Atlassian Bitbucket
- Integrating Crowd with Acegi Security
- Integrating Crowd with Jive Forums
- Integrating Crowd with Spring Security
- Integrating Crowd with a Custom Application
- Configuring the Google Apps Connector
- Mapping a Directory to an Application
- Effective memberships with multiple directories
- Specifying an Application's Address or Hostname
- Testing a User's Login to an Application
- Enforcing Lower-Case Usernames and Groups for an Application
- Managing an Application's Session
- Deleting or Deactivating an Application
- Overview of SSO
- Configuring Options for an Application
- Enabling OpenID client app
- Disabling the OpenID client app
- Allowing applications to create user tokens
- Configuring how users log in
- Configuring Caching for an Application