Skip to content

Commit

Permalink
last fixes + docs version tag updates
Browse files Browse the repository at this point in the history
  • Loading branch information
sebadob committed Oct 30, 2023
1 parent 7923f92 commit ef6298d
Show file tree
Hide file tree
Showing 10 changed files with 70 additions and 86 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Either just take a look at the [Rauthy Book](https://sebadob.github.io/rauthy/),
the application yourself with docker on your localhost:

```
docker run --rm -p 8080:8080 ghcr.io/sebadob/rauthy:0.16.0-lite
docker run --rm -p 8080:8080 ghcr.io/sebadob/rauthy:0.17.0-lite
```

**NOTE:**
Expand Down
8 changes: 4 additions & 4 deletions docs/getting_started/docker.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@


<!-- Custom HTML head -->

<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff" />
Expand Down 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 \
ghcr.io/sebadob/rauthy:0.16.0-lite
ghcr.io/sebadob/rauthy:0.17.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 \
ghcr.io/sebadob/rauthy:0.16.0-lite
ghcr.io/sebadob/rauthy:0.17.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 \
ghcr.io/sebadob/rauthy:0.16.0-lite
ghcr.io/sebadob/rauthy:0.17.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
18 changes: 9 additions & 9 deletions docs/getting_started/k8s.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@


<!-- Custom HTML head -->

<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff" />
Expand Down Expand Up @@ -206,17 +206,17 @@ <h3 id="create-and-apply-secrets"><a class="header" href="#create-and-apply-secr
# The CACHE_AUTH_TOKEN is only needed for a deployment with HA_MODE == true
# Secret token, which is used to authenticate the cache members
#CACHE_AUTH_TOKEN:

# The database driver will be chosen at runtime depending on the given DATABASE_URL format. Examples:
# Sqlite: 'sqlite:data/rauthy.db' or 'sqlite::memory:'
# Postgres: 'postgresql://User:PasswordWithoutSpecialCharacters@localhost:5432/DatabaseName'
DATABASE_URL:
DATABASE_URL:

# Format: &quot;key_id/enc_key another_key_id/another_enc_key&quot; - the enc_key itself must be exactly 32 characters long and
# and should not contain special characters.
# The ID must match '[a-zA-Z0-9]{2,20}'
ENC_KEYS:

# Needed for sending E-Mails for password resets and so on
SMTP_PASSWORD:
</code></pre>
Expand Down Expand Up @@ -292,7 +292,7 @@ <h3 id="create-and-apply-the-stateful-set"><a class="header" href="#create-and-a
containers:
- name: rauthy
# This example uses the version tag.
# In production, I would highly recommend to actually use SHA
# In production, I would highly recommend to actually use SHA
# hashes to prevent someone from overwriting the image tag on your possibly
# own container registry with malicious content.
#
Expand All @@ -306,9 +306,9 @@ <h3 id="create-and-apply-the-stateful-set"><a class="header" href="#create-and-a
#
# Because of a chicken and egg problem, I cannot document the correct sha
# hash for the latest version at this
# point. The latest image with the correct hash will always be shown for the
# point. The latest image with the correct hash will always be shown for the
# [Github Releases](https://github.com/sebadob/rauthy/releases)
image: ghcr.io/sebadob/rauthy:0.16.0-lite
image: ghcr.io/sebadob/rauthy:0.17.0-lite
imagePullPolicy: IfNotPresent
securityContext:
# User ID 10001 is actually built into the container at the creation for
Expand Down Expand Up @@ -389,7 +389,7 @@ <h3 id="create-and-apply-the-stateful-set"><a class="header" href="#create-and-a
#memory:
# A CPU limit may make sense in case of DDoS attacks or something
# like this, if you do not have external rate limiting or other
# mechanisms. Otherwise, `MAX_HASH_THREADS` is the main mechanism
# mechanisms. Otherwise, `MAX_HASH_THREADS` is the main mechanism
# to limit resources.
cpu: 1000m
volumes:
Expand Down
Loading

0 comments on commit ef6298d

Please sign in to comment.