Skip to content
dbx tools

Variable: TunnelOptionsSchema

const TunnelOptionsSchema: ZodObject<{ allow: ZodOptional<ZodPipe<ZodTransform<unknown, unknown>, ZodArray<ZodString>>>; appPort: ZodOptional<ZodCoercedNumber<number>>; bindHosts: ZodOptional<ZodPipe<ZodTransform<unknown, unknown>, ZodArray<ZodString>>>; brandName: ZodOptional<ZodString>; codeTtlSeconds: ZodOptional<ZodCoercedNumber<number>>; forwardHeaders: ZodOptional<ZodPipe<ZodTransform<unknown, unknown>, ZodArray<ZodString>>>; frpProtocol: ZodOptional<ZodString>; frpProxyName: ZodOptional<ZodString>; frpPublicDomain: ZodOptional<ZodString>; frpServer: ZodOptional<ZodString>; frpServerPort: ZodOptional<ZodCoercedNumber<number>>; frpToken: ZodOptional<ZodString>; gatePaths: ZodOptional<ZodPipe<ZodTransform<unknown, unknown>, ZodArray<ZodString>>>; insecure: ZodOptional<ZodBoolean>; message: ZodOptional<ZodString>; port: ZodOptional<ZodCoercedNumber<number>>; publicDomain: ZodOptional<ZodString>; sessionCutoff: ZodOptional<ZodString>; sessionTtlSeconds: ZodOptional<ZodCoercedNumber<number>>; sqlitePath: ZodOptional<ZodString>; storage: ZodOptional<ZodEnum<{ auto: "auto"; lakebase: "lakebase"; sqlite: "sqlite"; }>>; subdomain: ZodOptional<ZodString>; subject: ZodOptional<ZodString>; transport: ZodOptional<ZodEnum<{ both: "both"; frp: "frp"; portr: "portr"; }>>; }, $strict>

TunnelOptions fields

Section titled “TunnelOptions fields”

Public tunnel wrapper command-line options.

  • transport (optional): Public tunnel transport.
  • publicDomain (optional): Public tunnel domain.
  • subdomain (optional): Portr subdomain.
  • port (optional): Public listener port.
  • appPort (optional): Private wrapped application port.
  • allow (optional): Email allow-list patterns.
  • subject (optional): Verification email subject.
  • brandName (optional): Verification email brand name.
  • message (optional): Verification email message.
  • sessionTtlSeconds (optional): Session lifetime in seconds.
  • codeTtlSeconds (optional): One-time-code lifetime in seconds.
  • sessionCutoff (optional): Invalidate sessions issued before this value.
  • storage (optional): Authentication database mode.
  • sqlitePath (optional): Local authentication SQLite file.
  • forwardHeaders (optional): Additional forwarded request header patterns.
  • gatePaths (optional): Additional path prefixes requiring authentication.
  • bindHosts (optional): Interface IPs the gate listens on.
  • insecure (optional): Run without an authentication gate.
  • frpServer (optional): FRP control host.
  • frpPublicDomain (optional): FRP public HTTP domain.
  • frpServerPort (optional): FRP control port.
  • frpProtocol (optional): FRP transport protocol.
  • frpToken (optional): FRP authentication token.
  • frpProxyName (optional): FRP proxy registration name.