Example using Docker and NGINX#

This Example is originally authored by Akito.#

This is a complete Docker setup example for Grist.

The following docker-compose.yml files are needed.

You will need to adjust the environment variables to your needs.

Requirements#

You need to have the most recent Docker distribution including the docker compose extension installed.

To prepare the host environment, create an empty directory, and within it do:

sudo -u "$(id -un 1000):$(id -un 1000)" mkdir -p ./config/nginx/site-confs ./data ./database/data

NGINX Reverse Proxy with automatic HTTPS#

For automatic HTTPS to work, you first need to setup proper DNS entries for the server you are running this reverse proxy on.

This reverse proxy is decoupled from Grist, in a separate docker-compose.yml, so you may conveniently provide additional backends to which it can route traffic - for example, Authelia for authentication. This setup uses SWAG, a Docker image that bundles the NGINX reverse proxy with useful services including TLS certificate generation and renewal.

This is the docker-compose.yml file managing the NGINX instance.

version: "3.9"
services:
  letsencrypt:
    image: lscr.io/linuxserver/swag # NGINX with automatic HTTPS
    container_name: nginx-letsencrypt-master
    network_mode: "host"
    environment:
      - PUID=1000 # Optional Change
      - PGID=1000 # Optional Change
      - TZ=Europe/London # Change!
      - URL=mydomain.eu # Change here, in ./config/nginx/site-confs/grist.conf & in .env files!
      - SUBDOMAINS=grist,webhook.grist # Change here, in ./config/nginx/site-confs/grist.conf & in .env files!
      - VALIDATION=http
      - EMAIL=admin@mydomain.eu # Change!
      - ONLY_SUBDOMAINS=true
      - STAGING=false # Enable if testing!
    volumes:
      - ./config:/config
    restart: unless-stopped

NGINX Configuration#

The following configuration is to be placed in ./config/nginx/site-confs/grist.conf, to make the NGINX instance route to Grist properly.

server {
    listen 443 ssl http2;
    listen [::]:443 ssl http2;

    # Adjust to your needs!
    server_name grist.mydomain.eu webhook.grist.mydomain.eu;

    # enable subfolder method reverse proxy confs
    include /config/nginx/proxy-confs/*.subfolder.conf;

    # enable for ldap auth (requires ldap-location.conf in the location block)
    #include /config/nginx/ldap-server.conf;

    # enable for Authelia (requires authelia-location.conf in the location block)
    #include /config/nginx/authelia-server.conf;

    location / {
        proxy_pass http://127.0.0.1:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
}

Grist#

This is the docker-compose.yml for the Grist backend. It contains the Grist app deployment, which is accompanied by a PostgreSQL database.

# https://github.com/gristlabs/grist-core#using-grist

version: "3.9"

services:
  grist:
    image: gristlabs/grist:1.0.8 # Change! --> https://hub.docker.com/r/gristlabs/grist/tags
    container_name: grist
    user: "1000" # Optional Change
    env_file:
      - ./grist.env
    volumes:
      - ./data:/persist
    ports:
      - 127.0.0.1:3000:8080
    depends_on:
      - database

  database:
    image: postgres:15-alpine
    container_name: grist_db
    user: "1000" # Optional Change
    env_file:
      - ./grist_db.env
    volumes:
      - ./database/data:/var/lib/postgresql/data

Environment#

The following .env files must be located in the same folder as the Grist docker-compose.yml.

grist.env#

# https://github.com/gristlabs/grist-core#environment-variables

PORT=8080
APP_HOME_URL=https://grist.mydomain.eu
GRIST_ALLOWED_HOSTS=webhook.grist.mydomain.eu # Replace with webhook target domains
GRIST_DOMAIN=grist.mydomain.eu
GRIST_SINGLE_ORG=myorg
GRIST_HIDE_UI_ELEMENTS=billing
GRIST_LIST_PUBLIC_SITES=false
GRIST_MAX_UPLOAD_ATTACHMENT_MB=10
GRIST_MAX_UPLOAD_IMPORT_MB=300
GRIST_ORG_IN_PATH=false
GRIST_PAGE_TITLE_SUFFIX=_blank
GRIST_FORCE_LOGIN=true
GRIST_SUPPORT_ANON=false
GRIST_THROTTLE_CPU=true

GRIST_SANDBOX_FLAVOR=gvisor
PYTHON_VERSION=3
PYTHON_VERSION_ON_CREATION=3

# Database
TYPEORM_DATABASE=grist
TYPEORM_USERNAME=grist
TYPEORM_HOST=grist_db
TYPEORM_LOGGING=false
TYPEORM_PASSWORD=mysupersecretpassword CHANGE THIS!!!!
TYPEORM_PORT=5432
TYPEORM_TYPE=postgres

grist_db.env#

# https://hub.docker.com/_/postgres

POSTGRES_DB=grist
POSTGRES_USER=grist
POSTGRES_PASSWORD=mysupersecretpassword CHANGE THIS!!!!