Skip to content

Interface: ProxyOptions

appPort: number

The private loopback port the wrapped app listens on.


optional bindHosts?: readonly string[]

Addresses to listen on. Defaults to a single 0.0.0.0 (every interface), the portr/platform case. Pass specific interface IPs to expose the gate on only those - e.g. an overlay/LAN address while loopback reaches the upstream directly and ungated.


optional brandName?: string

Brand name for the hosted login page shown on a denied browser navigation.


optional forwardHeaders?: readonly string[]

Extra x- headers tunnel traffic may forward.


optional gate?: AuthGateApi

The gate handlers. Omitted (an --insecure run) forwards everything.


optional gatePaths?: readonly string[]

Path prefixes to gate beyond /api/ (e.g. /ws for a WebSocket app).


publicPort: number

The port this proxy listens on - the port portr and the platform route to.