Developer guide

How to build

The IAM is a Spring Boot Java application.

To build it, you will need:

  • Java 8

  • Maven

Build command:

mvn package

Setting up the docker-based development environment

You will need:

  • Docker 1.11.1

  • Docker compose >= 1.7

You can start a development/testing environment with the following command:

docker-compose build
docker-compose up

The docker-compose.yml file requires that you set some environment variables for it to run properly, mainly to provide OAuth client credentials for external authentication mechanisms (Google, Github,...).

The setup also assumes that you have an entry in your DNS server (complex) or /etc/hosts (simpler) that maps to the machine (or VM) where docker is running, e.g.:

$ cat /etc/hosts

How to run tests against the mysql database

IAM JUnit integration tests can (and should) be run against mysql database.

To do so, boostrap the database instance with docker-compose:

docker-compose up db

And then run the tests with the following command:

mvn test

Building Docker production images

To build the docker images for the iam-service and iam-test client, use the following commands:

sh iam-login-service/docker/
sh iam-test-client/docker/

These commands should run after war and jar archives have been built, i.e. after a mvn package.

For more details on the image build scripts see the following folders:

Related projects

This project builds upon the following projects/technologies: