twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks

ReverseProxyAdapter

A WebHook connection adapter that supports a reverse proxy in front of the listener.

Constructor

new ReverseProxyAdapter(options)

Creates a reverse proxy connection adapter.

Parameter Type Required Default Description
options ReverseProxyAdapterConfig none
options.hostName string none

The host name the reverse proxy is available under.

options.listenerPort number none

The port the server should listen to.

options.pathPrefix string none

The path prefix your reverse proxy redirects to the listener.

options.port number none

The port on which the reverse proxy is available.

options.ssl boolean none

Whether the reverse proxy supports SSL.

options.sslCert WebHookListenerCertificateConfig none

The SSL keychain that should be used to make the server available using a secure connection.

If this is not given and there is no reverse proxy that handles incoming SSL connections, the server will only be available via HTTP. This means it can only listen to unauthenticated topics (stream changes and follows).

options.sslCert.cert string none

Your SSL certificate.

options.sslCert.key string none

The private key of your SSL certificate.