Merge pull request #274 from sebadob/update-readme

Update readme

README.md

@@ -90,6 +90,7 @@ Keycloak was a rough inspiration in certain places and if something is working w
 - [x] Supports DPoP tokens for decentralized login flows
 - [x] Supports ephemeral, dynamic clients for decentralized login flows
 - [x] Can serve a basic `webid` document for decentralized logins
+- [x] OpenID Connect Dynamic Client Registration
 - [x] Admin UI
 - [x] Account UI for each user with self-service
 - [x] Simple per client branding for the login page

docs/404.html

@@ -92,9 +92,7 @@
             <div class="sidebar-scrollbox">
                 <ol class="chapter"><li class="chapter-item expanded "><a href="intro.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="getting_started/main.html"><strong aria-hidden="true">2.</strong> Getting Started</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="getting_started/docker.html"><strong aria-hidden="true">2.1.</strong> Docker</a></li><li class="chapter-item expanded "><a href="getting_started/k8s.html"><strong aria-hidden="true">2.2.</strong> Kubernetes</a></li><li class="chapter-item expanded "><a href="getting_started/first_start.html"><strong aria-hidden="true">2.3.</strong> First Start</a></li></ol></li><li class="chapter-item expanded "><a href="config/argon2.html"><strong aria-hidden="true">3.</strong> Argon 2</a></li><li class="chapter-item expanded "><a href="config/fido.html"><strong aria-hidden="true">4.</strong> FIDO 2 Passkeys</a></li><li class="chapter-item expanded "><a href="config/encryption.html"><strong aria-hidden="true">5.</strong> Encryption</a></li><li class="chapter-item expanded "><a href="config/db_migration.html"><strong aria-hidden="true">6.</strong> Database Migrations</a></li><li class="chapter-item expanded "><a href="config/backup.html"><strong aria-hidden="true">7.</strong> Backups</a></li><li class="chapter-item expanded "><a href="config/ha.html"><strong aria-hidden="true">8.</strong> High Availability</a></li><li class="chapter-item expanded "><a href="config/tls.html"><strong aria-hidden="true">9.</strong> TLS</a></li><li class="chapter-item expanded "><a href="config/config.html"><strong aria-hidden="true">10.</strong> Reference Config</a></li></ol>
             </div>
-            <div id="sidebar-resize-handle" class="sidebar-resize-handle">
-                <div class="sidebar-resize-indicator"></div>
-            </div>
+            <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
         </nav>
 
         <!-- Track and set sidebar scroll position -->

docs/config/argon2.html

@@ -91,9 +91,7 @@
             <div class="sidebar-scrollbox">
                 <ol class="chapter"><li class="chapter-item expanded "><a href="../intro.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="../getting_started/main.html"><strong aria-hidden="true">2.</strong> Getting Started</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../getting_started/docker.html"><strong aria-hidden="true">2.1.</strong> Docker</a></li><li class="chapter-item expanded "><a href="../getting_started/k8s.html"><strong aria-hidden="true">2.2.</strong> Kubernetes</a></li><li class="chapter-item expanded "><a href="../getting_started/first_start.html"><strong aria-hidden="true">2.3.</strong> First Start</a></li></ol></li><li class="chapter-item expanded "><a href="../config/argon2.html" class="active"><strong aria-hidden="true">3.</strong> Argon 2</a></li><li class="chapter-item expanded "><a href="../config/fido.html"><strong aria-hidden="true">4.</strong> FIDO 2 Passkeys</a></li><li class="chapter-item expanded "><a href="../config/encryption.html"><strong aria-hidden="true">5.</strong> Encryption</a></li><li class="chapter-item expanded "><a href="../config/db_migration.html"><strong aria-hidden="true">6.</strong> Database Migrations</a></li><li class="chapter-item expanded "><a href="../config/backup.html"><strong aria-hidden="true">7.</strong> Backups</a></li><li class="chapter-item expanded "><a href="../config/ha.html"><strong aria-hidden="true">8.</strong> High Availability</a></li><li class="chapter-item expanded "><a href="../config/tls.html"><strong aria-hidden="true">9.</strong> TLS</a></li><li class="chapter-item expanded "><a href="../config/config.html"><strong aria-hidden="true">10.</strong> Reference Config</a></li></ol>
             </div>
-            <div id="sidebar-resize-handle" class="sidebar-resize-handle">
-                <div class="sidebar-resize-indicator"></div>
-            </div>
+            <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
         </nav>
 
         <!-- Track and set sidebar scroll position -->
@@ -181,7 +179,7 @@ <h1 id="argon-2-setup"><a class="header" href="#argon-2-setup">Argon 2 Setup</a>
 beging done by the application and the variables need to be tuned for every deployment to provide the best compromise
 of security, resource usage and user experience.<br />
 The default values are way too low for a real production deployment. They should only be used for testing.</p>
-<p>The Admin UI provides a utility which helps you find the values for your deployment quickly. What and how to do is
+<p>The Admin UI provides a utility which helps you find the values for your deployment quickly. What and how to do is 
 described in the Admin UI itself, I just want to guide you to this utility especially, since it is an important step
 security wise.</p>
 <p>When you are logged in to the Admin UI, please navigate to <code>Config</code> -&gt; <code>Argon2 Parameters</code> to find your values.<br />
@@ -190,11 +188,11 @@ <h1 id="argon-2-setup"><a class="header" href="#argon-2-setup">Argon 2 Setup</a>
 resource limits set too low, that it will crash, if either <code>ARGON2_M_COST</code> is set too high or the memory limit too low.</p>
 <p>There is one additional, really important config variable need to be taken into account for the tuning.<br />
 Since this operation is really ressource intense, you can limit the amount of threads, which can run in parallel doing
-hashing operations. This is really important when we think about constrained memory again.</p>
+hashing operations. This is really important when we think about constrained memory again. </p>
 <p><code>MAX_HASH_THREADS</code> limits the maximum amount of parallel password hashes at the exact same time to never exceed system
 memory while still allowing a good amount of memory.<br />
 The <strong>default</strong> value <strong>is 2</strong>.</p>
-<p>The rule is simple: Allow as many resources as possible for hashing to have the maximum amount of security, while
+<p>The rule is simple: Allow as many resources as possible for hashing to have the maximum amount of security, while 
 restricting it as much as necessary.</p>
 <p>For smaller deployments, set <code>MAX_HASH_THREADS=1</code>, which will technically allows only one user login at the exact same
 time. This value makes an external rate limiting for the login obsolete (while you may add some for the others).</p>

docs/config/backup.html

@@ -91,9 +91,7 @@
             <div class="sidebar-scrollbox">
                 <ol class="chapter"><li class="chapter-item expanded "><a href="../intro.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="../getting_started/main.html"><strong aria-hidden="true">2.</strong> Getting Started</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../getting_started/docker.html"><strong aria-hidden="true">2.1.</strong> Docker</a></li><li class="chapter-item expanded "><a href="../getting_started/k8s.html"><strong aria-hidden="true">2.2.</strong> Kubernetes</a></li><li class="chapter-item expanded "><a href="../getting_started/first_start.html"><strong aria-hidden="true">2.3.</strong> First Start</a></li></ol></li><li class="chapter-item expanded "><a href="../config/argon2.html"><strong aria-hidden="true">3.</strong> Argon 2</a></li><li class="chapter-item expanded "><a href="../config/fido.html"><strong aria-hidden="true">4.</strong> FIDO 2 Passkeys</a></li><li class="chapter-item expanded "><a href="../config/encryption.html"><strong aria-hidden="true">5.</strong> Encryption</a></li><li class="chapter-item expanded "><a href="../config/db_migration.html"><strong aria-hidden="true">6.</strong> Database Migrations</a></li><li class="chapter-item expanded "><a href="../config/backup.html" class="active"><strong aria-hidden="true">7.</strong> Backups</a></li><li class="chapter-item expanded "><a href="../config/ha.html"><strong aria-hidden="true">8.</strong> High Availability</a></li><li class="chapter-item expanded "><a href="../config/tls.html"><strong aria-hidden="true">9.</strong> TLS</a></li><li class="chapter-item expanded "><a href="../config/config.html"><strong aria-hidden="true">10.</strong> Reference Config</a></li></ol>
             </div>
-            <div id="sidebar-resize-handle" class="sidebar-resize-handle">
-                <div class="sidebar-resize-indicator"></div>
-            </div>
+            <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
         </nav>
 
         <!-- Track and set sidebar scroll position -->
@@ -177,13 +175,13 @@ <h1 class="menu-title">Rauthy Documentation</h1>
                         <h1 id="backups"><a class="header" href="#backups">Backups</a></h1>
 <h2 id="sqlite"><a class="header" href="#sqlite">SQLite</a></h2>
 <p>If Rauthy is using a SQLite, it does automatic backups, which can be configured with:</p>
-<pre><code># Cron job for automatic data store backups (default: "0 0 4 * * * *")
+<pre><code># Cron job for automatic data store backups (default: &quot;0 0 4 * * * *&quot;)
 # sec min hour day_of_month month day_of_week year
-BACKUP_TASK="0 0 4 * * * *"
+BACKUP_TASK=&quot;0 0 4 * * * *&quot;
 
 # The name for the data store backups. The current timestamp will always be appended automatically.
 # default: rauthy-backup-
-BACKUP_NAME="rauthy-backup-"
+BACKUP_NAME=&quot;rauthy-backup-&quot;
 
 # All backups older than the specified hours will be cleaned up automatically (default: 720)
 BACKUP_RETENTION_LOCAL=24
@@ -193,9 +191,16 @@ <h2 id="sqlite"><a class="header" href="#sqlite">SQLite</a></h2>
 <p>This difference makes it possible, that you could add a second volume mount to the container.<br />
 You then have the database itself on a different disk than the backups, which is the most simple and straight forward
 approach to have a basic backup strategy.</p>
-<pre><code class="language-admonish info">The SQLite backups are done with `VACUUM`, which means you can just use the backups as a normal database again.
-This makes it possible, to just use the [Database Migration](./db_migration.md) feature to apply backups very easily.
-</code></pre>
+<div id="admonition-info" class="admonition info">
+<div class="admonition-title">
+<p>Info</p>
+<p><a class="admonition-anchor-link" href="#admonition-info"></a></p>
+</div>
+<div>
+<p>The SQLite backups are done with <code>VACUUM</code>, which means you can just use the backups as a normal database again.
+This makes it possible, to just use the <a href="./db_migration.html">Database Migration</a> feature to apply backups very easily.</p>
+</div>
+</div>
 <h2 id="postgres"><a class="header" href="#postgres">Postgres</a></h2>
 <p>If you are using Postgres as the main database, Rauthy does not do any backups.<br />
 There are a lot of way better tools out there to handle this task.</p>