Configure the Pubsub Daemon

The Pubsub daemon offers enhanced streaming, notification and real-time messaging performance within Clarive when configured.

Note

The Pubsub daemon is necessary so that the job monitor, job log streaming and topic auto-refresh works.

By default, the Pubsub daemon is started when the Clarive web server (command: cla web-start) starts, you need to add the necessary code to the YAML file that you call when starting the Clarive web server. You can find details of this file in the Clarive configuration file.

Copy the following code and paste it into the aforementioned YAML file, being sure to set enabled: to '1', and change [Clarive address] for address: to the IP address you use to access Clarive, and [Pubsub port] to a free port (your system administrator will provide this number). [Clarive address] and [Clarive port] in headers: should be the same as those used when accessing Clarive:

pubsub:
    enabled: 1
    address: [Clarive address]:[Pubsub port]
    headers:
        - 'Access-Control-Allow-Origin'
        - '[Clarive address]:[Clarive port]'

In order to start the service see cla pubsub - Pubsub daemon management.

Working though reverse proxies or front-end server

If your Clarive server is behind a corporate reverse proxy or similar arrangement, your pubsub server may not work due to interference or misconfiguration.

Please make sure the following Nginx (or equivalent) reverse proxy parameters are configured at any front-end middleware or server:

    location /pubsub {
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header Connection '';
        add_header X-Accel-Buffering no;
        proxy_cache off;
        proxy_http_version 1.1;
        chunked_transfer_encoding off;
    }

When the pubsub channels are not working, the client browser will have streaming blocked and empty responses from the server.