TwurpleAuthenticationGetting dataExamplesFAQMigration

ReverseProxyAdapterConfig

The configuration of the reverse proxy connection adapter.

{
The host name the reverse proxy is available under.
hostName: string
The path prefix your reverse proxy redirects to the listener.
pathPrefix?: string
The port the server should listen to.
port?: number
Whether the path prefix is passed to the handler.
}

Properties

hostName

Type: string

The host name the reverse proxy is available under.

pathPrefix

Type: ?string

The path prefix your reverse proxy redirects to the listener.

port

Type: ?number

The port the server should listen to.

If not given, defaults to 8080.

usePathPrefixInHandlers

Type: ?boolean

Whether the path prefix is passed to the handler.

Defaults to false which means that the layer redirecting to this server needs to strip the path prefix in order for it to work.

For example, if the path prefix is set to /hooks, an external connection to /hooks/abc should pass /abc as the path to this server.

Conversely, if this is set to true, the path should be passed as is (i.e. /hooks/abc).