Moves documentation into README files, and improves links and

descriptions.
This commit is contained in:
Spoffy 2024-07-26 16:50:34 +01:00
parent 8f07d2906d
commit 9b0423ee94
6 changed files with 36 additions and 25 deletions

View File

@ -0,0 +1,8 @@
This is the simplest example that runs Grist, suitable for local testing.
It is STRONGLY RECOMMENDED not to use this container in a way that makes it accessible to the internet.
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.

View File

@ -1,9 +1,3 @@
# This is the simplest example that runs Grist, suitable for local testing.
# It is STRONGLY RECOMMENDED not to use this container in a way that makes it accessible to the internet.
# This setup lacks basic security or authentication.
# See https://support.getgrist.com for more information.
services:
grist:
image: gristlabs/grist:latest

View File

@ -0,0 +1,14 @@
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.

View File

@ -1,13 +1,4 @@
# This is the simplest example of Grist with authentication and https encryption.
# It uses Traefik as a reverse proxy and authentication service.
# Users are defined in traefik-dynamic-config.yml.
# This setup, after configuring HTTPS certificates correctly, should be acceptable on the public internet.
# However, you may want to try a more secure authentication setup such Authelia, Authentik or traefik-forward-auth.
# See https://support.getgrist.com for more information.
services:
grist:

View File

@ -0,0 +1,13 @@
This examples shows how to start up Grist that:
- Uses Postgres as a home database,
- Redis as a state store.
- MinIO for snapshot storage
It is STRONGLY RECOMMENDED not to use this container in a way that makes it accessible to the internet.
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.
This setup is based on one provided by Akito (https://github.com/theAkito).

View File

@ -1,13 +1,4 @@
# This examples shows how to start up Grist that:
# - Uses Postgres as a home database,
# - Redis as a state store.
# - MinIO for snapshot storage
# It is STRONGLY RECOMMENDED not to use this container in a way that makes it accessible to the internet.
# This setup lacks basic security or authentication.
# See https://support.getgrist.com for more information.
# This setup is based on one provided by Akito (https://github.com/theAkito).
services:
grist:
@ -28,7 +19,7 @@ services:
# Redis setup
REDIS_URL: redis://grist-redis
# MinIO setup
# MinIO setup. This requires the bucket set up on the MinIO instance with versioning enabled.
GRIST_DOCS_MINIO_ACCESS_KEY: grist
GRIST_DOCS_MINIO_SECRET_KEY: CHANGE THIS MINIO PASSWORD
GRIST_DOCS_MINIO_USE_SSL: 0