Documentation
Everything about installing, configuring, and running hwsd. Looking for step-by-step tutorials? Check the guides.
AllGetting startedConceptsDatabaseCLI & configTroubleshooting
Getting started
Install hwsd
Windows .exe, macOS .pkg, Linux binary + systemd — pick your OS
→
Sign in & device pairingEmail one-time codes, device tokens, what gets stored
→
The setup wizardFolder picker, slug rules, cache modes, PHP toggle, review
→
Concepts
How the tunnel works
Outbound-only connections, NAT/CGNAT traversal, the relay protocol
→
Caching modesLive Editing, Balanced, High-cache — invalidation & ETags
→
File sandboxingPath containment, symlink resolution, the sensitive-file blocklist
→
Slugs & URL structureSlug rules, reserved routes, trailing-slash redirects
→
Database
Local MySQL via PHP
mysqli/PDO to 127.0.0.1 — XAMPP, MySQL or MariaDB on your own machine
→
SQLite sitesZero-setup file databases via pdo_sqlite — and the public-download caveat
→
CLI & config
Troubleshooting