Table of contents

Buffering

Most reverse proxy servers buffer data before sending it to the client. This causes SSE streams to only emit events when a certain amount of data has been collected by the proxy.

Blueriq offers a Server Sent Event stream starting with Blueriq 12.4, so the reverse proxy should be configured to not buffer the stream, otherwise undefined behavior may occur.

Endpoint

The endpoint that sends Server Sent Event streams is : /<context root>/server/api/v2/push-messages.

Responses from this endpoint should not be buffered.

Examples

NginX

Specify proxy_buffering off; in your NginX configuration file.

IIS

In the Advanced Request Routing section, set 'Response Buffer Threshold' to 0 KB. Additionally, disable 'Disk Caching'.

Using the Runtime combined with a reverse proxy server

When there is a reverse proxy server between the client and the application server (for example Tomcat) serving the REST API, additional configuration is required. The reverse proxy server (for example Microsoft IIS) needs to add HTTP headers to the API requests being forwarded to the application server. The header 'X-Forwarded-Host' should be filled with the host name of the application server. The header 'X-Forwarded-Proto' should be filled with the protocol (for example 'https') the client used to connect to the reverse proxy. When using the installer, the installed reverse proxy will pass the correct HTTP headers by default.