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.

ParameterTypeRequiredDefaultDescription
optionsReverseProxyAdapterConfignone
options.hostNamestringnone

The host name the reverse proxy is available under.

options.listenerPortnumbernone

The port the server should listen to.

options.pathPrefixstringnone

The path prefix your reverse proxy redirects to the listener.

options.portnumbernone

The port on which the reverse proxy is available.

options.sslbooleannone

Whether the reverse proxy supports SSL.

options.sslCertWebHookListenerCertificateConfignone

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

Your full SSL certificate chain, including all intermediate certificates.

options.sslCert.keystringnone

The private key of your SSL certificate.