Guides
Browse the operational guides for firmware, Android, CLI automation, OTA updates, and self-hosted WakeLink deployments.
Start with Quick Start if you are new to WakeLink. Use the guides below when you need deeper operational detail for a specific client, firmware workflow, or deployment model.
Platform guides
ESP32 Firmware
Board support, flashing workflow, provisioning portal behaviour, LED states, local TCP control, and OTA hooks.
Open firmware guide
Android App
APK installation, account sign-in, agent creation, push setup, and the mobile provisioning wizard.
Open Android guide
CLI Tools
Python installation, device registry management, account subcommands, and scripted operations such as wake, ping, info, and ota.
Open CLI guide
Provisioning and OTA
Firmware enrollment and firmware maintenance are separate steps. Provisioning writes the relay host, Wi-Fi credentials, EWSP secret, and per-device relay token into the ESP32 NVS store. OTA updates later replace the firmware image over HTTPS without changing the device identity unless you also rotate tokens.
| Task | Primary guide | What it covers |
|---|---|---|
Initial enrollment | AP login, JSON API, HTML fallback, NVS fields, and token handling. | |
First hardware walkthrough | From flashing a board to waking the first target machine. | |
Firmware rollout | HTTPS downloads, SHA-256 checks, Ed25519 signatures, and safe recovery. |
Deployment guides
Self-Hosted Server
Deploy the relay, dashboard, website, PostgreSQL, Redis, ntfy, and nginx using the WakeLink deployer.
Open hosting guide
API Reference
Use REST, WebSocket, and EWSP documentation when you need to automate or integrate WakeLink instead of using the first-party clients.
Open API reference
Security Concepts
Review token separation, blind relay boundaries, and packet-level encryption before exposing devices on public networks.
Open security guide
Choose a path
- Home lab deployment: Start with Quick Start, then move to First Agent Setup and Android App.
- Automation and scripting: Read CLI Tools, then API Reference and EWSP Wire Format for low-level integrations.
- Operating your own instance: Read Self-Hosted Server first, then OpenAPI Spec and Troubleshooting.
- Maintaining fleets of boards: Combine ESP32 Firmware, Device Provisioning, OTA Updates, and Token Rotation.