The docs don't say to compress HTML and API responses at the proxy #132

Closed
opened 2026-10-09 19:56:00 -04:00 by goddard · 1 comment
Collaborator

Static assets are compressed, but nothing tells admins to compress the rest.

  • adapter-node precompresses static JS and CSS (build/client has .br and .gz copies), but server-rendered HTML, page data and API responses go out uncompressed.
  • getting-started.md:44 only says to proxy the HTTPS address to port 3000, and nothing in the README or docs/ mentions gzip or Brotli.

Fix

  • Say in the getting-started guide that the HTTPS proxy should enable gzip or Brotli for HTML and JSON
Static assets are compressed, but nothing tells admins to compress the rest. - adapter-node precompresses static JS and CSS (`build/client` has `.br` and `.gz` copies), but server-rendered HTML, page data and API responses go out uncompressed. - `getting-started.md:44` only says to proxy the HTTPS address to port 3000, and nothing in the README or `docs/` mentions gzip or Brotli. **Fix** - Say in the getting-started guide that the HTTPS proxy should enable gzip or Brotli for HTML and JSON
goddard added the
priority
low
type/maintainability
labels 2026-10-09 19:56:00 -04:00
josh was assigned by goddard 2026-10-09 19:56:00 -04:00
Author
Collaborator

Reviewed df0d395138. The getting-started guide now tells admins to compress HTML and JSON at the proxy, so I'm closing this.

Checklist

  • Document proxy compression. getting-started.md:44-48 says to enable gzip or Brotli at the HTTPS proxy for text/html and application/json, covering server-rendered pages, page data and API responses. It also says static JavaScript and CSS are already precompressed, which matches adapter-node's default (precompress = true, not overridden in svelte.config.js:8).

Review notes

  • It's a docs-only change, so there were no tests to run. CI run 844 on this commit is green.
Reviewed df0d395138cec90f5b06b771be2641fbee80f9ec. The getting-started guide now tells admins to compress HTML and JSON at the proxy, so I'm closing this. **Checklist** - [x] **Document proxy compression.** `getting-started.md:44-48` says to enable gzip or Brotli at the HTTPS proxy for `text/html` and `application/json`, covering server-rendered pages, page data and API responses. It also says static JavaScript and CSS are already precompressed, which matches adapter-node's default (`precompress = true`, not overridden in `svelte.config.js:8`). **Review notes** - It's a docs-only change, so there were no tests to run. CI [run 844](https://gitea.thewrightserver.net/josh/electric-cherry/actions/runs/844) on this commit is green.
Sign in to join this conversation.