From 9ecf7400cea712f161b68a089021756a8d76f911 Mon Sep 17 00:00:00 2001 From: Spoffy Date: Tue, 30 Jul 2024 00:41:42 +0100 Subject: [PATCH] Adds additional instructions on running the OIDC example --- .../grist-traefik-oidc-auth/README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docker-compose-examples/grist-traefik-oidc-auth/README.md b/docker-compose-examples/grist-traefik-oidc-auth/README.md index f30987ea..a1ea9431 100644 --- a/docker-compose-examples/grist-traefik-oidc-auth/README.md +++ b/docker-compose-examples/grist-traefik-oidc-auth/README.md @@ -10,6 +10,15 @@ This example could be hosted on a dedicated server, with the following changes: - DNS setup - HTTPS / Certificate setup (e.g Let's encrypt) -Users are defined in ./configs/authelia/user-database.yml - See https://support.getgrist.com/install/oidc for more information on using Grist with OIDC. + +## How to run this example + +To run this example, you'll first need to generate several secrets needed by Authelia. + +This is automated for you in `generateSecureSecrets.sh`, which uses Authelia's docker image to populate the `./secrets` directory. + +This example can then be run with `docker compose up`. This will make Grist available on `https://grist.localhost` with a self-signed certificate (by default), after all the services have started. Note: it may take up to a minute for all of the services to start correctly. + +You can add or modify users in ./configs/authelia/user-database.yml. Additional instructions are provided in that file. +