Skip to content
dbx tools

Interface: TunnelInterceptorOptions

Options for tunnelInterceptor (each also resolvable from env).

Properties

Section titled “Properties”

frpProtocol?

Section titled “frpProtocol?”

optional frpProtocol?: string

frpc transport protocol. Env FRP_PROTOCOL; defaults to wss.

frpProxyName?

Section titled “frpProxyName?”

optional frpProxyName?: string

frp proxy registration name. Env FRP_PROXY_NAME.

frpPublicDomain?

Section titled “frpPublicDomain?”

optional frpPublicDomain?: string

FRP public HTTP host. Env TUNNEL_FRP_PUBLIC_DOMAIN.

frpServer?

Section titled “frpServer?”

optional frpServer?: string

frps control host; defaults to the FRP public domain. Env FRP_SERVER.

frpServerPort?

Section titled “frpServerPort?”

optional frpServerPort?: number

frps control port. Env FRP_SERVER_PORT; defaults to 443.

frpToken?

Section titled “frpToken?”

optional frpToken?: string

frps auth token. Env FRP_TOKEN (or TUNNEL_TOKEN).

port?

Section titled “port?”

optional port?: number

The PUBLIC port portr forwards to - the port the app itself listens on. Defaults to the Databricks Apps runtime contract DATABRICKS_APP_PORT (then 8000), which is the port the platform routes to.

publicDomain?

Section titled “publicDomain?”

optional publicDomain?: string

Public host to serve on. Env TUNNEL_PUBLIC_DOMAIN.

subdomain?

Section titled “subdomain?”

optional subdomain?: string

portr subdomain (else derived from publicDomain).

transport?

Section titled “transport?”

optional transport?: TunnelTransport

Tunnel clients to run. Env DBX_TOOLS_TUNNEL_TRANSPORT; defaults to portr.