Repository navigation
[docs] Document Dashboard:Frontend:DisableWebSocketCompression setting - #1820
Open
aspire-repo-bot[bot] wants to merge 1 commit into
Open
aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
4 of 14 tasks
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
James Newton-King (JamesNK)
approved these changes
Oct 3, 2026
James Newton-King (JamesNK)
marked this pull request as ready for review
October 3, 2026 05:24
James Newton-King (JamesNK)
enabled auto-merge (squash)
October 3, 2026 05:24
Contributor
There was a problem hiding this comment.
Copilot review overview
🔵 Needs a closer look
Source claims were verified, but rendered-page browser validation could not be completed.
Review effort: Balanced
Findings: None
What changed in this PR
Documents the new Dashboard WebSocket compression setting. Its name, default, behavior, and proxy guidance match microsoft/aspire main.
Changes:
- Adds the setting to the frontend configuration table.
- Notes proxy compatibility and bandwidth implications.
- Browser validation was unavailable because
playwright-cliwas not installed.
| File | Description |
|---|---|
src/frontend/src/content/docs/dashboard/configuration.mdx |
Documents DisableWebSocketCompression. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Documents changes from microsoft/aspire#20633
@JamesNKTarget branch: Targeting
release/17.0based on the source PR milestone17.0(exact match onmicrosoft/aspire.dev).Why this PR is needed
PR microsoft/aspire#20633 adds a new Dashboard configuration option,
Dashboard:Frontend:DisableWebSocketCompression, that lets users disable Blazor WebSocket compression (useful behind reverse proxies like IIS ARR that don't support compressed WebSocket messages). The PR body includes a "User-facing usage" section showing both the environment-variable form (DASHBOARD__FRONTEND__DISABLEWEBSOCKETCOMPRESSION=true) and JSON configuration form, which triggered thepr_body_has_user_facing_sectionandpr_body_has_cli_flag_mentionsignals. This is a new, previously-undocumented Dashboard configuration key, so the public docs needed an update.What changed
Added a row to the Frontend options table in
src/frontend/src/content/docs/dashboard/configuration.mdx, matching the style of neighboring rows (PublicUrl,MaxConsoleLogCount):The identifier and default value were copied verbatim from the source diff (
src/Aspire.Dashboard/Configuration/DashboardOptions.csandsrc/Shared/DashboardConfigNames.cs).Files modified
src/frontend/src/content/docs/dashboard/configuration.mdx(updated existing page — added one table row)No new pages were created; this was a targeted update to the existing Dashboard configuration reference page.