gristlabs_grist-core/docker-compose-examples/grist-local-testing/README.md

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.

## How to run this example

To run this example, change to the directory containing this example, and run:
```sh
docker compose up
```
Then you should be able to visit your local Grist instance at <http://localhost:8484>.

This will start an instance that stores its documents and files in the `persist/` subdirectory.
You can change this location using the `PERSIST_DIR` environment variable.
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 19:54:43 +00:00			`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.`

			`## How to run this example`

Make "grist-local-testing" docker-compose example work out of the box (#1165) * Maintain ./persist subdirectory using a dummy .gitkeep file * Have PERSIST_DIR default to it * Update README with more detail how to run and info about PERSIST_DIR 2024-08-23 21:50:08 +00:00			`To run this example, change to the directory containing this example, and run:`
			```sh
			`docker compose up`
			```
			`Then you should be able to visit your local Grist instance at <http://localhost:8484>.`

			This will start an instance that stores its documents and files in the `persist/` subdirectory.
			You can change this location using the `PERSIST_DIR` environment variable.