Adds docker compose examples #1113

Spoffy · 2024-07-18T23:11:43Z

This adds two example docker-compose files:

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

These give a starting point for people to create their own compose files, and to try Grist out of the box.

However, neither is suitable for a production/public environment, and both files are commented with that accordingly.

jordigh · 2024-07-22T17:43:07Z

Generally, I like this. Could we parametrise some of the obvious variables like password or persistent storage with interpolation?

paulfitz · 2024-07-22T17:42:43Z

docker-compose-examples/grist-local-testing.yml

+    image: gristlabs/grist:latest
+    environment:
+      # Use Python 3 instead of 2.
+      PYTHON_VERSION: 3


Oh, it that needed? PYTHON_VERSION_ON_CREATION at least is set to 3 I believe. Is something Python 2 ish happening by default?

Turns out it isn't, I copied it from an old example. I see we now have this in the docker image by default anyway :)

paulfitz · 2024-07-22T17:45:53Z

docker-compose-examples/grist-with-postgres-redis-minio.yml

+      # Redis setup
+      REDIS_URL: redis://grist-redis
+
+      # MinIO setup


Could maybe have a comment about how the bucket needs to have version control enabled (I see you have code to do this later)

Good shout, done!

paulfitz · 2024-07-22T17:48:57Z

docker-compose-examples/grist-with-postgres-redis-minio.yml

+# - 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.


Auth is something people really want, probably ranking over external db / redis / snapshots.

This is certainly a useful example though!

Added an Auth example with OIDC. :)

Spoffy · 2024-07-24T01:38:26Z

Thanks for the reviews! Adding the OIDC example, then I'll incorporate the feedback from you both :)

Spoffy · 2024-07-30T13:08:55Z

Added some interpolation-based config variables @jordigh, added more docs and also moved all the volumes to exist in a single "persist" sub-directory to make it easier to wipe them all.

docker-compose-examples/grist-traefik-oidc-auth/README.md

jordigh

I was able to get the traefik+oidc example working without any hassle after following the instructions. I'm glad that worked.

One general comment: several files are missing ending newlines.

According to POSIX, every text file should have a final newline.

jordigh · 2024-08-01T21:00:28Z

docker-compose-examples/grist-traefik-oidc-auth/docker-compose.yml

+      # Domain Grist is hosted at. Custom variable that's interpolated into the Authelia config
+      APP_DOMAIN: 'grist.localhost'
+      # Where Authelia should redirect to after successful authentication.
+      GRIST_OAUTH_CALLBACK_URL: https://grist.localhost/oauth2/callback


Since I expect that people will copy this file and modify it as little as possible, this callback URL should probably also be parametrised.

Parameterised this and the Authelia domains. I haven't allowed full URL changes (e.g scheme, or /oauth2/callback) since they're required to be https:// and /oauth2/callback.

jordigh · 2024-08-01T21:02:15Z

docker-compose-examples/grist-with-postgres-redis-minio/README.md

+
+## How to run this example
+
+This example can be run with `docker compose up`.


We should add instructions on what should be changed, such as the default database and minio passwords.

Added some advice to update the _PASSWORD vars in the .env file.

jordigh · 2024-08-01T21:03:33Z

docker-compose-examples/grist-traefik-oidc-auth/configs/authelia/configuration.yml

@@ -0,0 +1,1414 @@
+# yamllint disable rule:comments-indentation


This file was automatically generated, correct? We probably should provide or link to instructions on how to get this file, and what might be changed about it.

This was copied from their Github, rather than auto-generated. I could add a link to the original Github at the top?

Yeah, that link would be helpful.

jordigh · 2024-08-02T02:46:50Z

docker-compose-examples/grist-traefik-oidc-auth/README.md

+
+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.


Should mention that for local hosting, self-signed certs aren't a problem and should be accepted in the web browser. Not everyone knows how to click past a TLS error.

Added some details on this.

jordigh · 2024-08-02T16:25:51Z

A couple of extra things:

The secrets creation script modifies a file checked into git and adds other files that show up as untracked. I recommend we use a template .env file and have the script copy the template over, and some .gitignore rules for the new files it adds.
Following @paulfitz's preference to avoid more top-level clutter, I think this belongs under documentation/, as this is supposed to be almost completely working real examples.

Spoffy · 2024-08-05T20:56:09Z

With regards to top-level clutter @jordigh - I'd be worried about discoverability. I'd expect documentation to just be a manual, not examples, personally.

I'd propose we keep it top level (could rename to just docker-compose).

However, we could compromise and do documentation/docker-compose-examples and add a section on it to the README?

descriptions.

- Removes some whitespace - Removes unnecessary environment variables

paulfitz reviewed Jul 22, 2024

View reviewed changes

Spoffy marked this pull request as ready for review July 29, 2024 19:49

jordigh reviewed Aug 1, 2024

View reviewed changes

docker-compose-examples/grist-traefik-oidc-auth/README.md Show resolved Hide resolved

jordigh reviewed Aug 2, 2024

View reviewed changes

jordigh approved these changes Aug 6, 2024

View reviewed changes

Spoffy added 20 commits August 12, 2024 20:40

Adds docker compose examples

a8895aa

Adds basic auth example

aa2fc97

Moves docker compose examples into folders

e6e6854

Adds OIDC example with Authelia

9b0b2b7

Dex prototype

810662f

Working OIDC with Authelia

53293e4

Makes small improvements to basic-auth setup

c85f7e3

Moves documentation into README files, and improves links and

372c8b8

descriptions.

Adds additional instructions on running the OIDC example

635fd91

Adds additional README instructions to compose examples

f36f195

Cleans up compose files

b0dbdf0

- Removes some whitespace - Removes unnecessary environment variables

Parameterises redis-postgres-minio docker example

b255310

Parameterises docker OIDC auth example

1ec8dfe

Adds an extra newline to .env to ensure secret writing works

d9b26b9

Makes Authelia persistance easier to wipe

ab9345b

Moves secrets to secrets_template in OIDC example

2966923

Adds username and password details to OIDC example

928e0c6

Standardises /persist dir across all docker-compose examples

793d0d1

Makes docker-compose examples ignore persistent values and secrets

309f8d3

Adds information on self-signed certificate to OIDC example

0b16e82

Spoffy added 4 commits August 12, 2024 20:40

Parameterises OIDC Grist + Authelia domains

e9c660a

Adds suggestion to change passwords to redis/minio docker example

6bddd69

Adds newlines to various files

b58bc8f

Adds link to Authelia config template

9bed145

Spoffy force-pushed the spoffy/docker-compose branch from 2bca4b1 to 9bed145 Compare August 12, 2024 19:40

Spoffy merged commit dfb8168 into main Aug 12, 2024
11 checks passed

Spoffy deleted the spoffy/docker-compose branch August 12, 2024 19:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds docker compose examples #1113

Adds docker compose examples #1113

Spoffy commented Jul 18, 2024

jordigh commented Jul 22, 2024

paulfitz Jul 22, 2024

Spoffy Aug 5, 2024

paulfitz Jul 22, 2024

Spoffy Jul 26, 2024

paulfitz Jul 22, 2024

Spoffy Jul 26, 2024

Spoffy commented Jul 24, 2024

Spoffy commented Jul 30, 2024

jordigh left a comment

jordigh Aug 1, 2024

Spoffy Aug 5, 2024 •

edited

Loading

jordigh Aug 1, 2024

Spoffy Aug 5, 2024

jordigh Aug 1, 2024

Spoffy Aug 5, 2024

jordigh Aug 6, 2024

jordigh Aug 2, 2024

Spoffy Aug 5, 2024

jordigh commented Aug 2, 2024

Spoffy commented Aug 5, 2024


		## How to run this example

		This example can be run with `docker compose up`.

		@@ -0,0 +1,1414 @@
		# yamllint disable rule:comments-indentation


		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.

Adds docker compose examples #1113

Adds docker compose examples #1113

Conversation

Spoffy commented Jul 18, 2024

jordigh commented Jul 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Spoffy commented Jul 24, 2024

Spoffy commented Jul 30, 2024

jordigh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Spoffy Aug 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jordigh commented Aug 2, 2024

Spoffy commented Aug 5, 2024

Spoffy Aug 5, 2024 •

edited

Loading