Supported Environment and Configuration for Standalone Project Deployment

This document introduces the supported environment and requirements for FineReport deployment.

Note:

1. This document lists all the deployment environments supported.

2. This document lists the environments that have passed FineReport's test. Older versions not mentioned in this document are generally not supported by default or have some bugs (not recommended). You can test later versions not mentioned in this document by yourself. For any problem, paid users can contact our technical support for assistance.

3. Regarding external database components, this document only lists the supported versions. For details about deployment methods, you are advised to query the corresponding vendor's documents.

Server Operating System

You are advised to use the Linux operating system to deploy FineReport and external database components. Recommended versions:

System version: Ubuntu 18.04.4 and above

System kernel version: 3.10 and above

System architecture version: X86_64

Server Port Perparation

1. There are multiple middleware. You can open the ports as needed.

2. If the default port conflicts with other projects, you need to modify the port before opening the corresponding port.

3. If you want to deploy multiple Tomcat projects on a server, modify the Tomcat port number to prevent port conflict.

4. If the firewall is enabled, you need to open the related port number.

5. For the Docker container or environments with strict port restrictions between servers, it is necessary to open ports between the servers of nodes for inter-node communication.

Choosing the TCP protocol means using eight ports: 7800/7810/7820/7830/7840/7850/7860/7870.

Choosing the UDP protocol means using random ports that range from 45588 to 65536.

Server Network Requirements

1. FineReport and external database components can be deployed in both public and private network environments.

2. Communication is required among project nodes and external databases. You can use the ping command to test the connectivity.

Server Configuration Requirements

FineReport supports both standalone and cluster deployments, with the cluster consisting of multiple project nodes.

Each node is an independently runnable project for processing user requests, generating reports, and managing other components.

You are advised to prepare different quantities and configurations of project nodes based on the project concurrency, as shown in the following table.

Note:

It is recommended that the JVM memory for the project node server be over 8 GB, but not exceed 32 GB, because too large JVM memory may cause a long FullGC time for the system.

Note:

1. User dimension explanation:

Number of registered users: number of users registered in the system.

Number of online users: number of users who are concurrently online in a certain period of time (generally between 5% and 20% of the number of registered users).

Number of concurrent users: number of users who concurrently send requests to the server (generally between 10% and 25% of the number of online users).

2. Configuration explanation:

Recommended configuration: The average response time in 70% of scenarios is less than three seconds.

Minimum configuration: The average response time in 70% of scenarios is less than five seconds.

Server Disk Space

Other Requirements for the Server

Requirements for Middleware

For containerized deployment or deployment package deployment, there is no need to prepare the content of this section, as FineReport has built-in JDKs and an application server. The built-in JDK are OpenJDKs.

Independent deployment requires preparation of the content in this section. You need to prepare the application server and JDK by yourself.

FineReport is a pure Java Servlet application, which should be deployed in such middlewares as Tomcat, WebLogic, and WebSphere.

When you start the middleware, FineReport will be loaded and the project can operate normally.

Middleware	Middleware Version	JDK Version
Tomcat	You are advised to use the latest version of Tomcat 8. Note: Using the recommended version will reduce safety issues caused by low Tomcat versions. Tomcat 8.5 ~ 9.0 are supported. Tomcat 10.0 is not supported.	JDK 1.8 and the minor version needs to be JDK 8u102 or higher. Note: 1. If the JDK version does not meet the requirement, problems may occur when you start the deployment. 2. The JDK version must correspond to the operating system, for example, the 32-bit system can only operate with 32-bit JDK. 3. OpenLogic OpenJDK is not supported.
WebLogic	Weblogic12.2.1.X Weblogic14.X
WebSphere	WebSphere8.5.X WebSphere9.0.X
Wildfly(Jboss)	You are advised to use Wildfly27.0.0 Final and the later versions. Note: Using the recommended version will reduce safety issues caused by old Wildfly versions. JBoss 6 and higher versions
Resin	Resin-4.0.58

1. Notes for Middleware Deployment

If you need to run FineReport/FineBI on the Docker container, ensure the memory is over eight GB.

You are advised to use the decompressed Tomcat and JDK.

You cannot deploy multiple FineReport projects on a middleware.

If you install multiple Tomcats in the user environment, you are not advised to configure CATALINA_HOME or TOMCAT_HOME in the user environment variable. Otherwise, no matter which Tomcat you start, only the one specified by CATALINA_HOME will be started.

2. Notes for JDK Installation in Windows System

There must be an environment variable JAVA_HOME, and Path must have directories%JAVA_HOME%\bin and %JAVA_HOME%\jre\bin.

If there is no attach.dll file in directory %JRE_HOME%/bin to which the environment variable points, you need to copy the attach.dll file in directory %JAVA_HOME%/jdk/jre/bin to directory %JRE_HOME%/bin, or an error message "fine assist start failed" will be displayed when Tomcat is started.

Application Project Preparation

For containerized deployment or deployment package deployment, there is no need to prepare the content of this section, as FineReport has a brand new built-in project. After deploying the new project, set the username and password for the platform login.

Independent deployment requires preparation of the content in this section.

The Webroot folder in the directory %FR_HOME%\webapps is required for project deployment.

Prepare the project in advance, either using an existing project ordownloading the latest one.

If you use an existing project for deployment, make sure the username and password for platform login are those of the existing project.

Except for the platform attribute configuration, all information in the decision-making platform, including directory tree setting and template scheduled task information, is stored in a single database.

The database stores and manages various configuration information of the project node, ensuring the consistency of configurations across all nodes and facilitating centralized management of project metadata by the administrator.

You are advised to configure an external database for the formal project.

Server Configuration Requirements

Note 1: You need to modify the occupied space according to the usage rate. You can configure the space to be one to two times larger than the size of the finedb folder in webapps/webroot/WEB-INF/embed (estimated size based on the actual size).

Note 3: The external database should be in the same network segment as the project to avoid network fluctuations.

Database Type Requirements

Non-containerized deployment requires preparation of the content in this section. Containerized deployment does not require preparation of the content in this section.