Skip to content

Commit

Permalink
Update dev documentation websites
Browse files Browse the repository at this point in the history
  • Loading branch information
otoroshi-github-actions committed Feb 7, 2024
1 parent 0f484b4 commit ade643b
Show file tree
Hide file tree
Showing 160 changed files with 155 additions and 2,923 deletions.
2 changes: 1 addition & 1 deletion docs/devmanual/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/architecture.html
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ <h1><a href="#architecture" name="architecture" class="anchor"><span class="anch

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/code/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info" : {
"title" : "Otoroshi Admin API",
"description" : "Admin API of the Otoroshi reverse proxy",
"version" : "16.13.0-dev",
"version" : "16.14.0-dev",
"contact" : {
"name" : "Otoroshi Team",
"email" : "[email protected]"
Expand Down
20 changes: 10 additions & 10 deletions docs/devmanual/content-pretty.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/devmanual/content.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/devmanual/deploy/aws.html
Original file line number Diff line number Diff line change
Expand Up @@ -531,7 +531,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/deploy/clever-cloud.html
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/deploy/clustering.html
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/deploy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
22 changes: 11 additions & 11 deletions docs/devmanual/deploy/kubernetes.html
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,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.13.0-dev
- github.com/MAIF/otoroshi/kubernetes/kustomize/overlays/simple/?ref=v16.14.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>
Expand Down Expand Up @@ -365,7 +365,7 @@ <h2><a href="#installing-otoroshi-on-your-kubernetes-cluster" name="installing-o
terminationGracePeriodSeconds: 60
hostNetwork: false
containers:
- image: maif/otoroshi:16.13.0-dev
- image: maif/otoroshi:16.14.0-dev
imagePullPolicy: IfNotPresent
name: otoroshi
args: [&#39;-Dconfig.file=/usr/app/otoroshi/conf/oto.conf&#39;]
Expand Down Expand Up @@ -1349,7 +1349,7 @@ <h3><a href="#deploy-a-simple-otoroshi-instanciation-on-a-cloud-provider-managed
terminationGracePeriodSeconds: 60
hostNetwork: false
containers:
- image: maif/otoroshi:16.13.0-dev-jdk11
- image: maif/otoroshi:16.14.0-dev-jdk11
imagePullPolicy: IfNotPresent
name: otoroshi
ports:
Expand Down Expand Up @@ -1590,7 +1590,7 @@ <h3><a href="#deploy-a-simple-otoroshi-instanciation-on-a-bare-metal-kubernetes-
terminationGracePeriodSeconds: 60
hostNetwork: false
containers:
- image: maif/otoroshi:16.13.0-dev-jdk11
- image: maif/otoroshi:16.14.0-dev-jdk11
imagePullPolicy: IfNotPresent
name: otoroshi
ports:
Expand Down Expand Up @@ -1905,7 +1905,7 @@ <h3><a href="#deploy-a-simple-otoroshi-instanciation-on-a-bare-metal-kubernetes-
restartPolicy: Always
hostNetwork: false
containers:
- image: maif/otoroshi:16.13.0-dev-jdk11
- image: maif/otoroshi:16.14.0-dev-jdk11
imagePullPolicy: IfNotPresent
name: otoroshi
ports:
Expand Down Expand Up @@ -2200,7 +2200,7 @@ <h3><a href="#deploy-an-otoroshi-cluster-on-a-cloud-provider-managed-kubernetes-
hostNetwork: false
restartPolicy: Always
containers:
- image: maif/otoroshi:16.13.0-dev-jdk11
- image: maif/otoroshi:16.14.0-dev-jdk11
imagePullPolicy: IfNotPresent
name: otoroshi-leader
ports:
Expand Down Expand Up @@ -2589,7 +2589,7 @@ <h3><a href="#deploy-an-otoroshi-cluster-on-a-bare-metal-kubernetes-cluster" nam
hostNetwork: false
restartPolicy: Always
containers:
- image: maif/otoroshi:16.13.0-dev-jdk11
- image: maif/otoroshi:16.14.0-dev-jdk11
imagePullPolicy: IfNotPresent
name: otoroshi-leader
ports:
Expand Down Expand Up @@ -2766,7 +2766,7 @@ <h3><a href="#deploy-an-otoroshi-cluster-on-a-bare-metal-kubernetes-cluster" nam
hostNetwork: false
restartPolicy: Always
containers:
- image: maif/otoroshi:16.12.0-dev-dev
- image: maif/otoroshi:16.13.0-dev-dev
imagePullPolicy: IfNotPresent
name: otoroshi-worker
ports:
Expand Down Expand Up @@ -3031,7 +3031,7 @@ <h3><a href="#deploy-an-otoroshi-cluster-on-a-bare-metal-kubernetes-cluster-usin
hostNetwork: false
restartPolicy: Always
containers:
- image: maif/otoroshi:16.13.0-dev-jdk11
- image: maif/otoroshi:16.14.0-dev-jdk11
imagePullPolicy: IfNotPresent
name: otoroshi-leader
ports:
Expand Down Expand Up @@ -3222,7 +3222,7 @@ <h3><a href="#deploy-an-otoroshi-cluster-on-a-bare-metal-kubernetes-cluster-usin
hostNetwork: false
restartPolicy: Always
containers:
- image: maif/otoroshi:16.12.0-dev-dev
- image: maif/otoroshi:16.13.0-dev-dev
imagePullPolicy: IfNotPresent
name: otoroshi-worker
ports:
Expand Down Expand Up @@ -5186,7 +5186,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/deploy/scaling.html
Original file line number Diff line number Diff line change
Expand Up @@ -607,7 +607,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
6 changes: 3 additions & 3 deletions docs/devmanual/dev.html
Original file line number Diff line number Diff line change
Expand Up @@ -306,8 +306,8 @@ <h2><a href="#the-tools" name="the-tools" class="anchor"><span class="anchor-lin
<ul>
<li>git</li>
<li>JDK &gt;= 11</li>
<li>SBT &gt;= 1.3.x</li>
<li>Node 13 + yarn 1.x</li>
<li>SBT &gt;= 1.7+</li>
<li>Node 18+ &amp; yarn 1.x</li>
</ul>
<h2><a href="#clone-the-repository" name="clone-the-repository" class="anchor"><span class="anchor-link"></span></a>Clone the repository</h2>
<pre class="prettyprint"><code class="language-sh">git clone https://github.com/MAIF/otoroshi.git
Expand Down Expand Up @@ -423,7 +423,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/apikeys.html
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/auth-modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -571,7 +571,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/backends.html
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/certificates.html
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/data-exporters.html
Original file line number Diff line number Diff line change
Expand Up @@ -601,7 +601,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/global-config.html
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ <h1><a href="#main-entities" name="main-entities" class="anchor"><span class="an

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/jwt-verifiers.html
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/organizations.html
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/routes.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/scripts.html
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/service-descriptors.html
Original file line number Diff line number Diff line change
Expand Up @@ -654,7 +654,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/service-groups.html
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/tcp-services.html
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/entities/teams.html
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/features.html
Original file line number Diff line number Diff line change
Expand Up @@ -536,7 +536,7 @@ <h1><a href="#features" name="features" class="anchor"><span class="anchor-link"

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
4 changes: 2 additions & 2 deletions docs/devmanual/getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,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.13.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.14.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
Expand Down Expand Up @@ -533,7 +533,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/how-to-s/communicate-with-kafka.html
Original file line number Diff line number Diff line change
Expand Up @@ -781,7 +781,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/how-to-s/create-custom-auth-module.html
Original file line number Diff line number Diff line change
Expand Up @@ -548,7 +548,7 @@ <h1><a href="#create-your-authentication-module" name="create-your-authenticatio

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/how-to-s/custom-initial-state.html
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
2 changes: 1 addition & 1 deletion docs/devmanual/how-to-s/custom-log-levels.html
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@ <h3>On this page</h3>

<!--
<div class="copyright">
<span class="text">&copy; 2023</span>
<span class="text">&copy; 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
Expand Down
Loading

0 comments on commit ade643b

Please sign in to comment.