Skip to content

Add note about nginx Brotli compatibility for subpath reverse proxy setups#4328

Merged
alecharmon merged 2 commits into
mainfrom
devin/1773768085-nginx-brotli-docs
Mar 17, 2026
Merged

Add note about nginx Brotli compatibility for subpath reverse proxy setups#4328
alecharmon merged 2 commits into
mainfrom
devin/1773768085-nginx-brotli-docs

Conversation

@alecharmon

@alecharmon alecharmon commented Mar 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a warning note to the Subpath section of the custom domain setup page, documenting a known issue where nginx reverse proxies can cause HTTP/2 partial transfer errors when proxying Fern docs.

Root cause: Fern's CDN (Cloudflare/Vercel) serves Brotli-compressed responses when the client advertises br support. nginx lacks native Brotli support, so when it proxies these responses it can corrupt the stream over HTTP/2. The fix is to configure nginx to only request encodings it supports natively (gzip,deflate).

This was reported by a customer (SignalWire) who experienced the issue in production.

Review & Testing Checklist for Human

  • Verify the warning renders correctly on the preview — it should appear inside the Subpath accordion, after the setup steps
  • Confirm the technical explanation is accurate and the nginx directive proxy_set_header Accept-Encoding "gzip,deflate"; is the right recommendation

Notes

  • The warning is scoped to the Subpath section since that's the most common reverse proxy use case, but the issue could technically affect any nginx reverse proxy setup pointing at Fern docs
  • Vale style checks pass cleanly
  • Minor trailing whitespace cleanup on the last line of the file

Link to Devin session: https://app.devin.ai/sessions/5d76edcab8864bdcb82362654e203ef1
Requested by: @alecharmon


Open with Devin

…etups

Co-Authored-By: alec <alecharmon@outlook.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@github-actions

github-actions Bot commented Mar 17, 2026

Copy link
Copy Markdown
Contributor

@alecharmon alecharmon merged commit e63bc2c into main Mar 17, 2026
2 checks passed
@alecharmon alecharmon deleted the devin/1773768085-nginx-brotli-docs branch March 17, 2026 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants