Skip to content

[docs] Document aspire stop socket cleanup for detached AppHosts #1283

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

Open
aspire-repo-bot wants to merge 1 commit into
base: release/13.5
Choose a base branch
from
+4 −0
Open

[docs] Document aspire stop socket cleanup for detached AppHosts #1283

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
4 changes: 4 additions & 0 deletions src/frontend/src/content/docs/reference/cli/commands/aspire-stop.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ When executed without the `--apphost` option, the command:

The command sends a stop signal to the CLI process that started the AppHost, which ensures a clean shutdown of all resources including the dashboard and any containers or processes that were started.

### Stopping a detached AppHost

When stopping an AppHost that was started with [`aspire run --detach`](/reference/cli/commands/aspire-run/#options), the `aspire stop` command waits for the AppHost process to terminate and then removes the backchannel socket file it previously used for communication. Cleaning up the socket file ensures that subsequent CLI commands such as `aspire add` or `aspire describe` do not encounter stale-connection errors from a dead AppHost process.

## Options

The following options are available:
Expand Down
Loading