warp
Sign InSign Up

Documentation

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

Configuration

Create a config.toml file to define your server address and tunnels.

server = "your-server:9000"

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

[my-game]
secret_key = "another_64char_hex_key"
port = 25565
  • server — server address (required)
  • [name] — TOML section = tunnel name (must match the name created in the dashboard)
  • secret_key — tunnel authentication key from the dashboard (required)
  • port — local forwarding port (required)

Foreground Mode

Run the client directly to test your tunnel connection.

$ ./warp-client -c config.toml

Service Mode

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

Tunnel Addresses

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

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