descoped/crowd repository overview

⁠Descoped Atlassian Crowd

⁠About

Crowd is an Identity Management Application for web apps that are used by other Atlassian application to simplify access control. Crowd consists of several independent components that are configurable by setting environment variables when running the image.

For all other aspects about configuring, using and administering Crowd please see The Official Crowd Documentation⁠.

⁠How to use?

The examples shown below assume you will use a MySQL database.

⁠Prerequisites

• MySQL 5.5 or 5.6 (please notice that Crowd is not compatible with MySQL 5.7)
• PostgreSQL 8.4+

⁠Database Setup

MySQL setup (assuming that MySQL isn't installed yet):

$ docker run -d -p 3306:3306 --name mysql -v /var/mysql:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=[db-password] mysql/mysql-server:5.6
$ mysql -h 172.17.0.2 -u root -p[db-password]
CREATE DATABASE IF NOT EXISTS crowd character set utf8 collate utf8_bin;
CREATE DATABASE IF NOT EXISTS crowdid character set utf8;

If you use a default Docker installation with no images installed, the assigned IP for MySQL will be: 172.17.0.2.

Optionally you may configure security constraints by:

GRANT ALL PRIVILEGES ON crowd.* TO '[appuser]'@'172.17.0.3' IDENTIFIED BY '[apppassword]' with grant option;
GRANT ALL PRIVILEGES ON crowdid.* TO '[appuser]'@'172.17.0.3' IDENTIFIED BY '[apppassword]' with grant option;

⁠Installation

Run docker using port 8095 on your host (if available):

docker run -p 8095:8095 descoped/crowd

Run with data outside the container using a volume:

$ docker run --name crowd -v /var/crowd-home:/var/atlassian-home -e CROWD_CONTEXT=ROOT -e CROWD_URL=http://localhost:8095 -e CROWDDB_URL=mysql://[db-username]:[db-password]@172.17.0.2/crowd -e CROWDIDDB_URL=mysql://[db-username]:[db-password]@172.17.0.2/crowdid -e SPLASH_CONTEXT= -p 8095:8095 descoped/crowd

⁠Workaround for error with Remote address

After the initial installation you may experience an issue where you are not allowed to login to Crowd. This is because the Crowd guest IP (e.g. 172.17.0.3) is not registered with Crowd. In order to circumvent this issue you need to add your Docker Gateway IP to the Crowd database as follows:

$ mysql -h 172.17.0.2 -u root -p[db-password] crowd;
SELECT id FROM cwd_application WHERE application_name = "crowd";               # expected return value: 2
SELECT id FROM cwd_application WHERE application_name = "crowd-openid-server"; # expected return value: 3
INSERT INTO cwd_application_address (APPLICATION_ID, REMOTE_ADDRESS) VALUES (2,'172.17.0.1');
INSERT INTO cwd_application_address (APPLICATION_ID, REMOTE_ADDRESS) VALUES (3,'172.17.0.1');

After this step the crowd instance needs to be restarted:

$ docker crowd stop
$ docker crowd start

You should now be able to login to Crowd.

⁠Docker Volume

The mappable VOLUME is: /var/atlassian-home

⁠Browser URL:

http://192.168.1.2:8095/

The host IP is assumed to be 192.168.1.2.

⁠Configuration

⁠Database connection

The connection to the database can be specified with an URL of the format:

[database type]://[username]:[password]@[host]:[port]/[database name]

Where database type is either mysql or postgresql and the full URL look like this:

MySQL:

mysql://<username>:<password>@172.17.0.2/crowd

PostgreSQL:

postgresql://<username>:<password>@172.17.0.2/crowd

⁠Environement variables

⁠Default welcome splash pages

This component serves just as a welcome page and since it is by default loaded as the root context will be the first thing you see when going to http://192.168.1.2:8095⁠. As such it has links to the other components but keep in mind that these links will not be updated should you change the context path of any of the components.

For anything but a default install it is recommended that you disable this component by setting its context path to the empty string.

⁠Crowd

The main component included and really the only component that you truly need. This component needs a database but can use an embedded HSQLDB for testing purposes and so the database related variables are not mandatory.

⁠CrowdID

The bundled OpenID server. Like the Crowd component this also needs a database and it is imperative that this be independent of the Crowd database.

⁠OpenID client

An OpenID client that can be used to test the CrowdID integration.

⁠Demo webapp

A demonstration webapp that shows how Crowd integration works.

⁠Source code

If you want to contribute to this project or make use of the source code; you'll find it on GitHub⁠.

⁠Building the image

docker build -t descoped/crowd .

⁠Further reading

• Reference to base image⁠