Documentation

In addition to the changes described elsewhere in these notes, the following important changes were made to the documentation:

Reorganization

• The Maintenance Guide has been added to describe tasks and configurations you might repeat throughout the life cycle of a deployment in your organization. The guide is for anyone who sets up and maintains IG services for their organization.

  The following chapters have been moved from the Gateway Guide:

  • Auditing Your Deployment

  • Monitoring Services

  • Troubleshooting

• The Studio User Guide has been added to describe how to use the IG studio to design and develop routes to protect applications. Examples that used Studio have been moved from the Gateway Guide.

• The Deployment Guide now refers to the Docker image provided with the product. Previously, it referred to a Dockerfile provided on Github.

• Information about how decorators are implemented in IG has been moved from the Reference Guide to "Decorators". Information about the decorators provided by IG, remains in Decorators.

Best Practices

• Information about how to install IG in standalone mode, installed from a .zip file, has been added to "Downloading and Starting IG in Standalone Mode".

  Pointers for migrating from web container mode to standalone mode, have been added to Migration.

• Information about how create a Docker image from the Dockerfile provided in the IG .zip file, has been added to Deployment Guide.

• Information about how to do a basic installation of IG in Tomcat and JBoss has been moved from the Gateway Guide to the Getting Started Guide.

• Information about how to configure IG for HTTPs (server-side) has been added to Installation in Detail.

More Overviews

• "Sessions" has been added to provide an overview of how IG manages sessions.

• Information about the Delegate object has been added to the target property of "OAuth2ClientFilter".

• Information about the properties of ${attributes.openid} has been added to "AttributesContext".

More Examples

• Information about routes that do not enforce authentication for specific request URLs or URL patterns has been added in Implementing Not-Enforced URIs for Authentication.

• An example that sets up a deployment with three instances of IG, that share a JwtSession has been added to "Sharing JWT Session Between Multiple Instances of IG".

• ForgeRock Directory Services (DS) is now secure by default, and connections between IG and DS must therefore be configured for TLS. The example of scripting authentication to non-secure, LDAP-enabled servers has been removed from "Scripting Authentication to LDAP-Enabled Servers".

Standards

Supported Standards has been added to list the standards supported by IG.