Skip to content

Document aspire dashboard run as primary standalone configuration path#1157

Open
IEvangelist with Copilot wants to merge 2 commits into
mainfrom
copilot/document-aspire-dashboard-run
Open

Document aspire dashboard run as primary standalone configuration path#1157
IEvangelist with Copilot wants to merge 2 commits into
mainfrom
copilot/document-aspire-dashboard-run

Conversation

Copilot AI commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Aspire 13.3 introduced the preview aspire dashboard run, but dashboard docs still emphasized container-first examples in key standalone/security sections. This updates those sections to lead with CLI usage while preserving Docker fallback where container-only flow remains relevant.

  • Standalone dashboard configuration (dashboard/configuration.mdx)

    • Promotes aspire dashboard run as the primary way to configure telemetry limits in standalone mode.
    • Keeps docker run examples as fallback for container-based deployments.
    • Clarifies the mapping between CLI args, env-var-style settings, and JSON config.
  • Security guidance (dashboard/security-considerations.mdx)

    • Replaces docker run -it ... command examples with aspire dashboard run ... equivalents in:
      • Incoming OTLP endpoint hardening
      • Telemetry API endpoint hardening
    • Updates surrounding copy to describe command behavior generically instead of Docker-specific wording.
  • CLI flag/config syntax alignment

    • Uses forwarded dashboard config argument format (--Dashboard:...=...) consistent with Aspire CLI behavior.
aspire dashboard run \
  --Dashboard:TelemetryLimits:MaxLogCount=1000 \
  --Dashboard:TelemetryLimits:MaxTraceCount=1000 \
  --Dashboard:TelemetryLimits:MaxMetricsCount=1000

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot AI changed the title [WIP] Document max log levels for aspire dashboard run Document aspire dashboard run as primary standalone configuration path Jun 2, 2026
Copilot AI requested a review from IEvangelist June 2, 2026 02:44
@IEvangelist IEvangelist marked this pull request as ready for review June 30, 2026 08:38
@IEvangelist IEvangelist requested a review from JamesNK as a code owner June 30, 2026 08:38
Copilot AI review requested due to automatic review settings June 30, 2026 08:38

Copilot AI 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.

Pull request overview

This PR updates the Aspire Dashboard documentation to lead with aspire dashboard run as the primary standalone configuration path (instead of container-first examples), while keeping container guidance where it’s still relevant.

Changes:

  • Updates standalone/security guidance to use aspire dashboard run examples for OTLP and telemetry API hardening.
  • Adds Aspire CLI–first configuration examples for telemetry limits, with Docker/environment-variable fallback.
  • Aligns examples to forwarded dashboard config argument syntax (--Dashboard:...=...).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
src/frontend/src/content/docs/dashboard/security-considerations.mdx Replaces Docker-based hardening examples with aspire dashboard run examples for OTLP and telemetry API.
src/frontend/src/content/docs/dashboard/configuration.mdx Adds CLI-first standalone configuration examples for telemetry limits and retains Docker env-var fallback.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +61 to +63
aspire dashboard run \
--Dashboard:Otlp:AuthMode=ApiKey \
--Dashboard:Otlp:PrimaryApiKey={MY_APIKEY}
Comment on lines +70 to +72
aspire dashboard run `
--Dashboard:Otlp:AuthMode=ApiKey `
--Dashboard:Otlp:PrimaryApiKey={MY_APIKEY}
Comment on lines +156 to +159
aspire dashboard run \
--Dashboard:Api:Enabled=true \
--Dashboard:Api:AuthMode=ApiKey \
--Dashboard:Api:PrimaryApiKey={MY_APIKEY}
Comment on lines +166 to +169
aspire dashboard run `
--Dashboard:Api:Enabled=true `
--Dashboard:Api:AuthMode=ApiKey `
--Dashboard:Api:PrimaryApiKey={MY_APIKEY}
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.

Dashboard configuration page should document aspire dashboard run

3 participants