Skip to content
This page was translated with AI and may contain inaccuracies. Help improve it on GitHub.

Tutorials ​

Each tutorial starts from a concrete goal and walks you through the admin UI step by step, with ways to check the result and common problems. If Gately isn't installed yet, start with Installation. To look around first, open the online demo and use the one-click read-only demo account (data resets every hour).

Screenshots come from a demo instance; domains and addresses are example values (example.com, 192.0.2.x, 203.0.113.x). Replace them with your own.

Real-world setups ​

01Reach a NAS without a public IPv4 addressHow to reach a NAS from outside without a public IPv4 address. Four routes compared (IPv6 with DDNS, STUN, frp on your own VPS, Cloudflare Tunnel), with prerequisites, trade-offs and the Gately setup steps for each.20 min02Run everything on one port 443Use Gately protocol routing to share one port 443 between HTTPS sites, SSH and RDP while keeping the visitor's real IP. Steps, test commands and troubleshooting.15 min03HTTPS and sign-in for Jellyfin, Immich, Home Assistant and VaultwardenPut HTTPS and sign-in in front of Jellyfin, Immich, Home Assistant and Vaultwarden with Gately. WebSocket, large uploads and the WAF body limit, trusted-proxy settings, and what to do when web authentication blocks the mobile apps.20 min04Wildcard certificate and DDNS in 10 minutesSet up dynamic DNS and a wildcard HTTPS certificate with Gately in about ten minutes, with a Cloudflare version and an Alibaba Cloud version. DNS-01 validation needs no open port 80 or 443, and renewal is automatic.10 min05Migrate from nginx or Nginx Proxy ManagerMigrate from nginx or Nginx Proxy Manager to Gately. Import nginx -T output (run inside the container for NPM), verify alongside nginx, switch over site by site and roll back, with what each NPM setting becomes.30 min06Replace haproxy, nginx, fail2ban and acme.sh on a cloud serverReplace haproxy, nginx, fail2ban and acme.sh on a cloud server with one Gately process. Side-by-side mapping, migration order, rollback, and the like-for-like benchmark numbers from the README.40 min

More tutorials, from the basics to advanced topics, are available in Simplified Chinese and will be translated. Every feature is also described in full under Modules.

Released under the Apache-2.0 license.