Supported Environments for Standalone Project Deployment

This article introduces the supported environments and requirements for FineReport deployment.

Note:

1. This article lists all the supported deployment environments. For details about the most suitable deployment environment for you, see Recommended Environment for Project Deployment.

2. This article lists the environments that have passed FineReport's test.

Lower versions not mentioned in this article are not supported by default.

You can test higher versions not mentioned in this article by yourself. If there are any problems, paid users can contact technical support for assistance. You can go to Service > Online Support, or call at 400-811-8890.

3. For external database components, this article only lists the supported versions. For details about specific deployment methods, it is recommended to query in the corresponding vendor's documents.

Server Operating System

It is recommended to use Linux operating system to deploy FineReport and external database components. Recommended versions:

• System version: CentOS 7.3/Ubuntu 18.04.4 and above

• System kernel version: 3.10 and above

• System architecture version: X86_64

Note: For details about the comparison analysis of Linux and Windows, see Comparison Analysis of Linux and Windows.

Preparing Server Port

1. There are multiple middlewares, and you can open the ports as needed.

2. For details about port occupation, see Viewing Port Usage. 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, you need to modify Tomcat port number to prevent port conflict. For details, see Modifying Tomcat Port Number.

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

• For details about the steps to open ports on Windows system, see Setting Inbound and Outbound Rules on Windows Server.

• For details about the steps to open ports on Linux system, see Linux Firewall Usage and Configuration.

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

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

• Choosing UDP protocol means using random ports between 45588 and 65536.

Server Network Requirements

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

2. Communication is required between project nodes and external databases. Ping statements can be used to test the connectivity.

Server Deployment Requirements

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

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

It is recommended to prepare different quantities and configurations of project nodes based on the project concurrency, as shown in the table below:

Note: It is recommended cthat the JVM memory for the project node server should be more than 8 GB, but not exceed 32 GB, because too large JVM memory may cause long FullGC time for the system.

Note:

1. User dimension explanation:

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

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

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

2. Configuration explanation:

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

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

Server Disk Space

Other Requirements for Server

Requirements for Middleware

For containerized deployment or deployment package deployment, you do not need to prepare the content of this section, as FineReport has built-in JDK and application server. The built-in JDK is OpenJDK.

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

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.

1. Notes for Middleware Deployment

• If you need to run FineReport/FineBI on Docker container, make sure that the memory is more than eight GB.

• It is recommended to use the unzipped Tomcat and JDK.

• You cannot deploy multiple FineReport projects on a middleware.

• If multiple Tomcats are installed in the environment, it is not recommended to for you to configure CATALINA_HOME or TOMCAT_HOME in the environment variable. Otherwise, no matter which Tomcat you start, the one specified by CATALINA_HOME is started.

• For Tomcat version 7.0.100, you need to place web.xml in directory %Tomcat_HOME%\webapps\webroot\WEB-INF, or an error will occur.

2. Notes for JDK Installation in Windows System

• There must be environment variable JAVA_HOME, and Path must have directory %JAVA_HOME%\bin and directory %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 it will pop up: fine assist start failed when Tomcat is started.

Application Project Preparation

For containerized deployment or deployment package deployment, you do not need to prepare the content of this section, as FineReport has a new built-in project.After deploying the new project, you need to set the username and password for platform login by yourself.

Independent deployment requires preparation of the content in this section.

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

• You need to prepare the project in advance, either an existing project or downloading the latest project.

• 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 platform attributes configuration, all information in the decision-making platform, including directory tree settings, template scheduled task information, etc., is stored in a single database.

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

It is recommended to configure external database for formal project.

Server Deployment Requirements

The occupation space needs to be adjusted according to the usage rate. It can be configured based on the size of the webapps/webroot/WEB-INF/embed/finedb folder, and the estimated future usage size can be increased by 1 – 2 times based on the actual size.

External database should be on the same subnet as the project to avoid network fluctuations.

 Database Type

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