Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/frontend/src/content/docs/app-host/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ In TypeScript AppHosts, profiles live in `aspire.config.json`:
| Option | Default value | Description |
| ---------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ASPIRE_ALLOW_UNSECURED_TRANSPORT` | `false` | Allows communication with the AppHost without https. `ASPNETCORE_URLS` (dashboard address) and `ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL` (AppHost resource service address) must be secured with HTTPS unless true. |
| `ASPIRE_CONTAINER_RUNTIME` | Auto-detected | Selects the runtime for container resources. Supported values are `docker`, `podman`, and `wslc`. WSLc is supported only on Windows and only for local development. Publish and deploy are not yet supported. See [container runtime prerequisites](/get-started/prerequisites/#install-an-oci-compliant-container-runtime). |
| `ASPIRE_CONTAINER_RUNTIME` | Auto-detected | Selects the runtime for container resources. Supported values are `docker`, `podman`, and `wslc`. WSLc is supported only on Windows. Publishing has initial, limited support: Dockerfile builds without platform selection, image tag/remove/push, registry login, and single-platform .NET SDK publishing to the WSLc local image store (requires an SDK with WSLc support). Compose deployment, platform-selected Dockerfile builds, manifest inspection, and multi-platform local publishing aren't supported and fail with an explicit error. Daemon-free .NET SDK archive publishing still works. See [container runtime prerequisites](/get-started/prerequisites/#install-an-oci-compliant-container-runtime). |
| `ASPIRE_DCP_USE_DEVELOPER_CERTIFICATE` | `true` | When `true` (the default), Aspire uses the ASP.NET Core developer certificate to secure the internal DCP server instead of an ephemeral certificate generated by DCP. On Windows, Aspire passes the certificate thumbprint to DCP. On macOS and Linux, Aspire passes the certificate and private key file paths (plus the thumbprint) so DCP can verify the loaded certificate. Set to `false` to opt out and use DCP's default ephemeral certificate. If no trusted developer certificate is found, Aspire automatically falls back to the ephemeral certificate. For more information, see [Certificate configuration](/app-host/certificate-configuration/). |
| `ASPIRE_ENVIRONMENT` | `null` | Configures the AppHost environment when no higher-priority environment source is set. If no environment is configured, the AppHost uses `Production`. |
| `ASPIRE_VERSION_CHECK_DISABLED` | `false` | When set to `true`, Aspire doesn't check for newer versions on startup. |
Expand Down
11 changes: 7 additions & 4 deletions src/frontend/src/content/docs/get-started/prerequisites.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ Ready to dive into Aspire? Before you begin, make sure your development environm
title: 'WSLc',
href: 'https://aka.ms/aspire/containers',
linkLabel: 'Set up WSLc',
statusLabel: 'Windows local development only',
statusLabel: 'Windows only; limited publish support',

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.

Updated both WSLc expectations in 442928e to match the new status and limited-publishing wording, including the Compose deployment limitation. E2E execution is left to CI; local lint was unavailable because pnpm is not installed.

description:
'A supported container runtime for local development on Windows. Requires WSLc version 3.0.2.0 or later. Publishing and deployment are not supported yet.',
'A supported container runtime for local development on Windows. Requires WSLc version 3.0.2.0 or later. Publishing has initial, limited support; Compose deployment isn't supported.',
},
{
id: 'rancher',
Expand All @@ -112,8 +112,11 @@ Ready to dive into Aspire? Before you begin, make sure your development environm
:::note[WSLc on Windows]
`aspire doctor` auto-detects installed runtimes in Docker, Podman, WSLc priority order.
Set `ASPIRE_CONTAINER_RUNTIME=wslc` to select WSLc explicitly. WSLc isn't supported
when Aspire runs inside a Linux WSL distribution. It is currently supported only
for local development on Windows, not for publishing or deployment.
when Aspire runs inside a Linux WSL distribution. Publishing has initial,
limited support: Dockerfile builds (Dockerfile resources default to `linux/amd64`, which WSLc
can't build, so set `TargetPlatform = null` in `WithContainerBuildOptions`), image tag/remove/push,
registry login, and single-platform .NET SDK publishing to the local image store. Compose
deployment and multi-platform local publishing aren't supported.
:::

1. ## Install an integrated development environment (IDE)
Expand Down
6 changes: 4 additions & 2 deletions src/frontend/tests/e2e/custom-components.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -351,9 +351,11 @@ test('prerequisites presents runtime choices with Podman setup and WSLc limitati

await expect(wslcChoice).toBeVisible();
await expect(podmanChoice).toBeHidden();
await expect(wslcChoice).toContainText('Windows local development only');
await expect(wslcChoice).toContainText('Windows only; limited publish support');
await expect(wslcChoice).toContainText('Requires WSLc version 3.0.2.0 or later.');
await expect(wslcChoice).toContainText('Publishing and deployment are not supported yet.');
await expect(wslcChoice).toContainText(
"Publishing has initial, limited support; Compose deployment isn't supported."
);
await expect(wslcChoice.getByRole('link', { name: 'Set up WSLc' })).toHaveAttribute(
'href',
'https://aka.ms/aspire/containers'
Expand Down