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

2. Run the sample application:

   $ java -jar IG-sample-application-6.1.0.jar
   Preparing to listen for HTTP on port 8081.
   Preparing to listen for HTTPS on port 8444.
   The server will use a self-signed certificate not known to browsers.
   When using HTTPS with curl for example, try --insecure.
   Using OpenAM URL: http://openam.example.com:8088/openam/oauth2.
   Starting server...
   Sep 09, 2016 9:52:56 AM org.glassfish.grizzly.http.server.NetworkListener start
   INFO: Started listener bound to [0.0.0.0:8444]
   Sep 09, 2016 9:52:56 AM org.glassfish.grizzly.http.server.NetworkListener start
   INFO: Started listener bound to [0.0.0.0:8081]
   Sep 09, 2016 9:52:56 AM org.glassfish.grizzly.http.server.HttpServer start
   INFO: [HttpServer] Started.
   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-6.1.0.jar 8888 8889
   Preparing to listen for HTTP on port 8888.
   Preparing to listen for HTTPS on port 8889.
   The server will use a self-signed certificate not known to browsers.
   When using HTTPS with curl for example, try --insecure.
   Using OpenAM URL: http://openam.example.com:8088/openam/oauth2.
   Starting server...
   Sep 09, 2016 9:55:57 AM org.glassfish.grizzly.http.server.NetworkListener start
   INFO: Started listener bound to [0.0.0.0:8889]
   Sep 09, 2016 9:55:57 AM org.glassfish.grizzly.http.server.NetworkListener start
   INFO: Started listener bound to [0.0.0.0:8888]
   Sep 09, 2016 9:55:57 AM org.glassfish.grizzly.http.server.HttpServer start
   INFO: [HttpServer] Started.
   Press Ctrl+C to stop the server.

   If you change the port numbers when starting the server, also account for the differences when using the examples.

3. Browse to http://localhost:8081/home to access the home page of the sample application.

   Some information about the browser request is displayed.

4. Browse to http://localhost:8081/login to access the login page of the sample application, and then log in with username demo and password changeit.

   The username, demo, and some information about the browser request is displayed.

1. Stop Jetty:

   • If Jetty is running in the background, enter:

     $ /path/to/jetty/bin/jetty.sh stop

   • If Jetty is running in the foreground, enter Ctrl+c in the terminal where Jetty is running.

2. Start Jetty:

   • To start Jetty in the background, enter:

     $ /path/to/jetty/bin/jetty.sh start

   • To start Jetty in the foreground, enter:

     $ cd /path/to/jetty/
     $ java -jar start.jar

This procedure bypasses some of the steps of "To Create a Route With Advanced Options" by using a path condition, and matching the route name to the condition.

1. Browse to http://openig.example.com:8080/openig/studio, and select  Protect an Application.

2. Choose  Structured to use the predefined menus and templates.

3. In Application URL, enter a URL for the application you want to protect followed by a path condition, and then select Create route.

   For example, to allow requests to access the sample application on the my-basic-route path, enter http://app.example.com:8081/my-basic-route.

4. On the top-right of the screen, select  and  Display.

   A route similar to this is displayed, where the path condition is used for the route name:

   {
     "name": "my-basic-route",
     "baseURI": "http://app.example.com:8081",
     "condition": "${matches(request.uri.path, '^/my-basic-route')}",
     "monitor": false,
     "handler": "ReverseProxyHandler"
   }

   After creating a route, you can always change its settings by selecting  Route settings on the top-right of the screen.

1. Browse to http://openig.example.com:8080/openig/studio, and select  Protect an Application.

2. Choose  Structured to use the predefined menus and templates.

3. In the  Create a route window, enter a URL for the application you want to protect, and then select Create route. For example, to protect the sample application, enter http://app.example.com:8081.

4. (Optional) In Condition, select Path or Expression, and then enter a condition for the route. For example, to allow only requests on the path /mypath, select Path and enter /mypath.

   The route can handle requests that meet the condition you specify. If you don't specify a condition, the route can handle all requests.

   For information about route conditions, see "Setting Route Conditions" in the Gateway Guide.

5. In Name, enter a unique name for the route. The name is used to order the routes lexicographically in the configuration. For example, enter the name my route.

   The route ID is filled automatically when you enter a name, and any spaces are replaced by dashes. You can change the name and ID independently. For information about how route names, IDs, and filenames are used in the configuration, see " Configuring Route Names, IDs, and Filenames " in the Gateway Guide.

6. (Optional) Enable stateless sessions, and configure them using the on-screen hints and information in JwtSession(5) in the Configuration Reference. Note that Studio doesn't yet provide options for configuring a keystore for the JwtSession.

   By default, sessions are stateful.

7. Select Create route, and then on the top-right of the screen select  and  Display.

   A route similar to this is displayed:

   {
     "name": "my route",
     "baseURI": "http://app.example.com:8081",
     "condition": "${matches(request.uri.path, '^/mypath')}",
     "monitor": false,
     "session": {
       "name": "JwtSession",
       "type": "JwtSession",
       "config": {
         "cookieName": "openig-jwt-session",
         "sessionTimeout": "30 m",
         "persistentCookie": false
       }
     },
     "handler": "ReverseProxyHandler"
   }

   After creating a route, you can always change its settings by selecting  Route settings on the top-right of the screen.

1. In Studio, select ROUTES and then select a route.

2. On the top-right of the screen, select  and  Display, and then check the configuration. If the route is okay, select  Deploy to push the route to the IG configuration.

   The route status  Deployed is displayed, and the  Deploy button is grey and disabled.

3. Check the $HOME/.openig/config/routes folder in your IG configuration to see that the route is there.

   By default, routes are loaded automatically into the IG configuration. You don't need to stop and restart IG. For information about reloading routes, see "Preventing the Reload of Routes" in the Gateway Guide.

4. Check the system log messages to confirm that the route was loaded succesfully into the configuration. For information about logs, see "Logging Events" in the Gateway Guide.

1. In Studio, select ROUTES and then select a route.

2. On the top-right of the screen, select  and  Undeploy, and then confirm your request.

   The route is removed from the IG configuration. On the Studio screen, the route status  Deployed is no longer displayed, and the  Deploy option is active again.

1. In Studio, select ROUTES and then select a route.

2. Select  Other filters,  New filter, and then Other filter.

3. In Type, select a filter type from the list, and then optionally enter a name and configuration for the filter.

   Note

   Studio checks that the JSON is valid, but doesn't check that the configuration of the filter is valid. If the filter configuration isn't valid, the route fails to load when deployed.

   When you save, the filter is added to the chain. Select  Chain on the left of the screen to view the chain.

4. Deploy the route as described in "Deploying Routes to Your Configuration".

1. In Studio, select ROUTES and then select a route.

2. Edit the route in Studio or manually:

   • To edit in Studio, select options offered in Studio.

   • To edit manually, select  and  Editor mode, and use the JSON editor to edit the route.

   The route status is  Changes pending.

3. Deploy the route as described in "To Deploy a Route to Your Configuration".

1. In Studio, select ROUTES and then  Import a route.

2. Click in the window to import a route, or drag a route from your filesystem.

   If the route has a name property, the name is automatically used for the Name and ID fields in Studio.

3. If necessary, make the following changes, and then select Import:

   • If the Name and ID fields are empty, enter a unique name and ID for the route.

   • If the Name and ID fields are outlined in red, the route name or ID already exists in Studio. Change the name and ID to be unique.

   • If an error message is displayed, the route is not valid JSON. Fix the route and then try again to import it.

   The route is added to the list of routes on the ROUTES page.

4. Deploy the route as described in "Deploying Routes to Your Configuration".