Skip to main content

Install Host Agent

Run the following command in your terminal:

Loading...

Adjust options as needed. Add the output to the hosts section of your config on the Coordinator Host:

/this/is/a/demo.toml

Hosts Table

Host Status Leases Actions

Install Client

Run one of the following commands in your terminal:

For Linux/macOS:

Loading...

For Windows (PowerShell):

Loading...

Optionally specify a custom base client ID as the second argument (otherwise random). The full client ID will include your hostname. Tip: Use separate clients for different use cases.

Then, add the output to the clients section of your config on the Coordinator Host:

/this/is/a/demo.toml

Clients Table

Client ID Leases Last Used Actions

🖥️ Platform Support

Component Linux macOS Windows
Web GUI ✅ (any modern browser) ✅ (any modern browser) ✅ (any modern browser)
Coordinator ✅ Binary
✅ Docker		 ✅ Binary
❌ Docker
✅ Linux VM (bridged networking)		 ❌ Binary
❌ Docker
❌ WSL
✅ Linux VM (bridged networking)
Host Agent ✅ Binary ✅ Binary ❌ Binary
❌ WSL
Client ✅ Shell
✅ Docker		 ✅ Shell
✅ Docker		 ✅ PowerShell
✅ Docker
✅ WSL (Shell)

Architecture Documentation

ShutHost provides two different architectural views depending on your use case:

Simplified Architecture

Simplified Architecture Diagram

When to use: This architecture applies when you have no clients defined in your configuration. In this scenario, only the WebUI interacts with hosts through the coordinator.

Complete Architecture

Complete Architecture Diagram

When to use: This architecture applies when you have clients defined in your configuration. This enables programmatic access where multiple clients can access hosts concurrently.