document thing to watch out for with Kubernetes #122

docs/installation/index.md

@@ -9,7 +9,7 @@ docker run \
   -p 4000:4000 \
   -v YOUR_DATA_DIR:/var/lib/rustical/ \
   -v OPTIONAL_YOUR_CONFIG_TOML:/etc/rustical/config.toml \ # (1)!
-  -e RUSTICAL__CONFIG_OPTION="asd" \  # (2)!
+  -e RUSTICAL_CONFIG_OPTION="asd" \  # (2)!
   ghcr.io/lennart-k/rustical
 ```
 

docs/installation/notes.md

@@ -0,0 +1,11 @@
+# Notes
+
+## Kubernetes setup
+
+If you setup RustiCal with Kubernetes and call the deployment `rustical`
+Kubernetes will by default expose some environment variables starting with `RUSTICAL_`
+that will be rejected by RustiCal.
+So for now the solutions are either not calling the deployment `rustical` or setting
+`enableServiceLinks: false`, see <https://kubernetes.io/docs/tutorials/services/connect-applications-service/#accessing-the-service>.
+
+For the corresponding issue see <https://github.com/lennart-k/rustical/issues/122>

mkdocs.yml

@@ -68,6 +68,7 @@ nav:
   - Installation:
       - installation/index.md
       - Configuration: installation/configuration.md
+      - Notes: installation/notes.md
   - Client Setup: setup/client.md
   - OpenID Connect: setup/oidc.md
   - Developers: