What you'll find here
Documentation is organized by operator task. Start with the installer guide that matches your product, then use the reference pages as needed.
- Install IPTunnel — the full stack installer with zero-touch and client-token paths.
- Install SlowDNS — the public GitHub installer with private license activation including prompts, expected output, retry behavior, and environment variable overrides.
- Activation Lifecycle — a detailed walkthrough of
issue_code,precheck,activate,confirm, andrelease. - DNS Layout — the exact A and NS records you need and how to verify them.
- Environment Variables — every
SLOWDNS_*variable the installer accepts for unattended or scripted deployments. - Rate Limits — the public-code issuance controls, browser-session requirements, and activation throttles.
- Troubleshooting — specific error codes, their causes, and exact commands to diagnose them.
- API Reference — all routes with request and response examples.
Prerequisites
All paths require:
- An Ubuntu 20.04 / 22.04 / 24.04 VPS with a root shell.
- A reachable public IPv4 address on the VPS.
- Outbound HTTPS to this license server and to GitHub.
- For SlowDNS specifically: a domain you control with the ability to add
AandNSrecords.
Debian 11/12 works but is not the primary test target. Other distros are not supported.
Choose the right installer
| Scenario | Use |
|---|---|
| Full IPTunnel stack | IPTunnel installer |
| Standalone SlowDNS only | SlowDNS installer |
| VPS IP is already known in advance | Zero-touch authorization |
| Installing for a specific client account | Client-token install |