Repository navigation
Integrations
All integrations are optional and off by default. Routing, the Web UI, the Service Gateway and manual Wake-on-LAN never depend on them.
Automation → MQTT: broker URI (mqtts:// recommended; mqtt:// sends
credentials in clear), optional credentials, base topic B and state interval.
| Topic | Content |
|---|---|
B/availability |
online / last-will offline (retained) |
B/state |
JSON state: uplink, Tailscale, routes, AP, resources, updates, operations, Service Gateway rules (retained) |
B/command/<name> |
Commands: status, restart, reconnects, ON/OFF switches, per-rule enable/test, wol/<MAC> for saved devices, recovery |
Commands are authorized by your broker: anyone who can publish to
B/command/# can use them. Use authentication, TLS and topic ACLs. An optional
broker watchdog can wake a saved device once per broker outage.
MQTT.md
Uses MQTT Discovery: Automation → MQTT → Home Assistant Discovery (prefix
homeassistant). One device with sensors for uplink, Tailscale, peers, routes,
resources and firmware; recovery buttons; per-rule switches, time remaining,
Test Tailnet destination buttons and status. Restrict who can operate
network controls in Home Assistant and on the broker.
HOME-ASSISTANT.md
Automation → ntfy: server URL, topic and (recommended) an access token.
Opt-in notifications: Tailscale down while the uplink works, gateway started,
Tailscale restored, firmware update available (never installed automatically),
health checks, recovery results, Service watch. Optional commands: info,
wol <name>, recover <name>, check <name>. Use a private topic and a
write-restricted token.
NTFY.md
Read-only SNMPv1/v2c metrics, off by default. Community authentication is plaintext: use a private community, restrict UDP 161 with the firewall and never expose it to the Internet. No SET support.
Start
Roles
- Service Gateway
- Subnet Router
- Exit Node
- Headscale
- Recovery and Wake-on-LAN
- Monitoring and Health
- Integrations
Operate
Reference
Project