add ADDITIONAL_ALLOWED_ORIGIN_SCHEMES to the book (#578)

* add `ADDITIONAL_ALLOWED_ORIGIN_SCHEMES` to the book reference config

* rebuild docs

* change location of `just migrate` during initial setup to come after database start

book/src/config/config.md

@@ -1030,6 +1030,14 @@ PROXY_MODE=false
 #192.168.14.0/24
 #"
 
+# To bring support for applications using deep-linking, you can set custom URL 
+# schemes to be accepted when present in the `Origin` header. For instance, a
+# Tauri app would set `tauri://` instead of `https://`.
+#
+# Provide the value as a space separated list of Strings, like for instance:
+# "tauri myapp"
+#ADDITIONAL_ALLOWED_ORIGIN_SCHEMES="tauri myapp"
+
 # To enable or disable the additional HTTP server to expose the /metrics endpoint
 # default: true
 #METRICS_ENABLE=true

docs/config/config.html

@@ -588,6 +588,18 @@ <h1 id="reference-config"><a class="header" href="#reference-config">Reference C
 # !!! USE WITH CARE !!!
 #MIGRATE_DB_FROM=sqlite:data/rauthy.db
 
+# Defines the time in seconds after which the `/health` endpoint 
+# includes HA quorum checks. The initial delay solves problems 
+# like Kubernetes StatefulSet starts that include the health 
+# endpoint in the scheduling routine. In these cases, the scheduler 
+# will not start other Pods if the first does not become healthy.
+# 
+# This is a chicken-and-egg problem which the delay solves.
+# There is usually no need to adjust this value.
+#
+# default: 30
+#HEALTH_CHECK_DELAY_SECS=30
+
 # Disables the housekeeping schedulers (default: false)
 #SCHED_DISABLE=true
 
@@ -1198,6 +1210,14 @@ <h1 id="reference-config"><a class="header" href="#reference-config">Reference C
 #192.168.14.0/24
 #"
 
+# To bring support for applications using deep-linking, you can set custom URL 
+# schemes to be accepted when present in the `Origin` header. For instance, a
+# Tauri app would set `tauri://` instead of `https://`.
+#
+# Provide the value as a space separated list of Strings, like for instance:
+# "tauri myapp"
+#ADDITIONAL_ALLOWED_ORIGIN_SCHEMES="tauri myapp"
+
 # To enable or disable the additional HTTP server to expose the /metrics endpoint
 # default: true
 #METRICS_ENABLE=true

docs/print.html

@@ -3739,6 +3739,18 @@ <h2 id="rotation-event"><a class="header" href="#rotation-event">Rotation Event<
 # !!! USE WITH CARE !!!
 #MIGRATE_DB_FROM=sqlite:data/rauthy.db
 
+# Defines the time in seconds after which the `/health` endpoint 
+# includes HA quorum checks. The initial delay solves problems 
+# like Kubernetes StatefulSet starts that include the health 
+# endpoint in the scheduling routine. In these cases, the scheduler 
+# will not start other Pods if the first does not become healthy.
+# 
+# This is a chicken-and-egg problem which the delay solves.
+# There is usually no need to adjust this value.
+#
+# default: 30
+#HEALTH_CHECK_DELAY_SECS=30
+
 # Disables the housekeeping schedulers (default: false)
 #SCHED_DISABLE=true
 
@@ -4349,6 +4361,14 @@ <h2 id="rotation-event"><a class="header" href="#rotation-event">Rotation Event<
 #192.168.14.0/24
 #"
 
+# To bring support for applications using deep-linking, you can set custom URL 
+# schemes to be accepted when present in the `Origin` header. For instance, a
+# Tauri app would set `tauri://` instead of `https://`.
+#
+# Provide the value as a space separated list of Strings, like for instance:
+# "tauri myapp"
+#ADDITIONAL_ALLOWED_ORIGIN_SCHEMES="tauri myapp"
+
 # To enable or disable the additional HTTP server to expose the /metrics endpoint
 # default: true
 #METRICS_ENABLE=true

justfile

@@ -44,9 +44,6 @@ setup:
     cargo install mdbook-admonish
     cargo install sqlx-cli --no-default-features --features rustls,sqlite,postgres
 
-    echo "Creating SQLite database"
-    just migrate
-
     echo "npm install to set up the frontend"
     cd frontend/
     npm install
@@ -62,6 +59,7 @@ setup:
 
     echo "Starting Postgres and Mailcrab containers"
     just backend-start
+    just migrate
 
     {{db_url_sqlite}} cargo build
 

rauthy.cfg

@@ -966,12 +966,12 @@ PROXY_MODE=false
 #192.168.14.0/24
 #"
 
-# To bring support to applications that use deep-linking, you can set the
-# custom URL scheme to allow for the `Origin` header to be set to this value.
-# This is especially useful for Electron and Tauri apps, which may have a
-# custom URL scheme. The value is a space separated list of allowed schemes.
-# The following example shows the values for the "tauri://locahost" and
-# "myapp://localhost" origin URLs.
+# To bring support for applications using deep-linking, you can set custom URL
+# schemes to be accepted when present in the `Origin` header. For instance, a
+# Tauri app would set `tauri://` instead of `https://`.
+#
+# Provide the value as a space separated list of Strings, like for instance:
+# "tauri myapp"
 ADDITIONAL_ALLOWED_ORIGIN_SCHEMES="tauri myapp"
 
 # To enable or disable the additional HTTP server to expose the /metrics endpoint