Container-Native WebSocket Solution

Version

Application Scenario

To simplify WebSocket configuration, starting from the FineReport project of V11.0.2 and later versions, a container-native WebSocket solution has been added.

This solution uses the WebSocket implementation built into the Web container for connection, reusing the HTTP port. No additional port or manual configuration is required.

When the project supports the container-native WebSocket solution, the client tries the solution first. If the connection attempt fails, it falls back to the old socket.io solution.

The container-native WebSocket solution requires the following prerequisites.

Container Environment Check

The container-native WebSocket solution is only supported for the following containers.

<!--Modify the web-app element as follows-—
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://xmlns.jcp.org/xml/ns/javaee"
   xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
   id="WebApp_ID" version="3.1">

<?xml version="1.0" encoding="UTF-8"?>
<!--Enable WebSockets -->
<jboss-web>
   <enable-websockets>true</enable-websockets>
</jboss-web>

If the container hosting the project meets the prerequisites, WebSocket Settings will not appear under Management System > System Administration > General on the decision-making platform.

Load Balancer Configuration

nginx

1. Modify the HTTP configuration.

Add the following directives to every location block:

proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $http_connection;

2. Check whether nginx has been configured for WebSocket connections.

Open the nginx.conf file and check if it contains the following content.

server { 
        #WebSocket port. In clustered deployments, FineReport projects use 38889, and FineB projects use 48889.
        listen 38889;             
        server_name 192.168.6.181;
        location / {
             proxy_http_version 1.1;
             proxy_pass http://WBS.com;
             proxy_connect_timeout 75;
             proxy_read_timeout 400;
             proxy_send_timeout 400;
             #Target protocol to upgrade to; $http_upgrade resolves to websocket in this example.
     proxy_set_header Upgrade $http_upgrade;
             #Set Connection to "upgrade" to enable the Upgrade header.
     proxy_set_header Connection "upgrade";
             }
        }

If the above content does not exist, it indicates that nginx has not been configured for WebSocket connections. You can directly use the container-native WebSocket solution.

If the above content exists, it indicates that nginx has been configured for WebSocket connections. You need to delete the above content, as shown in the following figure. 

Traefik

No additional configuration is required. Retaining or deleting the original WebSocket configuration does not affect the implementation of the container-native WebSocket solution.

F5

No additional configuration is required. Retaining or deleting the original WebSocket configuration does not affect the implementation of the container-native WebSocket solution.

Browser Environment

• The container-native WebSocket solution is supported by browsers including Google Chrome, Firefox, Microsoft Edge, and Internet Explorer 10 and later versions.

• It is not supported by Internet Explorer 9 and earlier versions.