From c4f613a8035f681c039b43483cf08fac270ae814 Mon Sep 17 00:00:00 2001
From: Lennart <18233294+lennart-k@users.noreply.github.com>
Date: Wed, 23 Jul 2025 11:05:05 +0200
Subject: [PATCH] Add example compose.yml

---
 compose.oidc.yml | 22 ++++++++++++++++++++++
 docs/index.md    |  2 ++
 2 files changed, 24 insertions(+)
 create mode 100644 compose.oidc.yml

diff --git a/compose.oidc.yml b/compose.oidc.yml
new file mode 100644
index 0000000..625ffd2
--- /dev/null
+++ b/compose.oidc.yml
@@ -0,0 +1,22 @@
+services:
+  rustical:
+    image: ghcr.io/lennart-k/rustical:latest
+    restart: unless-stopped
+    environment:
+      RUSTICAL_FRONTEND__ALLOW_PASSWORD_LOGIN: "false"
+      RUSTICAL_OIDC__NAME: "Authelia"
+      RUSTICAL_OIDC__ISSUER: "https://auth.example.com"
+      RUSTICAL_OIDC__CLIENT_ID: "{{ rustical_oidc_client_id }}"
+      RUSTICAL_OIDC__CLIENT_SECRET: "{{ rustical_oidc_client_secret }}"
+      RUSTICAL_OIDC__CLAIM_USERID: "preferred_username"
+      RUSTICAL_OIDC__SCOPES: '["openid", "profile", "groups"]'
+      RUSTICAL_OIDC__REQUIRE_GROUP: "app:rustical" # optional
+      RUSTICAL_OIDC__ALLOW_SIGN_UP: "true"
+    volumes:
+      - data:/var/lib/rustical
+    # Here you probably want to you expose instead
+    ports:
+      - 4000:4000
+
+volumes:
+  data:
diff --git a/docs/index.md b/docs/index.md
index 019126a..7b33be7 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -8,6 +8,8 @@ a CalDAV/CardDAV server
     you'd still be one of the first testers so expect bugs and rough edges.
     If you still want to play around with it in its current state, absolutely feel free to do so and to open up an issue if something is not working. :)
 
+[Installation](installation/index.md){ .md-button }
+
 ## Features
 
 - easy to backup, everything saved in one SQLite database