Skip to content

Commit

Permalink
adjusted docs to the v0.14 lite image
Browse files Browse the repository at this point in the history
  • Loading branch information
sd committed Aug 12, 2023
1 parent 8304197 commit 430dcd4
Show file tree
Hide file tree
Showing 9 changed files with 38 additions and 14 deletions.
6 changes: 3 additions & 3 deletions docs/getting_started/docker.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h2 id="testing--local-evaluation"><a class="header" href="#testing--local-evalu
<pre><code>docker run --rm \
-p 8080:8080 \
--name rauthy \
sdobedev/rauthy
sdobedev/rauthy:0.14.0-lite
</code></pre>
<p>This will start the container in interactive mode with an in-memory SQLite database. Just take a look at the log at the
logs to see the URL and first password.</p>
Expand All @@ -161,7 +161,7 @@ <h2 id="testing--local-evaluation"><a class="header" href="#testing--local-evalu
-e DATABASE_URL=sqlite:data/rauthy.db \
-p 8080:8080 \
--name rauthy \
sdobedev/rauthy
sdobedev/rauthy:0.14.0-lite
</code></pre>
<div id="admonition-note" class="admonition note">
<div class="admonition-title">
Expand Down Expand Up @@ -246,7 +246,7 @@ <h2 id="production-setup"><a class="header" href="#production-setup">Production
-v $(pwd)/rauthy/data:/app/data \
-p 8080:8080 \
--name rauthy \
sdobedev/rauthy
sdobedev/rauthy:0.14.0-lite
</code></pre>
<p><strong>6. Restrict DB files access even more</strong><br />
After rauthy has done the first start, you could harden the access rights of the SQLite files even more.<br />
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/k8s.html
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ <h3 id="create-and-apply-the-stateful-set"><a class="header" href="#create-and-a
# hash for the latest version at this
# point. The latest image with the correct hash will always be shown for the
# [Github Releases](https://github.com/sebadob/rauthy/releases)
image: sdobedev/rauthy:0.13.1
image: sdobedev/rauthy:0.14.0-lite
imagePullPolicy: IfNotPresent
securityContext:
# User ID 10001 is actually built into the container at the creation for
Expand Down
10 changes: 10 additions & 0 deletions docs/getting_started/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,16 @@ <h1 id="getting-started"><a class="header" href="#getting-started">Getting Start
<li>The <code>DB_MIGRATE_FROM</code> (explained later) can be used with any combination of image / database</li>
</ul>
<p>At the time of writing, you can run Rauthy either with <a href="./docker.html">Docker</a> or inside <a href="./k8s.html">Kubernetes</a>.</p>
<div id="admonition-caution" class="admonition warning">
<div class="admonition-title">
<p>Caution</p>
<p><a class="admonition-anchor-link" href="#admonition-caution"></a></p>
</div>
<div>
<p>All the examples in this documentation are using the <code>*-lite</code> images and therefore SQLite. If you want to use Postgres
in production, you need to use the &quot;default&quot; container images.</p>
</div>
</div>

</main>

Expand Down
18 changes: 14 additions & 4 deletions docs/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -252,14 +252,24 @@ <h2 id="what-it-is-not-yet"><a class="header" href="#what-it-is-not-yet">What it
<li>The <code>DB_MIGRATE_FROM</code> (explained later) can be used with any combination of image / database</li>
</ul>
<p>At the time of writing, you can run Rauthy either with <a href="getting_started/./docker.html">Docker</a> or inside <a href="getting_started/./k8s.html">Kubernetes</a>.</p>
<div id="admonition-caution" class="admonition warning">
<div class="admonition-title">
<p>Caution</p>
<p><a class="admonition-anchor-link" href="getting_started/main.html#admonition-caution"></a></p>
</div>
<div>
<p>All the examples in this documentation are using the <code>*-lite</code> images and therefore SQLite. If you want to use Postgres
in production, you need to use the &quot;default&quot; container images.</p>
</div>
</div>
<div style="break-before: page; page-break-before: always;"></div><h1 id="docker"><a class="header" href="#docker">Docker</a></h1>
<h2 id="testing--local-evaluation"><a class="header" href="#testing--local-evaluation">Testing / Local Evaluation</a></h2>
<p>For getting a first look at rauthy, you can start it with docker (or any other container runtime) on your localhost.
The image contains a basic default config which is sufficient for local testing. </p>
<pre><code>docker run --rm \
-p 8080:8080 \
--name rauthy \
sdobedev/rauthy
sdobedev/rauthy:0.14.0-lite
</code></pre>
<p>This will start the container in interactive mode with an in-memory SQLite database. Just take a look at the log at the
logs to see the URL and first password.</p>
Expand All @@ -268,7 +278,7 @@ <h2 id="testing--local-evaluation"><a class="header" href="#testing--local-evalu
-e DATABASE_URL=sqlite:data/rauthy.db \
-p 8080:8080 \
--name rauthy \
sdobedev/rauthy
sdobedev/rauthy:0.14.0-lite
</code></pre>
<div id="admonition-note" class="admonition note">
<div class="admonition-title">
Expand Down Expand Up @@ -353,7 +363,7 @@ <h2 id="production-setup"><a class="header" href="#production-setup">Production
-v $(pwd)/rauthy/data:/app/data \
-p 8080:8080 \
--name rauthy \
sdobedev/rauthy
sdobedev/rauthy:0.14.0-lite
</code></pre>
<p><strong>6. Restrict DB files access even more</strong><br />
After rauthy has done the first start, you could harden the access rights of the SQLite files even more.<br />
Expand Down Expand Up @@ -525,7 +535,7 @@ <h3 id="create-and-apply-the-stateful-set"><a class="header" href="#create-and-a
# hash for the latest version at this
# point. The latest image with the correct hash will always be shown for the
# [Github Releases](https://github.com/sebadob/rauthy/releases)
image: sdobedev/rauthy:0.13.1
image: sdobedev/rauthy:0.14.0-lite
imagePullPolicy: IfNotPresent
securityContext:
# User ID 10001 is actually built into the container at the creation for
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/searchindex.json

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions rauthy-book/src/getting_started/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The image contains a basic default config which is sufficient for local testing.
docker run --rm \
-p 8080:8080 \
--name rauthy \
sdobedev/rauthy
sdobedev/rauthy:0.14.0-lite
```

This will start the container in interactive mode with an in-memory SQLite database. Just take a look at the log at the
Expand All @@ -22,7 +22,7 @@ docker run -d \
-e DATABASE_URL=sqlite:data/rauthy.db \
-p 8080:8080 \
--name rauthy \
sdobedev/rauthy
sdobedev/rauthy:0.14.0-lite
```

```admonish note
Expand Down Expand Up @@ -108,7 +108,7 @@ docker run -d \
-v $(pwd)/rauthy/data:/app/data \
-p 8080:8080 \
--name rauthy \
sdobedev/rauthy
sdobedev/rauthy:0.14.0-lite
```

**6. Restrict DB files access even more**
Expand Down
2 changes: 1 addition & 1 deletion rauthy-book/src/getting_started/k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ spec:
# hash for the latest version at this
# point. The latest image with the correct hash will always be shown for the
# [Github Releases](https://github.com/sebadob/rauthy/releases)
image: sdobedev/rauthy:0.13.1
image: sdobedev/rauthy:0.14.0-lite
imagePullPolicy: IfNotPresent
securityContext:
# User ID 10001 is actually built into the container at the creation for
Expand Down
4 changes: 4 additions & 0 deletions rauthy-book/src/getting_started/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,7 @@ too uncertain to me.

At the time of writing, you can run Rauthy either with [Docker](./docker.md) or inside [Kubernetes](./k8s.md).

```admonish caution
All the examples in this documentation are using the `*-lite` images and therefore SQLite. If you want to use Postgres
in production, you need to use the "default" container images.
```

0 comments on commit 430dcd4

Please sign in to comment.