diff --git a/docs/fundamentals/dashboard/configuration.md b/docs/fundamentals/dashboard/configuration.md index e47808c478..0ed7b3ef92 100644 --- a/docs/fundamentals/dashboard/configuration.md +++ b/docs/fundamentals/dashboard/configuration.md @@ -1,7 +1,7 @@ --- title: .NET Aspire dashboard configuration description: .NET Aspire dashboard configuration options -ms.date: 05/18/2024 +ms.date: 05/30/2024 ms.topic: reference --- @@ -19,6 +19,8 @@ There are a number of ways to provide configuration: Consider the following example, which shows how to configure the dashboard when started from a Docker container: +## [Bash](#tab/bash) + ```bash docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard \ -e DASHBOARD__TELEMETRYLIMITS__MAXLOGCOUNT='1000' \ @@ -27,6 +29,18 @@ docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard \ mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0 ``` +## [PowerShell](#tab/powershell) + +```powershell +docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard ` + -e DASHBOARD__TELEMETRYLIMITS__MAXLOGCOUNT='1000' ` + -e DASHBOARD__TELEMETRYLIMITS__MAXTRACECOUNT='1000' ` + -e DASHBOARD__TELEMETRYLIMITS__MAXMETRICSCOUNT='1000' ` + mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0 +``` + +--- + Alternatively, these same values could be configured using a JSON configuration file that is specified using `DOTNET_DASHBOARD_CONFIG_FILE_PATH`: ```json diff --git a/docs/fundamentals/dashboard/media/standalone/standalone-mode.png b/docs/fundamentals/dashboard/media/standalone/standalone-mode.png new file mode 100644 index 0000000000..63e1343fff Binary files /dev/null and b/docs/fundamentals/dashboard/media/standalone/standalone-mode.png differ diff --git a/docs/fundamentals/dashboard/overview.md b/docs/fundamentals/dashboard/overview.md index 403d94010c..0a073dfa7b 100644 --- a/docs/fundamentals/dashboard/overview.md +++ b/docs/fundamentals/dashboard/overview.md @@ -1,7 +1,7 @@ --- title: .NET Aspire dashboard overview description: Overview of .NET Aspire dashboard and getting started. -ms.date: 05/18/2024 +ms.date: 05/30/2024 ms.topic: reference --- @@ -21,11 +21,22 @@ For more information about using the dashboard during .NET Aspire development, s The .NET Aspire dashboard is also shipped as a Docker image and can be used standalone, without the rest of .NET Aspire. The standalone dashboard provides a great UI for viewing telemetry and can be used by any application. +## [Bash](#tab/bash) + ```bash docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard \ mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0 ``` +## [PowerShell](#tab/powershell) + +```powershell +docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard ` + mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0 +``` + +--- + The preceding Docker command: - Starts a container from the `mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0` image. diff --git a/docs/fundamentals/dashboard/security-considerations.md b/docs/fundamentals/dashboard/security-considerations.md index b25a665839..cef8c3277a 100644 --- a/docs/fundamentals/dashboard/security-considerations.md +++ b/docs/fundamentals/dashboard/security-considerations.md @@ -1,7 +1,7 @@ --- title: .NET Aspire dashboard security considerations description: Security considerations for running the .NET Aspire dashboard -ms.date: 03/13/2024 +ms.date: 05/30/2024 ms.topic: reference --- @@ -51,6 +51,8 @@ To prevent untrusted apps from sending telemetry to .NET Aspire, the OTLP endpoi API key authentication can be enabled on the telemetry endpoint with some additional configuration: +## [Bash](#tab/bash) + ```bash docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard \ -e DASHBOARD__OTLP__AUTHMODE='ApiKey' \ @@ -58,6 +60,17 @@ docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard \ mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0 ``` +## [PowerShell](#tab/powershell) + +```powershell +docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard ` + -e DASHBOARD__OTLP__AUTHMODE='ApiKey' ` + -e DASHBOARD__OTLP__PRIMARYAPIKEY='{MY_APIKEY}' ` + mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0 +``` + +--- + The preceding Docker command: - Starts the .NET Aspire dashboard image and exposes OTLP endpoint as port 4317 diff --git a/docs/fundamentals/dashboard/standalone.md b/docs/fundamentals/dashboard/standalone.md index a1bdc2ef09..5cb1d30951 100644 --- a/docs/fundamentals/dashboard/standalone.md +++ b/docs/fundamentals/dashboard/standalone.md @@ -1,7 +1,7 @@ --- title: Standalone .NET Aspire dashboard description: How to use the .NET Aspire dashboard standalone. -ms.date: 05/18/2024 +ms.date: 05/30/2024 ms.topic: reference --- @@ -12,7 +12,7 @@ The [.NET Aspire dashboard](overview.md) provides a great UI for viewing telemet - Ships as a container image that can be used with any OpenTelemetry enabled app. - Can be used standalone, without the rest of .NET Aspire. -:::image type="content" source="media/explore/trace.png" lightbox="media/explore/trace.png" alt-text="A screenshot of the .NET Aspire dashboard Trace details page."::: +:::image type="content" source="media/standalone/standalone-mode.png" lightbox="media/standalone/standalone-mode.png" alt-text="A screenshot of the .NET Aspire dashboard running in standalone mode."::: ## Start the dashboard