Merge pull request #4 from sebadob/doc-split-container-images

document split container images from v0.14 on
sebadob · Jul 29, 2023 · adb3971 · adb3971
2 parents d559f82 + e622c9f
commit adb3971
Show file tree

Hide file tree

Showing 7 changed files with 72 additions and 30 deletions.
diff --git a/docs/config/db_migration.html b/docs/config/db_migration.html
@@ -171,25 +171,24 @@ <h1 id="database-migrations"><a class="header" href="#database-migrations">Datab
 the next restart of the application. Remove the config variable immediately after the migration has finished.</p>
 </div>
 </div>
-<div id="admonition-hint" class="admonition tip">
+<div id="admonition-info" class="admonition info">
 <div class="admonition-title">
-<p>Hint</p>
-<p><a class="admonition-anchor-link" href="#admonition-hint"></a></p>
+<p>Info</p>
+<p><a class="admonition-anchor-link" href="#admonition-info"></a></p>
 </div>
 <div>
-<p>The easiest to do is to just set <code>MIGRATE_DB_FROM</code> as an environmant variable, which is easier and quicker to remove 
-again afterwards.</p>
+<p><strong>v0.14 and beyond:</strong> if you want to migrate to a different database, for instance from SQLite to Postgres, you need to
+switch to the correct rauthy image as well. Rauthy v0.14 and beyond has different container images for the databases.</p>
 </div>
 </div>
-<div id="admonition-info" class="admonition info">
+<div id="admonition-hint" class="admonition tip">
 <div class="admonition-title">
-<p>Info</p>
-<p><a class="admonition-anchor-link" href="#admonition-info"></a></p>
+<p>Hint</p>
+<p><a class="admonition-anchor-link" href="#admonition-hint"></a></p>
 </div>
 <div>
-<p>In some cases and specific environments, this feature is currently a bit bugged. The problems are hard or almost
-impossible to reproduce. If you encounter a problem using this, please let me know as much details about it as
-possible.</p>
+<p>The easiest to do is to just set <code>MIGRATE_DB_FROM</code> as an environmant variable, which is easier and quicker to remove 
+again afterwards.</p>
 </div>
 </div>
 

diff --git a/docs/getting_started/main.html b/docs/getting_started/main.html
@@ -146,6 +146,23 @@ <h1 class="menu-title">Rauthy Documentation</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="getting-started"><a class="header" href="#getting-started">Getting Started</a></h1>
+<div id="admonition-hint" class="admonition tip">
+<div class="admonition-title">
+<p>Hint</p>
+<p><a class="admonition-anchor-link" href="#admonition-hint"></a></p>
+</div>
+<div>
+<p>Rauthy <code>v0.14</code> and beyond uses differnt container images for the different target databases.<br />
+Until and including <code>v0.13</code>, rauthy used the <code>Any</code> driver from <a href="https://crates.io/crates/sqlx">sqlx</a>. However, this
+driver has quite a few problems since sqlx 0.7, and I decided to migrate away from it, because the future of it seems
+too uncertain to me.</p>
+</div>
+</div>
+<ul>
+<li>The &quot;normal&quot; container images can be used for Postgres</li>
+<li>The <code>*-lite</code> images use an embedded SQLite</li>
+<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>
 
                     </main>

diff --git a/docs/print.html b/docs/print.html
@@ -252,6 +252,23 @@ <h2 id="what-it-will-never-be"><a class="header" href="#what-it-will-never-be">W
 <li>No fully customizable themes in addition to the existing branding.</li>
 </ul>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="getting-started"><a class="header" href="#getting-started">Getting Started</a></h1>
+<div id="admonition-hint" class="admonition tip">
+<div class="admonition-title">
+<p>Hint</p>
+<p><a class="admonition-anchor-link" href="getting_started/main.html#admonition-hint"></a></p>
+</div>
+<div>
+<p>Rauthy <code>v0.14</code> and beyond uses differnt container images for the different target databases.<br />
+Until and including <code>v0.13</code>, rauthy used the <code>Any</code> driver from <a href="https://crates.io/crates/sqlx">sqlx</a>. However, this
+driver has quite a few problems since sqlx 0.7, and I decided to migrate away from it, because the future of it seems
+too uncertain to me.</p>
+</div>
+</div>
+<ul>
+<li>The &quot;normal&quot; container images can be used for Postgres</li>
+<li>The <code>*-lite</code> images use an embedded SQLite</li>
+<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 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>
@@ -945,25 +962,24 @@ <h2 id="key-rotation"><a class="header" href="#key-rotation">Key Rotation</a></h
 the next restart of the application. Remove the config variable immediately after the migration has finished.</p>
 </div>
 </div>
-<div id="admonition-hint" class="admonition tip">
+<div id="admonition-info" class="admonition info">
 <div class="admonition-title">
-<p>Hint</p>
-<p><a class="admonition-anchor-link" href="config/db_migration.html#admonition-hint"></a></p>
+<p>Info</p>
+<p><a class="admonition-anchor-link" href="config/db_migration.html#admonition-info"></a></p>
 </div>
 <div>
-<p>The easiest to do is to just set <code>MIGRATE_DB_FROM</code> as an environmant variable, which is easier and quicker to remove 
-again afterwards.</p>
+<p><strong>v0.14 and beyond:</strong> if you want to migrate to a different database, for instance from SQLite to Postgres, you need to
+switch to the correct rauthy image as well. Rauthy v0.14 and beyond has different container images for the databases.</p>
 </div>
 </div>
-<div id="admonition-info" class="admonition info">
+<div id="admonition-hint" class="admonition tip">
 <div class="admonition-title">
-<p>Info</p>
-<p><a class="admonition-anchor-link" href="config/db_migration.html#admonition-info"></a></p>
+<p>Hint</p>
+<p><a class="admonition-anchor-link" href="config/db_migration.html#admonition-hint"></a></p>
 </div>
 <div>
-<p>In some cases and specific environments, this feature is currently a bit bugged. The problems are hard or almost
-impossible to reproduce. If you encounter a problem using this, please let me know as much details about it as
-possible.</p>
+<p>The easiest to do is to just set <code>MIGRATE_DB_FROM</code> as an environmant variable, which is easier and quicker to remove 
+again afterwards.</p>
 </div>
 </div>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="backups"><a class="header" href="#backups">Backups</a></h1>

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/searchindex.json b/docs/searchindex.json
diff --git a/rauthy-book/src/config/db_migration.md b/rauthy-book/src/config/db_migration.md
@@ -24,13 +24,12 @@ If you do not remove the `MIGRATE_DB_FROM` after the migration has been done, it
 the next restart of the application. Remove the config variable immediately after the migration has finished.
 ```
 
+```admonish info
+**v0.14 and beyond:** if you want to migrate to a different database, for instance from SQLite to Postgres, you need to
+switch to the correct rauthy image as well. Rauthy v0.14 and beyond has different container images for the databases.
+```
+
 ```admonish hint
 The easiest to do is to just set `MIGRATE_DB_FROM` as an environmant variable, which is easier and quicker to remove 
 again afterwards. 
 ```
-
-```admonish info
-In some cases and specific environments, this feature is currently a bit bugged. The problems are hard or almost
-impossible to reproduce. If you encounter a problem using this, please let me know as much details about it as
-possible.
-```
diff --git a/rauthy-book/src/getting_started/main.md b/rauthy-book/src/getting_started/main.md
@@ -1,4 +1,15 @@
 # Getting Started
 
+```admonish hint
+Rauthy `v0.14` and beyond uses differnt container images for the different target databases.  
+Until and including `v0.13`, rauthy used the `Any` driver from [sqlx](https://crates.io/crates/sqlx). However, this
+driver has quite a few problems since sqlx 0.7, and I decided to migrate away from it, because the future of it seems
+too uncertain to me.
+```
+
+- The "normal" container images can be used for Postgres
+- The `*-lite` images use an embedded SQLite
+- The `DB_MIGRATE_FROM` (explained later) can be used with any combination of image / database
+
 At the time of writing, you can run Rauthy either with [Docker](./docker.md) or inside [Kubernetes](./k8s.md).