Documentation

Learn how to install, configure, and manage the warp client.

Configuration

Create a config.toml file to define your tunnels.

log_dir = "logs"

[my-web]
tunnel_id = "your_64char_hex_key_here"
port = 8080

[my-game]
tunnel_id = "another_64char_hex_key"
port = 25565

log_dir — log directory path — hourly log files (YYYY_MM_DD_HH.log) are created automatically (optional)
[name] — TOML section = tunnel name (must match the name created in the dashboard)
tunnel_id — tunnel ID from the dashboard (required)
port — local forwarding port (required)

Run the client directly to test your tunnel connection.

$ ./warp-client -c config.toml

Install the client as a system service for automatic startup.

Install as a system service

$ ./warp-client service install -c config.toml

Start the service

$ ./warp-client service start

Stop the service

$ ./warp-client service stop

Restart the service

$ ./warp-client service restart

Check service status

$ ./warp-client service status

Remove the service

$ ./warp-client service uninstall

Once connected, your tunnel is accessible via two address types.

{name}.go-warp.app	TLS traffic (HTTPS, etc.) — routed by SNI subdomain
go-warp.app:{port}	Plain TCP traffic (games, RDP, SSH, etc.) — routed by dedicated port