Update dev documentation websites

MAIF · Oct 2, 2024 · 2ddffae · 2ddffae
1 parent 685bf28
commit 2ddffae
Show file tree

Hide file tree

Showing 154 changed files with 1,231 additions and 3,100 deletions.
diff --git a/docs/devmanual/code/openapi.json b/docs/devmanual/code/openapi.json
@@ -3,7 +3,7 @@
   "info" : {
     "title" : "Otoroshi Admin API",
     "description" : "Admin API of the Otoroshi reverse proxy",
-    "version" : "16.19.0-dev",
+    "version" : "16.20.0-dev",
     "contact" : {
       "name" : "Otoroshi Team",
       "email" : "[email protected]"

diff --git a/docs/devmanual/content-pretty.json b/docs/devmanual/content-pretty.json
diff --git a/docs/devmanual/content.json b/docs/devmanual/content.json
diff --git a/docs/devmanual/deploy/kubernetes.html b/docs/devmanual/deploy/kubernetes.html
@@ -316,7 +316,7 @@ <h2><a href="#installing-otoroshi-on-your-kubernetes-cluster" name="installing-o
 <p>If you want to deploy otoroshi into your kubernetes cluster, you can download the deployment descriptors from <a href="https://github.com/MAIF/otoroshi/tree/master/kubernetes">https://github.com/MAIF/otoroshi/tree/master/kubernetes</a> and use kustomize to create your own overlay.</p>
 <p>You can also create a <code>kustomization.yaml</code> file with a remote base</p>
 <pre class="prettyprint"><code class="language-yaml">bases:
-- github.com/MAIF/otoroshi/kubernetes/kustomize/overlays/simple/?ref=v16.19.0-dev
+- github.com/MAIF/otoroshi/kubernetes/kustomize/overlays/simple/?ref=v16.20.0-dev
 </code></pre>
 <p>Then deploy it with <code>kubectl apply -k ./overlays/myoverlay</code>. </p>
 <p>You can also use Helm to deploy a simple otoroshi cluster on your kubernetes cluster</p>
@@ -369,7 +369,7 @@ <h2><a href="#installing-otoroshi-on-your-kubernetes-cluster" name="installing-o
       terminationGracePeriodSeconds: 60
       hostNetwork: false
       containers:
-      - image: maif/otoroshi:16.19.0-dev
+      - image: maif/otoroshi:16.20.0-dev
         imagePullPolicy: IfNotPresent
         name: otoroshi
         args: [&#39;-Dconfig.file=/usr/app/otoroshi/conf/oto.conf&#39;]
@@ -1418,7 +1418,7 @@ <h3><a href="#deploy-a-simple-otoroshi-instanciation-on-a-cloud-provider-managed
       terminationGracePeriodSeconds: 60
       hostNetwork: false
       containers:
-      - image: maif/otoroshi:16.19.0-dev-jdk11
+      - image: maif/otoroshi:16.20.0-dev-jdk11
         imagePullPolicy: IfNotPresent
         name: otoroshi
         ports:
@@ -1659,7 +1659,7 @@ <h3><a href="#deploy-a-simple-otoroshi-instanciation-on-a-bare-metal-kubernetes-
       terminationGracePeriodSeconds: 60
       hostNetwork: false
       containers:
-      - image: maif/otoroshi:16.19.0-dev-jdk11
+      - image: maif/otoroshi:16.20.0-dev-jdk11
         imagePullPolicy: IfNotPresent
         name: otoroshi
         ports:
@@ -1974,7 +1974,7 @@ <h3><a href="#deploy-a-simple-otoroshi-instanciation-on-a-bare-metal-kubernetes-
       restartPolicy: Always
       hostNetwork: false
       containers:
-      - image: maif/otoroshi:16.19.0-dev-jdk11
+      - image: maif/otoroshi:16.20.0-dev-jdk11
         imagePullPolicy: IfNotPresent
         name: otoroshi
         ports:
@@ -2269,7 +2269,7 @@ <h3><a href="#deploy-an-otoroshi-cluster-on-a-cloud-provider-managed-kubernetes-
       hostNetwork: false
       restartPolicy: Always
       containers:
-      - image: maif/otoroshi:16.19.0-dev-jdk11
+      - image: maif/otoroshi:16.20.0-dev-jdk11
         imagePullPolicy: IfNotPresent
         name: otoroshi-leader
         ports:
@@ -2658,7 +2658,7 @@ <h3><a href="#deploy-an-otoroshi-cluster-on-a-bare-metal-kubernetes-cluster" nam
       hostNetwork: false
       restartPolicy: Always
       containers:
-      - image: maif/otoroshi:16.19.0-dev-jdk11
+      - image: maif/otoroshi:16.20.0-dev-jdk11
         imagePullPolicy: IfNotPresent
         name: otoroshi-leader
         ports:
@@ -2835,7 +2835,7 @@ <h3><a href="#deploy-an-otoroshi-cluster-on-a-bare-metal-kubernetes-cluster" nam
       hostNetwork: false
       restartPolicy: Always   
       containers:
-      - image: maif/otoroshi:16.18.6-dev-dev
+      - image: maif/otoroshi:16.19.0-dev-dev
         imagePullPolicy: IfNotPresent
         name: otoroshi-worker
         ports:
@@ -3100,7 +3100,7 @@ <h3><a href="#deploy-an-otoroshi-cluster-on-a-bare-metal-kubernetes-cluster-usin
       hostNetwork: false
       restartPolicy: Always
       containers:
-      - image: maif/otoroshi:16.19.0-dev-jdk11
+      - image: maif/otoroshi:16.20.0-dev-jdk11
         imagePullPolicy: IfNotPresent
         name: otoroshi-leader
         ports:
@@ -3291,7 +3291,7 @@ <h3><a href="#deploy-an-otoroshi-cluster-on-a-bare-metal-kubernetes-cluster-usin
       hostNetwork: false
       restartPolicy: Always   
       containers:
-      - image: maif/otoroshi:16.18.6-dev-dev
+      - image: maif/otoroshi:16.19.0-dev-dev
         imagePullPolicy: IfNotPresent
         name: otoroshi-worker
         ports:

diff --git a/docs/devmanual/getting-started.html b/docs/devmanual/getting-started.html
@@ -309,7 +309,7 @@ <h1><a href="#getting-started" name="getting-started" class="anchor"><span class
   <li><a href="#secure-your-web-app-in-2-calls-with-an-authentication">Secure your web app in 2 calls with an authentication</a></li>
 </ul>
 <p>Download the latest jar of Otoroshi</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>Once downloading, run Otoroshi.</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/export-events-to-elastic.html b/docs/devmanual/how-to-s/export-events-to-elastic.html
@@ -311,7 +311,7 @@ <h3><a href="#before-you-start" name="before-you-start" class="anchor"><span cla
 <button id="instructions-toggle-button">close</button>
 </div>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/import-export-otoroshi-datastore.html b/docs/devmanual/how-to-s/import-export-otoroshi-datastore.html
@@ -307,7 +307,7 @@
 <h1><a href="#import-and-export-otoroshi-datastore" name="import-and-export-otoroshi-datastore" class="anchor"><span class="anchor-link"></span></a>Import and export Otoroshi datastore</h1>
 <h3><a href="#start-otoroshi-with-an-initial-datastore" name="start-otoroshi-with-an-initial-datastore" class="anchor"><span class="anchor-link"></span></a>Start Otoroshi with an initial datastore</h3>
 <p>Let&rsquo;s start by downloading the latest Otoroshi</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>By default, Otoroshi starts with domain <code>oto.tools</code> that targets <code>127.0.0.1</code> Now you are almost ready to run Otoroshi for the first time, we want run it with an initial data.</p>
 <p>To do that, you need to add the <strong>otoroshi.importFrom</strong> setting to the Otoroshi configuration (of <code>$APP_IMPORT_FROM</code> env). It can be a file path or a URL. The content of the initial datastore can look something like the following.</p>

diff --git a/docs/devmanual/how-to-s/instantiate-waf-coraza.html b/docs/devmanual/how-to-s/instantiate-waf-coraza.html
@@ -318,7 +318,7 @@ <h3><a href="#before-you-start" name="before-you-start" class="anchor"><span cla
 <button id="instructions-toggle-button">close</button>
 </div>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/secure-an-app-with-jwt-verifiers.html b/docs/devmanual/how-to-s/secure-an-app-with-jwt-verifiers.html
@@ -317,7 +317,7 @@ <h3><a href="#before-you-start" name="before-you-start" class="anchor"><span cla
 <button id="instructions-toggle-button">close</button>
 </div>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/secure-app-with-auth0.html b/docs/devmanual/how-to-s/secure-app-with-auth0.html
@@ -315,7 +315,7 @@ <h3><a href="#download-otoroshi" name="download-otoroshi" class="anchor"><span c
 <button id="instructions-toggle-button">close</button>
 </div>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/secure-app-with-keycloak.html b/docs/devmanual/how-to-s/secure-app-with-keycloak.html
@@ -311,7 +311,7 @@ <h3><a href="#before-you-start" name="before-you-start" class="anchor"><span cla
 <button id="instructions-toggle-button">close</button>
 </div>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/secure-app-with-ldap.html b/docs/devmanual/how-to-s/secure-app-with-ldap.html
@@ -311,7 +311,7 @@ <h1><a href="#secure-an-app-and-or-your-otoroshi-ui-with-ldap" name="secure-an-a
 </div>
 <h3><a href="#before-you-start" name="before-you-start" class="anchor"><span class="anchor-link"></span></a>Before you start</h3><p>If you already have an up and running otoroshi instance, you can skip the following instructions</p>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/secure-the-communication-between-a-backend-app-and-otoroshi.html b/docs/devmanual/how-to-s/secure-the-communication-between-a-backend-app-and-otoroshi.html
@@ -314,7 +314,7 @@ <h1><a href="#secure-the-communication-between-a-backend-app-and-otoroshi" name=
 <button id="instructions-toggle-button">close</button>
 </div>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/secure-with-apikey.html b/docs/devmanual/how-to-s/secure-with-apikey.html
@@ -311,7 +311,7 @@ <h1><a href="#secure-an-api-with-api-keys" name="secure-an-api-with-api-keys" cl
 </div>
 <h3><a href="#before-you-start" name="before-you-start" class="anchor"><span class="anchor-link"></span></a>Before you start</h3><p>If you already have an up and running otoroshi instance, you can skip the following instructions</p>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/secure-with-oauth1-client.html b/docs/devmanual/how-to-s/secure-with-oauth1-client.html
@@ -315,7 +315,7 @@ <h3><a href="#before-you-start" name="before-you-start" class="anchor"><span cla
 <button id="instructions-toggle-button">close</button>
 </div>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/setup-otoroshi-cluster.html b/docs/devmanual/how-to-s/setup-otoroshi-cluster.html
@@ -317,7 +317,7 @@ <h3><a href="#summary" name="summary" class="anchor"><span class="anchor-link"><
   <li>Validate the installation by adding a header on the requests</li>
 </ol>
 <p>Let&rsquo;s start by downloading the latest jar of Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>Then create an instance of Otoroshi and indicates with the <code>otoroshi.cluster.mode</code> environment variable that it will be the leader.</p>
 <pre class="prettyprint"><code class="language-sh">java -Dhttp.port=8091 -Dhttps.port=9091 -Dotoroshi.cluster.mode=leader -jar otoroshi.jar

diff --git a/docs/devmanual/how-to-s/tls-termination-using-own-certificates.html b/docs/devmanual/how-to-s/tls-termination-using-own-certificates.html
@@ -311,7 +311,7 @@ <h1><a href="#tls-termination-using-your-own-certificates" name="tls-termination
 <button id="instructions-toggle-button">close</button>
 </div>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/wasm-usage.html b/docs/devmanual/how-to-s/wasm-usage.html
@@ -328,7 +328,7 @@ <h2><a href="#before-your-start" name="before-your-start" class="anchor"><span c
 <button id="instructions-toggle-button">close</button>
 </div>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/wasmo-installation.html b/docs/devmanual/how-to-s/wasmo-installation.html
@@ -327,7 +327,7 @@ <h3><a href="#before-your-start" name="before-your-start" class="anchor"><span c
 <button id="instructions-toggle-button">close</button>
 </div>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/working-with-eureka.html b/docs/devmanual/how-to-s/working-with-eureka.html
@@ -337,7 +337,7 @@ <h3><a href="#download-otoroshi" name="download-otoroshi" class="anchor"><span c
 <button id="instructions-toggle-button">close</button>
 </div>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar 

diff --git a/docs/devmanual/how-to-s/zip-backend-plugin.html b/docs/devmanual/how-to-s/zip-backend-plugin.html
@@ -321,7 +321,7 @@ <h2><a href="#before-your-start" name="before-your-start" class="anchor"><span c
 <button id="instructions-toggle-button">close</button>
 </div>
 <p>Let&rsquo;s start by downloading the latest Otoroshi.</p>
-<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.19.0-dev/otoroshi.jar&#39;
+<pre class="prettyprint"><code class="language-sh">curl -L -o otoroshi.jar &#39;https://github.com/MAIF/otoroshi/releases/download/v16.20.0-dev/otoroshi.jar&#39;
 </code></pre>
 <p>then you can run start Otoroshi :</p>
 <pre class="prettyprint"><code class="language-sh">java -Dotoroshi.adminPassword=password -jar otoroshi.jar