From aaaa7d1d714684c2fc13c694f8ff4aaa0e415f93 Mon Sep 17 00:00:00 2001 From: Spoffy Date: Tue, 30 Jul 2024 02:48:48 +0100 Subject: [PATCH] Adds additional README instructions to compose examples --- docker-compose-examples/grist-local-testing/README.md | 4 ++++ .../grist-traefik-basic-auth/README.md | 10 ++++++++++ .../grist-with-postgres-redis-minio/README.md | 4 ++++ 3 files changed, 18 insertions(+) diff --git a/docker-compose-examples/grist-local-testing/README.md b/docker-compose-examples/grist-local-testing/README.md index 61ea8342..cd610cfd 100644 --- a/docker-compose-examples/grist-local-testing/README.md +++ b/docker-compose-examples/grist-local-testing/README.md @@ -6,3 +6,7 @@ This setup lacks basic security or authentication. Other examples demonstrate how to set up authentication and HTTPS. See https://support.getgrist.com/self-managed for more information. + +## How to run this example + +This example can be run with `docker compose up`. \ No newline at end of file diff --git a/docker-compose-examples/grist-traefik-basic-auth/README.md b/docker-compose-examples/grist-traefik-basic-auth/README.md index f280f843..170361c4 100644 --- a/docker-compose-examples/grist-traefik-basic-auth/README.md +++ b/docker-compose-examples/grist-traefik-basic-auth/README.md @@ -12,3 +12,13 @@ You may want to try a more secure authentication setup such Authelia, Authentik The OIDC auth example demonstrates a setup using Authelia. See https://support.getgrist.com/self-managed for more information. + +## How to run this example + +This example can be run with `docker compose up`. + +The default login is: +- Username: `test@example.org` +- Password: `test` + +This can be changed in `./configs/traefik-dynamic-config.yaml`. Instructions on how to do this are available in that file. diff --git a/docker-compose-examples/grist-with-postgres-redis-minio/README.md b/docker-compose-examples/grist-with-postgres-redis-minio/README.md index a920a9f7..d53c7b7a 100644 --- a/docker-compose-examples/grist-with-postgres-redis-minio/README.md +++ b/docker-compose-examples/grist-with-postgres-redis-minio/README.md @@ -11,3 +11,7 @@ Other examples demonstrate how to set up authentication and HTTPS. See https://support.getgrist.com/self-managed for more information. This setup is based on one provided by Akito (https://github.com/theAkito). + +## How to run this example + +This example can be run with `docker compose up`.