Skip to content

Remove an agent

Removing an agent disconnects it at once, and it can never reconnect with its key. Open previews that use its hostnames lose the app immediately. To bring the host back, install it again with a new join token.

  1. Go to Agents, open the agent (or use its row menu) and choose Remove. This needs the Remove agents permission.
  2. Type the agent’s name to confirm and press Remove agent.
  • Docker:

    Terminal window
    docker rm -f houseguest-agent
    docker volume rm houseguest-agent
  • Docker Compose: in the folder with compose.yaml:

    Terminal window
    docker compose down
    docker volume rm <project>_houseguest-agent

    docker volume ls shows the volume’s full name.

  • No Docker:

    Terminal window
    curl -fsSL https://get.houseguest.dev/install-agent.sh | sudo sh -s -- --uninstall

    This removes the service, its user and its key.

A removed agent that is still running logs edge answered 401: Unknown agent. and retries every 30 seconds until it is stopped. That is harmless, but stop it.

  • Hostnames the agent forwarded: remove their public DNS records if nothing else will serve them. The edge answers “No preview is open here” on a name no open preview uses.
  • On the hosted service, the domain stays verified for your workspace until you remove it on Domains & addresses.