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.

ParameterTypeDescription
optionsReverseProxyAdapterConfig
options.hostNamestring

The host name the reverse proxy is available under.

options.listenerPortnumber

The port the server should listen to.

options.pathPrefixstring

The path prefix your reverse proxy redirects to the listener.

options.portnumber

The port on which the reverse proxy is available.

options.sslboolean

Whether the reverse proxy supports SSL.

options.sslCertWebHookListenerCertificateConfig

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.certstring

Your SSL certificate.

options.sslCert.keystring

The private key of your SSL certificate.