From ff06100c34e554f5fb48aa3f9733e24c527b0a45 Mon Sep 17 00:00:00 2001 From: Jose Perez Rodriguez Date: Fri, 6 Feb 2026 10:48:15 -0800 Subject: [PATCH] Documenting DCPCliPath --- .../content/docs/app-host/configuration.mdx | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/src/frontend/src/content/docs/app-host/configuration.mdx b/src/frontend/src/content/docs/app-host/configuration.mdx index 5de80d2d..c7e00f34 100644 --- a/src/frontend/src/content/docs/app-host/configuration.mdx +++ b/src/frontend/src/content/docs/app-host/configuration.mdx @@ -114,3 +114,45 @@ Internal settings are used by the AppHost and integrations. Internal settings ar | `AppHost:BrowserToken` | Automatically generated 128-bit entropy token. | The browser token used to authenticate browsing to the dashboard when it is launched by the AppHost. The browser token can be set by `ASPIRE_DASHBOARD_FRONTEND_BROWSERTOKEN`. The value is present if needed: the AppHost is in run mode, the dashboard isn't disabled, and the dashboard isn't configured to allow anonymous access with `ASPIRE_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS`. | | `AppHost:ResourceService:AuthMode` | `ApiKey`. If `ASPIRE_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS` is true then the value is `Unsecured`. | The authentication mode used to access the resource service. The value is present if needed: the AppHost is in run mode and the dashboard isn't disabled. | | `AppHost:ResourceService:ApiKey` | Automatically generated 128-bit entropy token. | The API key used to authenticate requests made to the AppHost's resource service. The API key can be set by `ASPIRE_DASHBOARD_RESOURCESERVICE_APIKEY`. The value is present if needed: the AppHost is in run mode, the dashboard isn't disabled, and the dashboard isn't configured to allow anonymous access with `ASPIRE_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS`. | + +## Advanced orchestration properties + + + +### DcpCliPath + +The `DcpCliPath` property specifies the path to the **Developer Control Plane (DCP)** executable. The DCP is the core orchestration engine that Aspire uses to run and manage distributed application resources locally during development. + +#### How it works + +When you use the [Aspire SDK](/get-started/aspire-sdk/), the build system automatically: + +1. Imports the platform-specific `Aspire.Hosting.Orchestration` NuGet package (for example, `Aspire.Hosting.Orchestration.win-x64`). +2. Sets `DcpCliPath` to point to the `dcp` executable within that package. +3. Embeds this path as assembly metadata in your compiled AppHost. + +At runtime, the AppHost reads this metadata to locate and start the DCP process, which then orchestrates your application's resources. + +#### Override options + +In rare cases, you may need to override the default DCP path: + +| Method | Example | +| ------ | ------- | +| MSBuild property | `C:\path\to\dcp.exe` | +| Command-line argument | `--dcp-cli-path /path/to/dcp` | +| Configuration | `DcpPublisher:CliPath` | + +#### When to use + +You might override `DcpCliPath` in these scenarios: + +- **Aspire contributors**: Testing with a custom or debug build of DCP when developing Aspire itself. +- **CI/CD pipelines**: Non-standard SDK layouts where automatic discovery doesn't work. +- **Troubleshooting**: Temporarily pointing to a specific DCP version to diagnose issues. + +