[web_server][captive_portal] Document compression option #5859
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
esphome
bot
added
component: captive_portal
component: web_server
has-parent
next
labels
17 tasks
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR documents the new compression configuration option for the web_server and captive_portal components, which allows users to select between Brotli (br) and gzip compression algorithms for embedded web assets. Brotli is now the default, offering improved flash usage efficiency.
Key Changes:
- Added
compressionconfiguration option documentation forweb_servercomponent - Added
compressionconfiguration option documentation forcaptive_portalcomponent
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| content/components/web_server.md | Added documentation for the compression option with Brotli and gzip choices |
| content/components/captive_portal.md | Added configuration variables section with the compression option documentation |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
swoboda1337
approved these changes
Jan 9, 2026
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Documents the new
compressionconfiguration option forcaptive_portalandweb_servercomponents.This option allows users to choose between Brotli (
br) and gzip compression for embedded web assets. Brotli is now the default, providing ~10-24% smaller flash usage compared to gzip.Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/_index.mdwhen creating new documents for new components or cookbook.