Skip to content

System Services

wakezilla setup installs either the proxy or client as an operating-system service, writes an OS-standard configuration, starts the service, and checks that its port becomes reachable.

On Linux or macOS:

Terminal window
sudo wakezilla setup

On Windows, open PowerShell as Administrator:

Terminal window
wakezilla setup

Choose Proxy for the machine that remains available and Client for a target that accepts remote power requests. The wizard then asks for the listening port.

For a remotely managed client, prefer the generated command on the machine detail page. It includes the per-machine shutdown key and lets the dashboard verify the client automatically.

Provide the mode and port together:

Terminal window
sudo wakezilla setup --mode proxy --port 3000
sudo wakezilla setup --mode client --port 3001 --key <generated-key>

Add --yes when automation should overwrite an existing Wakezilla configuration without confirmation:

Terminal window
sudo wakezilla setup --mode proxy --port 3000 --yes

Reconfiguring one mode preserves the other mode’s port in config.toml.

--key is valid only for client mode. The dashboard-generated key is URL-safe base64 that decodes to 32 bytes. Treat the command as a credential and see Secure Shutdown for the complete workflow.

Platform Manager Service names
Linux systemd wakezilla-proxy, wakezilla-client
macOS launchd LaunchDaemon dev.wakezilla.proxy, dev.wakezilla.client
Windows Windows Service Manager wakezilla-proxy, wakezilla-client

The service runs a protected copy of the executable and starts with --no-update-check. On Windows, setup also creates or updates an inbound TCP firewall rule for the selected port.

Elevated privileges are required:

Terminal window
sudo wakezilla service status --mode proxy
sudo wakezilla service start --mode proxy
sudo wakezilla service stop --mode proxy
sudo wakezilla service restart --mode proxy

Omit --mode to select interactively when both services are installed. When only one mode is installed, Wakezilla selects it automatically.

On Windows, run the same commands from an elevated PowerShell without sudo.

Terminal window
sudo wakezilla service logs --mode proxy
sudo wakezilla service logs --mode proxy --follow --lines 100

See Logs for platform locations and direct service-manager commands.

wakezilla update replaces the executable that launched the update command. Service processes use protected executable copies created by setup. After updating, rerun setup for each installed mode so its protected copy receives the new version:

Terminal window
sudo wakezilla setup --mode proxy --port 3000 --yes
sudo wakezilla setup --mode client --port 3001 --yes

Rerunning client setup without --key preserves an existing shutdown key in config.toml.

Terminal window
sudo wakezilla uninstall

On Windows, run wakezilla uninstall as Administrator. This removes every installed Wakezilla service and setup-managed firewall rule, while preserving configuration, data, and logs.

For a proxy service:

Terminal window
curl http://127.0.0.1:3000/api/machines

For a client service:

Terminal window
curl http://127.0.0.1:3001/health

Do not test the client power endpoint unless you intend to suspend, hibernate, or shut down the host.