Documentation update (#100)

openig-doc/src/main/asciidoc/gateway-guide/chap-extending.adoc

@@ -18,6 +18,8 @@
 :figure-caption!:
 :example-caption!:
 :table-caption!:
+:openig-version: 5.3.1
+
 
 
 [#chap-extending]
@@ -796,13 +798,13 @@ Within the `create()` method, you can access the object's configuration through
 You can use Apache Maven to manage dependencies on OpenIG. The dependencies are found in the Central Maven repository.
 
 
-[source, xml]
+[source, xml, subs="normal"]
 ----
   <dependencies>
     <dependency>
       <groupId>org.openidentityplatform.openig</groupId>
       <artifactId>openig-core</artifactId>
-      <version>5.3.0</version>
+      <version>{openig-version}</version>
     </dependency>
   </dependencies>
 ----
@@ -831,14 +833,14 @@ After building your customizations into a .jar file, you can include them in the
 
 For example, if your .jar file is in a project named `sample-filter`, and the development version is `1.0.0-SNAPSHOT`, you might include the file as in the following example:
 
-[source, console]
+[source, console, subs="attributes"]
 ----
 $ mkdir root && cd root
-    $ jar -xf ~/Downloads/OpenIG-5.3.0.war
+    $ jar -xf ~/Downloads/OpenIG-{openig-version}.war
     $ cp ~/Documents/sample-filter/target/sample-filter-1.0.0-SNAPSHOT.jar WEB-INF/lib
     $ jar -cf ../custom.war *
 ----
-In this example, the resulting `custom.war` contains the custom sample filter. You can deploy the custom .war file as you would deploy `OpenIG-5.3.0.war`.
+In this example, the resulting `custom.war` contains the custom sample filter. You can deploy the custom .war file as you would deploy `OpenIG-{openig-version}.war`.
 
 
 

openig-doc/src/main/asciidoc/gateway-guide/chap-install.adoc

@@ -12,7 +12,7 @@
   information: "Portions copyright [year] [name of copyright owner]".
 
   Copyright 2017 ForgeRock AS.
-  Portions Copyright 2024 3A Systems LLC.
+  Portions Copyright 2024-2025 3A Systems LLC.
 ////
 
 :figure-caption!:
@@ -56,7 +56,6 @@ For details, see xref:#configure-network[Preparing the Network].
 +
 For details, see xref:#install[Installing OpenIG].
 
-
 [#configure-container]
 === Configuring Deployment Containers
 
@@ -437,7 +436,6 @@ C:>set OPENIG_BASE=c:\path\to\openig
 ----
 $ java -Dopenig.base=/path/to/openig -jar start.jar
 ----
-
 +
 If you have not yet prepared configuration files, then start with the configuration described in xref:chap-quickstart.adoc#quickstart-config[Configure OpenIG].
 +
@@ -555,7 +553,7 @@ $ keytool \
 ----
 You could then configure the following KeyStore for OpenIG that holds the trusted certificate. Notice that the url field takes an expression that evaluates to a URL, starting with a scheme such as `\file://`:
 
-[source, javascript]
+[source, json]
 ----
 {
     "name": "MyKeyStore",
@@ -568,7 +566,7 @@ You could then configure the following KeyStore for OpenIG that holds the truste
 ----
 The TrustManager handles the certificates in the KeyStore when deciding whether to trust the server certificate. The TrustManager references your KeyStore:
 
-[source, javascript]
+[source, json]
 ----
 {
     "name": "MyTrustManager",
@@ -605,7 +603,7 @@ In that case, generate a key pair for OpenIG, and have the certificate signed by
 --
 The following `ClientHandler` configuration references `MyTrustManager` and sets strict host name verification:
 
-[source, javascript]
+[source, json]
 ----
 {
     "name": "ClientHandler",
@@ -649,7 +647,7 @@ $ keytool \
 . Add a KeyStore to your configuration that references the keystore file:
 +
 
-[source, javascript]
+[source, json]
 ----
 {
     "name": "MyKeyStore",
@@ -666,7 +664,7 @@ For details, see xref:../reference/misc-conf.adoc#KeyStore[KeyStore(5)] in the _
 . Add a JwtSession to your configuration that references your KeyStore:
 +
 
-[source, javascript]
+[source, json]
 ----
 {
     "name": "MyJwtSession",
@@ -683,7 +681,7 @@ For details, see xref:../reference/misc-conf.adoc#KeyStore[KeyStore(5)] in the _
 . Specify your JwtSession object in the top-level configuration, or in the route configuration:
 +
 
-[source, javascript]
+[source, json]
 ----
 "session": "MyJwtSession"
 ----

openig-doc/src/main/asciidoc/gateway-guide/chap-password-capture-replay-tutorial.adoc

@@ -12,12 +12,13 @@
   information: "Portions copyright [year] [name of copyright owner]".
 
   Copyright 2017 ForgeRock AS.
-  Portions Copyright 2024 3A Systems LLC.
+  Portions Copyright 2024-2025 3A Systems LLC.
 ////
 
 :figure-caption!:
 :example-caption!:
 :table-caption!:
+:openig-version: 5.3.1
 
 
 [#chap-password-capture-replay-tutorial]
@@ -71,9 +72,9 @@ This tutorial calls for you to set up several different software components:
 
 * OpenAM is installed on `\http://openam.example.com:8088/openam`.
 
-* Download and run the link:https://oss.sonatype.org/service/local/repositories/releases/content/org/openidentityplatform/openig/openig-doc/5.3.0/openig-doc-5.3.0-jar-with-dependencies.jar[minimal HTTP server .jar, window=\_top] to use as the application to protect:
+* Download and run the link:https://oss.sonatype.org/service/local/repositories/releases/content/org/openidentityplatform/openig/openig-doc/{openig-version}/openig-doc-{openig-version}-jar-with-dependencies.jar[minimal HTTP server .jar, window=\_top] to use as the application to protect:
 +
-The openig-doc-5.3.0-jar-with-dependencies.jar application listens at `\http://app.example.com:8081`. The minimal HTTP server is run with the `java -jar openig-doc-5.3.0-jar-with-dependencies.jar` command, as described in xref:chap-quickstart.adoc#chap-quickstart[Getting Started].
+The openig-doc-{openig-version}-jar-with-dependencies.jar application listens at `\http://app.example.com:8081`. The minimal HTTP server is run with the `java -jar openig-doc-{openig-version}-jar-with-dependencies.jar` command, as described in xref:chap-quickstart.adoc#chap-quickstart[Getting Started].
 
 * OpenIG is deployed in Jetty as described in xref:chap-quickstart.adoc#chap-quickstart[Getting Started]. OpenIG listens at `\http://openig.example.com:8080`.
 
@@ -147,7 +148,7 @@ When you configure password capture and replay, an OpenAM policy agent shares ca
 To generate a DES shared key, you can use a `DesKeyGenHandler` as described in xref:../reference/handlers-conf.adoc#DesKeyGenHandler[DesKeyGenHandler(5)] in the __Configuration Reference__. Add the route for the handler while you generate the key. For example, add the following route configuration file as `$HOME/.openig/config/routes/04-keygen.json`:
 +
 
-[source, javascript]
+[source, json]
 ----
 {
   "handler": {
@@ -258,7 +259,7 @@ Do not log in, however. You have not yet configured a route to handle requests t
 To add the route, add the following route configuration file as `$HOME/.openig/config/routes/04-replay.json`:
 +
 
-[source, javascript]
+[source, json]
 ----
 {
   "handler": {
@@ -321,7 +322,7 @@ On Windows, the file name should be `%appdata%\OpenIG\config\routes\04-replay.js
 The resulting `headerDecryption` object should look something like this, but using the key value that you generated:
 +
 
-[source, javascript]
+[source, json]
 ----
 {
     "algorithm": "DES/ECB/NoPadding",

openig-doc/src/main/asciidoc/gateway-guide/chap-quickstart.adoc

@@ -12,12 +12,13 @@
   information: "Portions copyright [year] [name of copyright owner]".
 
   Copyright 2017 ForgeRock AS.
-  Portions Copyright 2024 3A Systems LLC.
+  Portions Copyright 2024-2025 3A Systems LLC.
 ////
 
 :figure-caption!:
 :example-caption!:
 :table-caption!:
+:openig-version: 5.3.1
 
 
 [#chap-quickstart]
@@ -65,9 +66,9 @@ OpenIG runs in the following web application containers:
 Copy the OpenIG .war file as `root.war` to the `/path/to/jetty/webapps/`:
 +
 
-[source, console]
+[source, console, subs="attributes"]
 ----
-$ cp OpenIG-5.3.0.war /path/to/jetty/webapps/root.war
+$ cp OpenIG-{openig-version}.war /path/to/jetty/webapps/root.war
 ----
 +
 Jetty automatically deploys OpenIG in the root context on startup.
@@ -114,12 +115,12 @@ Now that OpenIG is installed, set up a sample application to protect.
 ====
 Follow these steps:
 
-. Download and run the link:https://oss.sonatype.org/service/local/repositories/releases/content/org/openidentityplatform/openig/openig-doc/5.3.0/openig-doc-5.3.0-jar-with-dependencies.jar[minimal HTTP server .jar, window=\_top] to use as the application to protect:
+. Download and run the link:https://oss.sonatype.org/service/local/repositories/releases/content/org/openidentityplatform/openig/openig-doc/{openig-version}/openig-doc-{openig-version}-jar-with-dependencies.jar[minimal HTTP server .jar, window=\_top] to use as the application to protect:
 +
 
-[source, console]
+[source, console, subs="attributes"]
 ----
-$ java -jar openig-doc-5.3.0-jar-with-dependencies.jar
+$ java -jar openig-doc-{openig-version}-jar-with-dependencies.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.
@@ -138,9 +139,9 @@ 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:
 +
 
-[source, console]
+[source, console, subs="attributes"]
 ----
-$ java -jar openig-doc-5.3.0-jar-with-dependencies.jar 8888 8889
+$ java -jar openig-doc-{openig-version}-jar-with-dependencies.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.
@@ -178,7 +179,7 @@ Follow these steps to configure OpenIG to proxy traffic to the sample applicatio
 Add the following base configuration file as `$HOME/.openig/config/config.json`. By default, OpenIG looks for `config.json` in the `$HOME/.openig/config` directory:
 +
 
-[source, javascript]
+[source, json]
 ----
 {
   "handler": {
@@ -225,7 +226,7 @@ If you adapt this base configuration for production use, make sure to adjust the
 . Add the following default route configuration file as `$HOME/.openig/config/routes/99-default.json`. By default, the Router defined in the base configuration file looks for routes in the `$HOME/.openig/config/routes` directory:
 +
 
-[source, javascript]
+[source, json]
 ----
 {
   "handler": "ClientHandler"
@@ -317,7 +318,7 @@ Now change the OpenIG configuration to log you in automatically with hard-coded
 Add the following route configuration file as `$HOME/.openig/config/routes/01-static.json`:
 +
 
-[source, javascript]
+[source, json]
 ----
 {
   "handler": {

openig-doc/src/main/asciidoc/gateway-guide/chap-start-here.adoc

@@ -12,7 +12,7 @@
   information: "Portions copyright [year] [name of copyright owner]".
 
   Copyright 2017 ForgeRock AS.
-  Portions Copyright 2024 3A Systems LLC.
+  Portions Copyright 2024-2025 3A Systems LLC.
 ////
 
 :figure-caption!:
@@ -88,7 +88,7 @@ When installation is complete, add at least one configuration file. Each configu
 
 The following very simple configuration routes requests to be handled according to separate route configurations:
 
-[source, javascript]
+[source, json]
 ----
 {
     "handler": {
@@ -102,7 +102,7 @@ To change the definition of an object defined by default or when you need to dec
 
 The following example declares a reusable router object and references it by its name, as follows:
 
-[source, javascript]
+[source, json]
 ----
 {
     "handler": "My Router",
@@ -131,7 +131,7 @@ When all the configuration settings for the type are optional, the config field
 
 The configuration can specify additional objects as well. For example, you can configure a __ClientHandler__ object that OpenIG uses to connect to servers. The following ClientHandler configuration uses defaults for all settings, except __hostnameVerifier__, which it configures to verify host names in SSL certificates:
 
-[source, javascript]
+[source, json]
 ----
 {
     "name": "ClientHandler",
@@ -143,7 +143,7 @@ The configuration can specify additional objects as well. For example, you can c
 ----
 __Decorators__ are additional heap objects that let you extend what another object can do. For example, a __CaptureDecorator__ extends the capability of filters and handlers to log requests and responses. A __TimerDecorator__ logs processing times. Decorate configuration objects with decorator names as field names. By default OpenIG defines both a CaptureDecorator named `capture` and also a TimerDecorator named `timer`. Log requests, responses, and processing times by adding decorations as shown in the following example:
 
-[source, javascript]
+[source, json]
 ----
 {
     "handler": {
@@ -171,7 +171,7 @@ A router does not explicitly specify any routes. Instead the router specifies a
 
 The following example specifies a condition that is true when the request path is `/login`:
 
-[source, javascript]
+[source, json]
 ----
 "condition": "${matches(request.uri.path, '^/login')}"
 ----
@@ -211,7 +211,7 @@ The route configuration in xref:#example-chain[Chain to a Protected Application]
 .Chain to a Protected Application
 ====
 
-[source, javascript]
+[source, json]
 ----
 {
     "handler": {
@@ -317,7 +317,7 @@ Use the following conventions when commenting to ensure your configuration files
 
 [#figure-comment-field]
 
-[source, javascript]
+[source, json]
 ----
 {
     "name": "capture",
@@ -335,7 +335,7 @@ Use the following conventions when commenting to ensure your configuration files
 
 [#figure-comment-underscore]
 
-[source, javascript]
+[source, json]
 ----
 {
     "name": "capture",