[PR #1324] [MERGED] docs: document ENABLE_COMPRESSION_MIDDLEWARE trade-offs across perf a… #1299

New issue

Closed

opened 2026-10-18 14:18:42 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-18 14:18:42 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/1324
Author: @Classic298
Created: 7/20/2026
Status: ✅ Merged
Merged: 7/20/2026
Merged by: @Classic298

Base: dev ← Head: claude/compression-middleware-perf-docs-dgj98w

📝 Commits (2)

8db2ef5 docs: document ENABLE_COMPRESSION_MIDDLEWARE trade-offs across perf and scaling guides
d3f1982 docs: recommend proxy-side static asset caching when disabling compression

📊 Changes

4 files changed (+82 additions, -1 deletions)

View changed files

📝 docs/getting-started/advanced-topics/scaling.md (+47 -0)
📝 docs/reference/env-configuration.mdx (+16 -1)
📝 docs/troubleshooting/multi-replica.mdx (+4 -0)
📝 docs/troubleshooting/performance.md (+15 -0)

📄 Description

…nd scaling guides

Verified against open-webui source (env.py / main.py, starlette-compress
1.7.1): the flag only gates CompressMiddleware, which touches HTTP
responses exclusively — WebSocket scope passes through untouched, SSE
(text/event-stream) is not in the compressible content-type list, and
responses under 500 bytes are never compressed.

Expand the env-configuration reference entry with what the middleware
does and does not affect, the CPU/latency upside of disabling (~3-4%
per worker per py-spy profiling), the response-size downside (few KB
for typical API responses, but multi-MB first page load and 5-10x on
large chat/model JSON), and the recommended proxy-offload setup
Add an HTTP Response Compression section to the performance guide's
High-Concurrency chapter, plus Profile 3 checklist and env var table
entries
Add an "Offload HTTP Compression to the Load Balancer" step-3 section
and env-block entry to the scaling guide
Add a compress-at-the-LB best practice to the Scaling & HA
troubleshooting guide

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/docs/pull/1324 **Author:** [@Classic298](https://github.com/Classic298) **Created:** 7/20/2026 **Status:** ✅ Merged **Merged:** 7/20/2026 **Merged by:** [@Classic298](https://github.com/Classic298) **Base:** `dev` ← **Head:** `claude/compression-middleware-perf-docs-dgj98w` --- ### 📝 Commits (2) - [`8db2ef5`](https://github.com/open-webui/docs/commit/8db2ef570da5b832b9b897b99b356794e055af54) docs: document ENABLE_COMPRESSION_MIDDLEWARE trade-offs across perf and scaling guides - [`d3f1982`](https://github.com/open-webui/docs/commit/d3f198297b3ef054680a9ff4326cb387bdf0a6f6) docs: recommend proxy-side static asset caching when disabling compression ### 📊 Changes **4 files changed** (+82 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `docs/getting-started/advanced-topics/scaling.md` (+47 -0) 📝 `docs/reference/env-configuration.mdx` (+16 -1) 📝 `docs/troubleshooting/multi-replica.mdx` (+4 -0) 📝 `docs/troubleshooting/performance.md` (+15 -0) </details> ### 📄 Description …nd scaling guides Verified against open-webui source (env.py / main.py, starlette-compress 1.7.1): the flag only gates CompressMiddleware, which touches HTTP responses exclusively — WebSocket scope passes through untouched, SSE (text/event-stream) is not in the compressible content-type list, and responses under 500 bytes are never compressed. - Expand the env-configuration reference entry with what the middleware does and does not affect, the CPU/latency upside of disabling (~3-4% per worker per py-spy profiling), the response-size downside (few KB for typical API responses, but multi-MB first page load and 5-10x on large chat/model JSON), and the recommended proxy-offload setup - Add an HTTP Response Compression section to the performance guide's High-Concurrency chapter, plus Profile 3 checklist and env var table entries - Add an "Offload HTTP Compression to the Load Balancer" step-3 section and env-block entry to the scaling guide - Add a compress-at-the-LB best practice to the Scaling & HA troubleshooting guide --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-18 14:18:42 +00:00