Enable universal and document co-browsing
In order to be able to use universal co-browsing and/or document sharing in an unblu collaboration server running on your application server, the unblu/renderingservice appliance is required.
This page describes how the unblu/renderingservice appliance is installed, configured and made known to the unblu collaboration server.
The unblu/renderingservice appliance is based on docker https://www.docker.com. In order to install and run the unblu/renderingservice appliance, you need a docker engine installation where you can start a container from the unblu/renderingservice docker image available on docker hub( https://hub.docker.com/r/unblu/renderingservice).
For more information on how to install and run a docker engine please visit https://docs.docker.com.
2.2. Unblu collaboration server
The unblu/renderingservice appliance is a helper appliance that augments the unblu collaboration server with additional capabilities (universal co-browsing and document sharing) hence you need to have an unblu collaboration server installed in order to make use of the unblu/renderingservce virtual appliance. Please read Setting up enterprise On Premise for more information on how to install, configure and run the unblu collaboration server on the application server of your choice.
2.3. Network connectivity
Enabling universal co-browsing and or document sharing using the unblu/renderingservice adds the following network connectivity requirements:
2.3.1. SSH unblu collaboration server to unblu/renderingservice
The unblu collaboration server must be able to connect to the unblu/renderingservice using the SSH protocol on a tcp port on the docker host that is mapped to the tcp port 22 in the unblu/renderingservice container.
2.3.2. HTTP(s) from the unblu/renderingservice to the unblu collaboration server
The unblu/renderingservice container must be able to connect to the unblu collaboration server using http(s) using the url provided in the com.unblu.hbworker.headlessBrowserReverseBaseUrl configuration property (see below).
The unblu/renderingservice uses the WebSocket protocol over the given HTTP(S) connection thus there should be no proxies on the way or they must also support the HTTP UPGRADE header and the WebSocket protocol.
2.3.3. HTTP(S) unblu/renderingservice to internet / intranet
If the unblu/renderingservice is used for universal co-browsing, then the unblu/renderingservice container needs to be able to access all web servers (using HTTP(S)) that need to be available in the universal co-browsing. Please note that this requirement does not apply, when the rendering service is only used for document co-browsing.
3. Configure and run the unblu/renderingservice appliance
The unblu/renderingservice appliance is installed / started using the docker command line tool with the following command:
This command creates and starts a container from the unblu/renderingservice image on the docker host.
The container can then be stopped using:
...and started again using:
The unblu/renderingservice docker image is stateless and does not store any persistent data thus it is also possible to use a transient container (create a new container on every start of the system) instead of using a persistent container.
4. Configure the unblu collaboration server to use the unblu renderingservice
Once the renderingservice is installed and started, the unblu collaboration server can be configured to use the renderingservice with the following configuration properties:
While the above block deals with the technical requirements to establish connections between unblu collaboration server and rendering service, the following property is required to enable universal and document co-browsing in unblu as a whole:
5. Test connectivity
Once docker has been started with
docker run (see above), try to connect from the collaboration server into docker as follows:
Within the docker image, you should also check, whether the connection back to the collaboration server works. For that purpose, make sure, the collaboration server has been successfully started. Once it is started, login to the docker image using ssh (see above) and execute:
Some other network diagnostic tools that may help to analyze problems, when you're connected with SSH into the unblu docker image