Setup

Get the VPS and Home Agent paired.

Start with the VPS, then claim it from the Home Agent UI, then add phone or laptop devices.

Step 1

Run the VPS setup command over SSH.

Use this for a blank Debian or Ubuntu VPS, or run it again later and choose the update path.

Recommended VPS command

curl -fsSL https://raw.githubusercontent.com/TaterTotterson/Tater_Tunnel/main/scripts/tater-vps-setup.sh \
-o /tmp/tater-vps-setup.sh && sudo bash /tmp/tater-vps-setup.sh

Step 2

Pick the installer path.

Blank VPS full install

Installs the VPS Agent, WireGuard, Caddy automatic HTTPS, and UFW rules. Best for a new VPS.

80/tcp443/tcp51888/udp

Advanced existing VPS

Installs only the VPS Agent. The user manages HTTPS reverse proxy and firewall rules.

Webmin friendlyManual proxy

Update existing install

Downloads the latest code, preserves pairing/state, keeps the current service host/port, and restarts the service.

Safe updateKeeps state

Step 3

Start the Home Agent and claim the VPS.

For remote testing or a LAN-accessible machine, bind the Home Agent to all interfaces. In normal local use, 127.0.0.1 is enough.

Home Agent

python3.11 -m tater_tunnel.home_agent --host 0.0.0.0 --port 4173

VPS IP or Domainhttps://tunnel.example.com

Pairing Codeshown by the installer

Security Modestandard

Step 4

Add a phone or laptop.

Use the Home Agent device section to create a profile, scan the QR in the WireGuard app, then test the relay health route from the device.

Open from the connected device

http://10.88.0.1:4174/api/health
http://10.88.0.1:4174/relay/api/state

Service checks

Useful VPS commands after install.

VPS checks

sudo systemctl status tater-tunnel-vps
sudo journalctl -u tater-tunnel-vps -f
sudo systemctl restart tater-tunnel-vps
sudo wg show tater0

Tater mascot beside a secure VPS — Caddy handles public HTTPS. The raw agent service stays local or VPN-only.