Skip to content

Commit

Permalink
Update dashboard README file (#2249)
Browse files Browse the repository at this point in the history
This project is no longer packable as a tool. Configuration can be specified in other ways, not just via env vars.
  • Loading branch information
drewnoakes authored Feb 17, 2024
1 parent 4c3a22a commit 82de397
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions src/Aspire.Dashboard/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# .NET Aspire Dashboard

## As a dotnet tool

The dashboard can be packaged and executed as a `dotnet tool`.

Configuration is (currently) performed via environment variables:
The dashboard is configured with the following keys:

- `DOTNET_DASHBOARD_OTLP_ENDPOINT_URL` specifies the OTLP endpoint, and defaults to http://localhost:18889.
- `ASPNETCORE_URLS` specifies the HTTP endpoint via which the dashboard web application is served, and defaults to http://localhost:18888.
- `DOTNET_RESOURCE_SERVICE_ENDPOINT_URL` specifies the gRPC endpoint to which the dashboard connects to for its data. There's no default. If this variable is unspecified, the dashboard shows OTEL data but no resource list or console logs.
- `DOTNET_DASHBOARD_APPLICATION_NAME` specifies the application name to be displayed in the UI. This only applies when no resource service URL is specified. When a resource service exists, the service specifies the application name.

Configuration is obtained through `IConfiguration` so can be provided in several ways, such as via environment variables.

0 comments on commit 82de397

Please sign in to comment.