docs: add release version marker to URLs (#3355)

* docs: add release version marker to URLs

* fix: replace image tags by version

* fix: replace image tags by version

Co-authored-by: moabu <47318409+moabu@users.noreply.github.com>

docs/admin/auth-server/endpoints/ssa.md

@@ -37,6 +37,7 @@ Use [Janssen Text-based UI(TUI)](../../config-guide/tui.md) or [Janssen command-
 When using TUI, navigate via `Auth Server`->`Properties`->`enabledFeatureFlags` to screen below. From here, enable or
 disable `SSA` flag as required.
 
+
 ![](../../../assets/image-tui-enable-components.png)
 
 ## Configuration Properties
@@ -63,6 +64,7 @@ parameters as described below:
 - `ssaSigningAlg` — Algorithm to sign the JWT that is returned after creating an SSA.
 - `ssaExpirationInDays` — Expiration expressed in days, when an SSA is created and the expiration is not sent.
 
+
 ## SSA Security
 
 To call SSA services, a token of type `client_credentials` must be generated with the following scopes enabled:

docs/admin/config-guide/config-api/README.md

@@ -7,10 +7,10 @@ tags:
 # config-api
 
 ## Overview
-[Jans Config Api](https://github.com/JanssenProject/jans/tree/main/jans-config-api) provides a central place to manage and configure jans modules.
+[Jans Config Api](https://github.com/JanssenProject/jans/tree/replace-janssen-version/jans-config-api) provides a central place to manage and configure jans modules.
 It helps in configuring auth-server, users, fido2 and scim modules.
 
-Config API is a REST application that is developed using Weld 4.x (JSR-365) and JAX-RS. Its endpoints can be used to manage configuration and other properties of [Jans Auth Server](https://github.com/JanssenProject/jans/tree/main/jans-auth-server), which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS)
+Config API is a REST application that is developed using Weld 4.x (JSR-365) and JAX-RS. Its endpoints can be used to manage configuration and other properties of [Jans Auth Server](https://github.com/JanssenProject/jans/tree/replace-janssen-version/jans-auth-server), which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS)
 
 ![Config-API-Architecture](../../../assets/config-api-architecture.png)
 

docs/admin/config-guide/config-api/config.md

@@ -7,9 +7,9 @@ tags:
 # Config-api-configuration
 
 ## Overview
-[Jans Config Api](https://github.com/JanssenProject/jans/tree/main/jans-config-api) configuration enables to manage application-level configuration.
+[Jans Config Api](https://github.com/JanssenProject/jans/tree/replace-janssen-version/jans-config-api) configuration enables to manage application-level configuration.
 
-![](https://github.com/JanssenProject/jans/raw/main/docs/assets/config-api-configuration.png)
+![](https://github.com/JanssenProject/jans/raw/replace-janssen-version/docs/assets/config-api-configuration.png)
 
 ### Existing Config-api dynamic configuration
 
@@ -76,7 +76,7 @@ tags:
 ## Revision update
 
 `jansRevision` property of the configuration is used to manage any change
-![](https://github.com/JanssenProject/jans/raw/main/docs/assets/config-api-configuration-revision)
+![](https://github.com/JanssenProject/jans/raw/replace-janssen-version/docs/assets/config-api-configuration-revision)
 
 ### Two options to make effect of the changes done to the configuration
 

docs/admin/config-guide/config-api/plugins.md

@@ -5,7 +5,7 @@ tags:
 ---
 
 ## Overview
-[Jans Config Api](https://github.com/JanssenProject/jans/tree/main/jans-config-api) is a REST application that is developed using Weld 4.x (JSR-365) and JAX-RS. Its endpoint can be used to manage configuration and other properties of [Jans Auth Server](https://github.com/JanssenProject/jans/tree/main/jans-auth-server).
+[Jans Config Api](https://github.com/JanssenProject/jans/tree/replace-janssen-version/jans-config-api) is a REST application that is developed using Weld 4.x (JSR-365) and JAX-RS. Its endpoint can be used to manage configuration and other properties of [Jans Auth Server](https://github.com/JanssenProject/jans/tree/replace-janssen-version/jans-auth-server).
 
 ## Jans Config API Plugins
 Jans Config API follow a flexible plugin architecture in which the new features can be added using extensions called plugins without altering the application itself. In this section, we will discuss the steps to develop and add plugins in Jans Config API.

docs/admin/developer/scripts/person-authentication-faq.md

@@ -14,7 +14,7 @@ tags:
 
 
 ### 1. Display error messages on a web page?
-1.[FacesMessages](https://github.com/JanssenProject/jans/blob/main/jans-core/jsf-util/src/main/java/io/jans/jsf2/message/FacesMessages.java) bean is used for this purpose.
+1.[FacesMessages](https://github.com/JanssenProject/jans/blob/replace-janssen-version/jans-core/jsf-util/src/main/java/io/jans/jsf2/message/FacesMessages.java) bean is used for this purpose.
 	```
 	from org.jans.jsf2.message import FacesMessages
 	from org.jans.service.cdi.util import CdiUtil
@@ -32,7 +32,7 @@ tags:
 	<h:messages />
 	...
 	```
-	See an example [here](https://github.com/JanssenProject/jans/blob/685a1593fb53e2310cfa38fcd49db94f3453042f/jans-auth-server/server/src/main/webapp/WEB-INF/incl/layout/template.xhtml#L41)
+	See an example [here](https://github.com/JanssenProject/jans/blob/replace-janssen-version/jans-auth-server/server/src/main/webapp/WEB-INF/incl/layout/template.xhtml#L41)
 
 ### 2. Redirection to a third party application for authentication
 

docs/admin/developer/scripts/ropc.md

@@ -12,7 +12,7 @@ Resource Owner Password Credentials script allows modifying the behavior of Reso
 The script is invoked after normal authentication and can either leave current result or change it - authenticate if not authenticated - it should return True and optionally set user (via `context.setUser(user)`).
 
 ## Interface
-The ROPC script implements the [ResourceOwnerPasswordCredentialsType](https://github.com/JanssenProject/jans/blob/main/jans-core/script/src/main/java/io/jans/model/custom/script/type/owner/ResourceOwnerPasswordCredentialsType.java) interface. This extends methods from the base script type in addition to adding new method:
+The ROPC script implements the [ResourceOwnerPasswordCredentialsType](https://github.com/JanssenProject/jans/blob/replace-janssen-version/jans-core/script/src/main/java/io/jans/model/custom/script/type/owner/ResourceOwnerPasswordCredentialsType.java) interface. This extends methods from the base script type in addition to adding new method:
 
 ### Inherited Methods
 | Method header | Method description |
@@ -29,10 +29,10 @@ The ROPC script implements the [ResourceOwnerPasswordCredentialsType](https://gi
 ### Objects
 | Object name | Object description |
 |:-----|:------|
-|`customScript`| The custom script object. [Reference](https://github.com/JanssenProject/jans/blob/main/jans-core/script/src/main/java/io/jans/model/custom/script/model/CustomScript.java) |
+|`customScript`| The custom script object. [Reference](https://github.com/JanssenProject/jans/blob/replace-janssen-version/jans-core/script/src/main/java/io/jans/model/custom/script/model/CustomScript.java) |
 |`configurationAttributes`| `configurationProperties` passed in when adding custom script. `Map<String, SimpleCustomProperty> configurationAttributes` |
-|`SimpleCustomProperty`| Map of configuration properties. [Reference](https://github.com/JanssenProject/jans/blob/main/jans-core/util/src/main/java/io/jans/model/SimpleCustomProperty.java) |
-| `context` | [Reference](https://github.com/JanssenProject/jans/blob/main/jans-auth-server/server/src/main/java/io/jans/as/server/service/external/context/ExternalResourceOwnerPasswordCredentialsContext.java) |
+|`SimpleCustomProperty`| Map of configuration properties. [Reference](https://github.com/JanssenProject/jans/blob/replace-janssen-version/jans-core/util/src/main/java/io/jans/model/SimpleCustomProperty.java) |
+| `context` | [Reference](https://github.com/JanssenProject/jans/blob/replace-janssen-version/jans-auth-server/server/src/main/java/io/jans/as/server/service/external/context/ExternalResourceOwnerPasswordCredentialsContext.java) |
 
 ## Use case: Basic ROPC authentication script
 

docs/admin/install/docker-install/compose.md

@@ -49,7 +49,7 @@ Download the compose file
 
 ```bash
 
-wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/jans-mysql-compose.yml 
+wget https://raw.githubusercontent.com/JanssenProject/jans/replace-janssen-version/docker-jans-monolith/jans-mysql-compose.yml 
 ```
 
 This docker compose file runs two containers, the janssen monolith container and mysql container.

docs/admin/install/docker-install/quick-start.md

@@ -25,7 +25,7 @@ These environment variables can be set to customize installation as per the need
 Run this command to start the installation:
 
 ```bash
-wget https://raw.githubusercontent.com/JanssenProject/jans/main/automation/startjanssenmonolithdemo.sh && chmod u+x startjanssenmonolithdemo.sh && sudo bash startjanssenmonolithdemo.sh demoexample.jans.io MYSQL
+wget https://raw.githubusercontent.com/JanssenProject/jans/replace-janssen-version/automation/startjanssenmonolithdemo.sh && chmod u+x startjanssenmonolithdemo.sh && sudo bash startjanssenmonolithdemo.sh demoexample.jans.io MYSQL
 ```
 
 Console messages like below confirms the successful installation:

docs/admin/install/helm-install/local.md

@@ -40,7 +40,7 @@ Start a fresh ubuntu `18.04` or `20.04` 4 CPU, 16 GB RAM, and 50GB SSD VM with p
 sudo su -
 ```
 ```bash
-wget https://raw.githubusercontent.com/JanssenProject/jans/main/automation/startjanssendemo.sh && chmod u+x startjanssendemo.sh && ./startjanssendemo.sh
+wget https://raw.githubusercontent.com/JanssenProject/jans/replace-janssen-version/automation/startjanssendemo.sh && chmod u+x startjanssendemo.sh && ./startjanssendemo.sh
 ```
 
 This will install docker, microk8s, helm and Janssen with the default settings that can be found inside [values.yaml](https://github.com/GluuFederation/flex/blob/flex/pygluu/kubernetes/templates/helm/gluu/values.yaml).  

docs/admin/install/vm-install/dynamic-download.md

@@ -26,7 +26,7 @@ System should meet [minimum VM system requirements](vm-requirements.md)
 
 1. Download the installer
 ```
-curl https://raw.githubusercontent.com/JanssenProject/jans/main/jans-linux-setup/jans_setup/install.py > install.py
+curl https://raw.githubusercontent.com/JanssenProject/jans/replace-janssen-version/jans-linux-setup/jans_setup/install.py > install.py
 ```
 
 1. Execute Installer

docs/admin/install/vm-install/rhel.md

@@ -24,21 +24,21 @@ You can disbale SELinux temporarly by executing `setenforce 0`. To disable perma
   [Releases](https://github.com/JanssenProject/jans/releases)
 
 ```
-wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans-1.0.4-el8.x86_64.rpm -P ~/
+wget https://github.com/JanssenProject/jans/releases/download/replace-janssen-version/jans-replace-janssen-image-version-el8.x86_64.rpm -P ~/
 ```
 
 - Verify integrity of the downloaded package using published `sha256sum`.
 
     Download `sha256sum` file for the package
 
     ```shell
-    wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans-1.0.4-el8.x86_64.rpm.sha256sum -P ~/
+    wget https://github.com/JanssenProject/jans/releases/download/replace-janssen-version/jans-replace-janssen-image-version-el8.x86_64.rpm.sha256sum -P ~/
     ```
 
     Check the hash if it is matching.
 
     ```shell
-    sha256sum -c jans-1.0.4-el8.x86_64.rpm.sha256sum
+    sha256sum -c jans-replace-janssen-image-version-el8.x86_64.rpm.sha256sum
     ```
 
     Output similar to below should confirm the integrity of the downloaded package.
@@ -50,7 +50,7 @@ wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans-1.0.4-
 - Install the package
 
 ```
-yum install ~/jans-1.0.4-el8.x86_64.rpm
+yum install ~/jans-replace-janssen-image-version-el8.x86_64.rpm
 ```
 
 ## Run the setup script

docs/admin/install/vm-install/suse.md

@@ -19,25 +19,25 @@ Before you install, check the [VM system requirements](vm-requirements.md).
 
 ## Install the Package
 
-- Download the release package from the Github Janssen Project
+- Download the release package from the GitHub Janssen Project
   [Releases](https://github.com/JanssenProject/jans/releases)
 
 ```
-wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans-1.0.4-suse15.x86_64.rpm -P ~/
+wget https://github.com/JanssenProject/jans/releases/download/replace-janssen-version/jans-replace-janssen-image-version-suse15.x86_64.rpm -P ~/
 ```
 
 - Verify integrity of the downloaded package using published `sha256sum`.
 
     Download `sha256sum` file for the package
 
     ```shell
-    wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans-1.0.4-suse15.x86_64.rpm.sha256sum -P ~/
+    wget https://github.com/JanssenProject/jans/releases/download/replace-janssen-version/jans-replace-janssen-image-version-suse15.x86_64.rpm.sha256sum -P ~/
     ```
 
     Check the hash if it is matching.
 
     ```shell
-    sha256sum -c jans-1.0.4-suse15.x86_64.rpm.sha256sum
+    sha256sum -c jans-replace-janssen-image-version-suse15.x86_64.rpm.sha256sum
     ```
 
     Output similar to below should confirm the integrity of the downloaded package.
@@ -49,7 +49,7 @@ wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans-1.0.4-
 - Install the package
 
 ```
-zypper install ~/jans-1.0.4-suse15.x86_64.rpm
+zypper install ~/jans-replace-janssen-image-version-suse15.x86_64.rpm
 ```
 
 ## Run the setup script

docs/admin/install/vm-install/ubuntu.md

@@ -19,21 +19,21 @@ Before you install, check the [VM system requirements](vm-requirements.md).
 [Releases](https://github.com/JanssenProject/jans/releases)
 
 ```
-wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans_1.0.4.ubuntu20.04_amd64.deb -P /tmp
+wget https://github.com/JanssenProject/jans/releases/download/replace-janssen-version/jans_replace-janssen-image-version.ubuntu20.04_amd64.deb -P /tmp
 ```
 
 - Verify integrity of the downloaded package by verifying published `sha256sum`.   
 
     Download `sha256sum` file for the package
 
     ```shell
-    wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans_1.0.4.ubuntu20.04_amd64.deb.sha256sum -P /tmp
+    wget https://github.com/JanssenProject/jans/releases/download/replace-janssen-version/jans_replace-janssen-image-version.ubuntu20.04_amd64.deb.sha256sum -P /tmp
     ```
 
     Check the hash if it is matching. 
 
     ```shell
-    sha256sum -c /tmp/jans_1.0.4.ubuntu20.04_amd64.deb.sha256sum
+    sha256sum -c /tmp/jans_replace-janssen-image-version.ubuntu20.04_amd64.deb.sha256sum
     ```
 
     Output similar to below should confirm the integrity of the downloaded package.
@@ -45,7 +45,7 @@ wget https://github.com/JanssenProject/jans/releases/download/v1.0.4/jans_1.0.4.
 - Install the package
 
 ```
-apt install -y /tmp/jans_1.0.4.ubuntu20.04_amd64.deb
+apt install -y /tmp/jans_replace-janssen-image-version.ubuntu20.04_amd64.deb
 ```
 
 ## Run the setup script
@@ -136,7 +136,7 @@ The following packages will be REMOVED:
 After this operation, 1,257 MB disk space will be freed.
 Do you want to continue? [Y/n] y
 (Reading database ... 166839 files and directories currently installed.)
-Removing jans (1.0.2~ubuntu20.04) ...
+Removing jans (replace-janssen-image-version~ubuntu20.04) ...
 Checking to make sure service is down...
 
 ```

docs/admin/kubernetes-ops/backup-restore.md

@@ -38,7 +38,7 @@ kubectl get secret cn -n <namespace> -o yaml > secret-backup.yaml
 helm list -n <namespace>
 ```
 
-Keep note of the chart version. For example: `1.0.5`
+Keep note of the chart version. For example: `replace-janssen-image-version`
 
 ### Manual Restore
 

docs/admin/kubernetes-ops/cert-management.md

@@ -40,7 +40,7 @@ Rotating Certificates and Keys in Kubernetes setup
           restartPolicy: Never
           containers:
             - name: web-key-rotation
-              image: janssenproject/certmanager:1.0.5-1
+              image: janssenproject/certmanager:replace-janssen-image-version-1
               envFrom:
               - configMapRef:
                   name: janssen-config-cm # This may be differnet in Helm
@@ -92,7 +92,7 @@ Rotating Certificates and Keys in Kubernetes setup
                   path: web_https.key                              
           containers:
             - name: load-web-key-rotation
-              image: janssenproject/certmanager:1.0.5-1
+              image: janssenproject/certmanager:replace-janssen-image-version-1
               envFrom:
               - configMapRef:
                   name: janssen-config-cm  #This may be differnet in Helm
@@ -141,7 +141,7 @@ kubectl apply -f load-web-key-rotation.yaml -n <jans-namespace>
             spec:
               containers:
                 - name: auth-key-rotation
-                  image: janssenproject/certmanager:1.0.5-1
+                  image: janssenproject/certmanager:replace-janssen-image-version-1
                   resources:
                     requests:
                       memory: "300Mi"
@@ -191,7 +191,7 @@ kubectl apply -f load-web-key-rotation.yaml -n <jans-namespace>
           restartPolicy: Never
           containers:
             - name: ldap-key-rotation
-              image: janssenproject/certmanager:1.0.5-1
+              image: janssenproject/certmanager:replace-janssen-image-version-1
               envFrom:
               - configMapRef:
                   name: janssen-config-cm

docs/admin/recipes/benchmark.md

@@ -85,7 +85,7 @@ A Kubernetes cluster can be created with three nodes or more in one region and t
 
 3. Make sure [helm](https://helm.sh/docs/intro/install/) is installed.
 
-4. Prepare your [override.yaml](../install/helm-install/README.md). Copy the below into a file named override.yaml. At the time of writing this we are using image tags `1.0.6_dev` which are the bleeding edge images for release `1.0.6`. Stable images such as `1.0.6-1` should be used.
+4. Prepare your [override.yaml](../install/helm-install/README.md). Copy the below into a file named override.yaml. At the time of writing this we are using image tags `replace-janssen-image-version_dev` which are the bleeding edge images for release `replace-janssen-image-version`. Stable images such as `replace-janssen-image-version-1` should be used.
 
    ```yaml
    config:
@@ -178,7 +178,7 @@ Loading users requires a hefty but temporary amount of resources. By default, th
     ```bash
     mkdir add_users && cd add_users
     ```
-2. Copy the following [yaml](https://github.com/JanssenProject/jans/blob/main/demos/benchmarking/docker-jans-loadtesting-jmeter/yaml/load-users/load_users_rdbms_job.yaml) into the folder under the name `load_users.yaml`.
+2. Copy the following [yaml](https://github.com/JanssenProject/jans/blob/replace-janssen-version/demos/benchmarking/docker-jans-loadtesting-jmeter/yaml/load-users/load_users_rdbms_job.yaml) into the folder under the name `load_users.yaml`.
 
 3. Open the file and modify the sql connection parameters. To speed the loading process increase the CPU requests and limits.
 
@@ -257,7 +257,7 @@ Create the client needed to run the test by executing the following. Make sure t
     }
     EOF
     ```
-3. Copy the following [yaml](https://github.com/JanssenProject/jans/blob/main/demos/benchmarking/docker-jans-loadtesting-jmeter/yaml/load-test/load_test_auth_code.yaml) into the folder.
+3. Copy the following [yaml](https://github.com/JanssenProject/jans/blob/replace-janssen-version/demos/benchmarking/docker-jans-loadtesting-jmeter/yaml/load-test/load_test_auth_code.yaml) into the folder.
 
 4. Download or build [config-cli-tui](../config-guide/tui.md) and run:
 

docs/admin/reference/kubernetes/docker-jans-certmanager.md

@@ -235,7 +235,7 @@ spec:
         spec:
           containers:
             - name: auth-key-rotation
-              image: janssenproject/certmanager:1.0.4-1
+              image: janssenproject/certmanager:replace-janssen-image-version-1
               resources:
                 requests:
                   memory: "300Mi"

docs/admin/reference/kubernetes/docker-jans-monolith.md

@@ -49,7 +49,7 @@ Download the compose file
 
 ```bash
 
-wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/jans-mysql-compose.yml 
+wget https://raw.githubusercontent.com/JanssenProject/jans/replace-janssen-version/docker-jans-monolith/jans-mysql-compose.yml 
 ```
 
 This docker compose file runs two containers, the janssen monolith container and mysql container.