gristlabs_grist-core/docker-compose-examples/grist-traefik-basic-auth/README.md
Spoffy dfb816888e
Adds docker compose examples (#1113)
This adds three example docker-compose files:

- A basic Grist instance backed by sqlite, with no additional services.
- A Grist instance that uses Postgres, Redis and MinIO.
- A Grist instance that uses OIDC authentication and traefik.

These are intended to be customised by self-hosters for their own needs.

All examples should work without any additional configuration.
2024-08-12 20:54:43 +01:00

25 lines
956 B
Markdown

This is the simplest example of Grist with authentication and HTTPS encryption.
It uses Traefik as:
- A reverse proxy to manage certificates and provide HTTPS support
- A basic authentication provided using Traefik's Basic Auth middleware.
This setup, after configuring HTTPS certificates correctly, should be acceptable on the public internet.
However, it doesn't allow a user to sign-out due to the way browsers handle basic authentication.
You may want to try a more secure authentication setup such Authelia, Authentik or traefik-forward-auth.
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.