From df0d395138cec90f5b06b771be2641fbee80f9ec Mon Sep 17 00:00:00 2001 From: Josh Wright Date: Fri, 9 Oct 2026 20:05:47 -0400 Subject: [PATCH] Document proxy compression for HTML and JSON. Refs #132 --- docs/guides/getting-started.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/guides/getting-started.md b/docs/guides/getting-started.md index cb2d487..a967547 100644 --- a/docs/guides/getting-started.md +++ b/docs/guides/getting-started.md @@ -41,10 +41,15 @@ new controller. See [.env.example](../../.env.example) for the other settings. docker compose up -d --build ``` -Proxy the HTTPS address to controller port 3000. Open the dashboard and follow -`/setup` to create the first administrator. Then remove `EC_SETUP_TOKEN` from -`.env` and run `docker compose up -d` to recreate the controller. Setup stays -closed once an account exists. +Proxy the HTTPS address to controller port 3000. Enable gzip or Brotli compression +at the HTTPS reverse proxy for HTML (`text/html`) and JSON (`application/json`), +including server-rendered pages, page data, and API responses. The build already +precompresses static JavaScript and CSS assets; dynamically generated responses +need compression at the proxy. + +Open the dashboard and follow `/setup` to create the first administrator. Then +remove `EC_SETUP_TOKEN` from `.env` and run `docker compose up -d` to recreate the +controller. Setup stays closed once an account exists. Add other users under **Admin → Users**. The [access guide](authentication.md) explains roles, proxy configuration, and