Skip to content

Type Alias: TunnelOptions

TunnelOptions = z.output<typeof TunnelOptionsSchema>

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.