Using the sample application

ForgeRock provides a mockup web application for testing IG configurations. The sample application is used in the examples in this guide and the Gateway guide.

Downloading the sample application

Download IG-sample-application-2023.9.0.jar, from the ForgeRock BackStage download site.

Starting the sample application

Start the sample application:

$ java -jar IG-sample-application-2023.9.0.jar

[...] [INFO   ] All 8 verticles started on ports : [8081, 8444]
[...] [INFO   ] Using session timeout of: 60s
[...] [INFO   ] Using AM base for OpenID Discovery URL: http://am.example.com:8088/openam/oauth2
[...] [INFO   ] Press Ctrl+C to stop the server.

By default this server listens for HTTP on port 8081, and for HTTPS on port 8444. If one or both of those ports are not free, specify other ports:

$ java -jar IG-sample-application-2023.9.0.jar 8888 8889

Check that the sample application is running in one of the following ways:
1. Go to http://localhost:8081/home to access the home page of the sample application. Information about the browser request is displayed.
2. Go to http://localhost:8081/login to access the login page of the sample application, and then log in with username demo and password Ch4ng31t. The username and some information about the browser request is displayed.

Stopping the sample application

In the terminal where the sample application is running, select CTRL+C to stop the app.

Serving static resources for the sample application

When the sample application is used with IG in the examples in this guide and the Gateway guide, the sample application must serve static resources, such as the .css. Add the following route to the IG configuration, as:

Linux
Windows

$HOME/.openig/config/routes/static-resources.json

appdata\OpenIG\config\routes\static-resources.json

{
  "name" : "sampleapp-resources",
  "baseURI" : "http://app.example.com:8081",
  "condition": "${find(request.uri.path,'^/css')}",
  "handler": "ReverseProxyHandler"
}

Configuration options for the sample application

To view the command-line options for the sample application, start it with the -h option:

$ java -jar IG-sample-application-2023.9.0.jar -h

Usage: <main class> [options]
Options:
--http
The HTTP port number.
Default: 8081
--https
The HTTPS port number.
Default: 8444
--session
The session timeout in seconds.
Default: 60
--am-discovery-url
The AM URL base for OpenID Provider Configuration.
Default: http://am.example.com:8088/openam/oauth2
-h, --help
Default: false

IG 2023.9