Skip to content

[web_server][captive_portal] Document compression option #5859

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
swoboda1337 merged 2 commits into from
Jan 9, 2026
Merged

[web_server][captive_portal] Document compression option #5859

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ce5a05
[web_server][captive_portal] Document compression option
bdraco Jan 5, 2026
b6fe557
Update content/components/web_server.md
bdraco Jan 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion content/components/captive_portal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,11 @@ wifi:
captive_portal:
```

No configuration variables.
## Configuration variables

- **compression** (*Optional*, string): The compression algorithm used for the embedded web assets.
Options are `br` (Brotli) or `gzip`. Brotli provides ~24% smaller size than gzip.
Defaults to `br`.

## See Also

Expand Down
4 changes: 4 additions & 0 deletions content/components/web_server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ web_server:
- **local** (*Optional*, boolean): Include supporting javascript locally allowing it to work without internet access.
Defaults to `false`.

- **compression** (*Optional*, string): The compression algorithm used for embedded web assets when `local` is enabled.
Options are `br` (Brotli) or `gzip`. Brotli provides ~10-12% smaller size than gzip for web server assets.
Defaults to `br`.

- **version** (*Optional*, string): `1`, `2` or `3`. Version 1 displays as a table. Version 2 uses web components
and has more functionality. Version 3 uses HA-Styling. Defaults to `2`.

Expand Down