ShutHost Coordinator

Error!

This application requires JavaScript to function properly. Please enable JavaScript in your browser settings and reload the page.

Install Host Agent

Run one of the following commands in your terminal:

For Linux/macOS:

Loading...

For Windows (PowerShell):

Loading...

Adjust options as needed. The command will already include the configured broadcast port, so no manual change is required. Add the output to the hosts section of your config on the Coordinator Host:

/this/is/a/demo.toml

💡 Wake-on-LAN (WOL) Requirements

The agent requires Wake-on-LAN for remote startup functionality:

Motherboard Support: Your motherboard must support WOL.
- BIOS Configuration: WOL must be enabled (and thus available, which isnt guaranteed, e.g. Raspberry Pi) in BIOS/UEFI settings.
- Power State Limitation: Some systems only support WOL from sleep mode, not full shutdown.
OS Configuration: WOL must be enabled in the operating system.
Network Requirements: Requires network broadcast support and host reachability.
- Note: The installer tests network reachability but won't fail if the test is unsuccessful, so ensure your network supports broadcast for WOL to work properly.

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

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	✅ Self-extracting (manual service setup required)
Client (Script)	✅ Shell ✅ Docker	✅ Shell ✅ Docker	✅ PowerShell ✅ Docker ✅ WSL (Shell)
Direct Control (Script)	✅ Shell	✅ Shell	✅ PowerShell

Architecture Documentation

ShutHost's architecture is built around three core components: the Coordinator, Host Agents, and optional Clients for programmatic control.

Core Components & Interactions

Host-Agent-Coordinator Interaction Diagram

Lease System & Multi-Client Access

Client-Coordinator-Host Lease System Diagram

When leases matter: When you have clients defined in your configuration or multiple entities (WebUI + scripts) accessing hosts, the lease system prevents conflicts and ensures hosts stay online while in use.

How Leases Work

The lease system coordinates access when multiple clients or the WebUI need to use hosts simultaneously:

Lease Acquisition: Clients and WebUI request leases before accessing hosts
Automatic Startup: Hosts are automatically started when the first lease is acquired (lease count ≥1)
Automatic Shutdown: Hosts are automatically shut down when all leases are released (lease count = 0)
Conflict Prevention: Ensures hosts aren't shut down while still in use by other clients or the WebUI
Transparent to Users: When using only the WebUI without defined clients, the lease system operates automatically in the background

Deployment Options

Installation Paths

Full Deployment: Install the coordinator (binary or Docker) on an always-on host, then use the WebUI to generate and install agents and clients
Agent-Only: Install only the host agent on each managed host and use generated direct-control scripts for local LAN control (no coordinator needed)
Manual Registration: Agents and clients must be manually registered with the coordinator after installation
WOL Testing: The coordinator's installer includes connectivity tests to verify Wake-on-LAN functionality

Direct Control vs. Coordinator

💡 Key Takeaways

Security-First Design: Authenticated shutdown requests with HMAC signatures and timestamps prevent unauthorized access and replay attacks
Minimal Agent: Host agents are lightweight, run with necessary privileges, and integrate with system init services
Flexible Deployment: Choose between full coordinator deployment for remote access or agent-only for simple LAN control
Wake-on-LAN Foundation: Uses standard WOL for startup; adds secure shutdown capability that doesn't exist in standard protocols
Optional Coordination: Lease system activates when needed for multi-client scenarios, stays transparent for single-user WebUI usage

Install Host Agent

Hosts Table

Install Client

Clients Table

🖥️ Platform Support