Tunneling

Overview

Managed tunnels (FRP) to expose local or private HTTP services with tokens, frpc.toml download, rotate-token, and usage.

API

{pe} = /projects/{projectId}/environments/{environmentId}.

MethodPathNotes
GET/tunneling/healthHealth
POST/tunneling/frp/plugin/{pluginKey}FRP plugin; shared-secret plugin key
GET/POST/tunneling{pe}/tunnelsAPI key or owner JWT
GET/PATCH/DELETE/tunneling{pe}/tunnels/{tunnelId}API key or owner JWT
POST/tunneling{pe}/tunnels/{tunnelId}/rotate-tokenRotate
GET/tunneling{pe}/tunnels/{tunnelId}/frpc.tomlClient config
GET/tunneling{pe}/usageUsage

Clients

PackageRuntime
@vijihub/tunnelingserver

Implementation

  1. Enable Tunneling on the environment.
  2. Create a tunnel; download frpc.toml and run frpc with the issued token.
  3. Optionally point AI/STT/TTS (or other) provider base URLs at the tunnel’s public URL from Console provider settings.
  4. Rotate tokens if leaked; update local frpc config.

Constraints

  • FRP plugin endpoint uses a separate plugin key — not a project API key.
  • Tunnel CRUD requires API key or owner JWT.
  • Treat tunnel tokens like secrets; rotate on compromise.
  • Usage is metered via GET …/usage.