Skip to content

[docs] Document integratedBrowser as default dashboard browser option for VS Code extension #810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamint merged 1 commit into from
May 5, 2026
Merged

[docs] Document integratedBrowser as default dashboard browser option for VS Code extension #810

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 17 additions & 1 deletion src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,12 +177,28 @@ Configure the extension under **Settings > Aspire**, or jump there with **Aspire
| Setting | Default | Description |
|---------|---------|-------------|
| `aspire.aspireCliExecutablePath` | `""` | Path to the Aspire CLI. Leave empty to use `aspire` from PATH. |
| `aspire.dashboardBrowser` | `openExternalBrowser` | Which browser opens the dashboard — system default, or Chrome/Edge/Firefox as a debug session. |
| `aspire.dashboardBrowser` | `integratedBrowser` | Which browser opens the dashboard. See [Dashboard browser options](#dashboard-browser-options) below. |
| `aspire.enableAspireDashboardAutoLaunch` | `true` | Open the dashboard automatically when you start debugging. |
| `aspire.registerMcpServerInWorkspace` | `false` | Register the Aspire MCP server (see [MCP Server Integration](#mcp-server-integration)). |

There are more settings for verbose logging, startup prompts, and polling intervals — run **Aspire: Extension settings** to see them all.

### Dashboard browser options

The `aspire.dashboardBrowser` setting controls how the Aspire Dashboard opens when you start debugging:

| Value | Description |
|-------|-------------|
| `integratedBrowser` **(default)** | Opens the dashboard in VS Code's built-in Simple Browser tab, keeping you in the IDE. Note: the tab does not auto-close when the debug session ends. |
| `openExternalBrowser` | Opens the dashboard in your system default browser. |
| `debugChrome` | Launches Chrome as a debug session (auto-closes when debugging ends). |
| `debugEdge` | Launches Microsoft Edge as a debug session (auto-closes when debugging ends). |
| `debugFirefox` | Launches Firefox as a debug session (requires the [Firefox Debugger](https://marketplace.visualstudio.com/items?itemName=firefox-devtools.vscode-firefox-debug) extension). |

:::note
The `integratedBrowser` option became the default in Aspire 9.3. If you prefer the dashboard to open in your system browser, change the setting to `openExternalBrowser`.
:::

The extension also provides IntelliSense and validation when editing `.aspire/settings.json` (workspace-level) and `~/.aspire/globalsettings.json` (user-level). Use the **Open local/global Aspire settings** commands to open them.

## MCP server integration
Expand Down