Repository navigation
Getting Started
mattbox03 edited this page Oct 23, 2026
·
1 revision
- An ESP32-S3 N16R8 board (16 MB flash, 8 MB octal PSRAM). See Hardware.
- A USB data cable and a desktop computer.
- A 2.4 GHz Wi-Fi network for the uplink.
- A Tailscale account or a Headscale server — only for tailnet roles. Local administration and local Wake-on-LAN work without one.
- Install the firmware: Installation. The browser installer in desktop Chrome or Edge is the easiest route.
-
Set up the new board: join
ESP32-Tailnet-Setup-XXXX, pair with the BOOT button, choose an admin password and test your Wi-Fi — First Boot Setup. -
Open the gateway from your home Wi-Fi with a link shown on the last
setup page: the address its Wi-Fi test received, or
http://esp32-tailnet-xxxx.local/(xxxxis the code of its setup Wi-Fi). - Join the tailnet in the wizard or on the Tailscale page: login server (Headscale only), device name and an auth key. Review node expiry and route approval in your tailnet admin according to your policy.
-
Start with one role — usually the Service Gateway: reserve the
ESP32's LAN address in your router, add a rule under
Network → LAN → Tailnet, restrict the source to the client (
/32), press Test destination, then enable the rule.
- Keep a configuration backup (Backup and Restore) before updates.
- Rules, routes, the exit node and integrations start off: enable only what you need.
- A connected control plane or a visible peer is not proof that a service is reachable. Use the destination test and the real client.
Full guide: GETTING-STARTED.md.
Start
Roles
- Service Gateway
- Subnet Router
- Exit Node
- Headscale
- Recovery and Wake-on-LAN
- Monitoring and Health
- Integrations
Operate
Reference
Project