Independent Deployment of FineReport on Tomcat (Linux)

Version

Application Scenario

Tomcat is a free and stable web application server that is popular among small and medium-sized enterprises.

Function Description

This document introduces how to deploy the FineReport project in the Tomcat container on the Linux system.

Note:

Compared with traditional deployment methods, containerized deployment keeps applications separate from each other, runs consistently across different environments, and makes it easier to change, scale, and manage services. This helps reduce maintenance and resource costs for enterprises. Therefore, you are advised to adopt containerized deployment.

Notes

This document takes the environment consisting of CentOS7, Tomcat 9.0.44, and JDK 1.8 as an example. As the commands may vary slightly depending on system and application versions, you need to make adjustments accordingly.

You need to install the JDK and Tomcat on the Linux system in advance. For the installation methods, you can refer to relevant resources. Technical support does not cover environment setup inquiries.

You cannot deploy multiple FineReport projects on a single Tomcat server.

The JDK version needs to be 1.8 with the minor version later than JDK 8u102.

Tomcat 10.0 is not supported.

You need to install the JDK and Tomcat on the Linux system in advance. For the installation methods, you can refer to relevant resources. Technical support does not cover environment setup inquiries.

Environment Setup

You need to prepare an appropriate server environment based on the user scale of the project. For details, see Supported Environment and Configuration for Standalone Project Deployment.

JDK Installation

When deploying FineReport independently, you need to prepare the JDK on your own.

Procedure	Description
Version	JDK 1.8 with minor versions later than JDK 8u102 is supported.
Downloading the JDK	1. Run the command to check the server system architecture: uname -m. 2. Download the correct JDK installation package: JDK. Note:  The bit version of the JDK must match that of the operating system. Although a 32-bit JDK can be installed on a 64-bit system, FineReport does not allow this configuration. In view of this, the bit versions of them must match. 3. Place the downloaded JDK installation package on the Linux server.
Installing the JDK	For installation instructions, you can refer to the official JDK documentation. Example command to extract the Tomcat installation package to the data directory:  tar -zxvf jdk8.0.202-linux_x64.tar.gz -C /data
Verifying if the installation is successful	Command: java -version Return result: If version information is returned, the JDK has been installed successfully.

Tomcat Installation

When deploying FineReport independently, you need to prepare Tomcat on your own.

1. Downloading and installing Tomcat.

# tar -zxvf apache-tomcat-8.5.51.tar.gz -C /data

Obtaining the Project File

1. Paid users can contact FanRuan technical support to obtain the corresponding webroot project files. For details about how to contact technical support, see Technical Support Channel Introduction.

2. Free users can refer to Designer Installation to install the designer, and obtain the required webroot project files in the path FineReport installation directory/webapps.

Copying the Project File

1. Compress the obtained webroot folder.

2. Place the compressed file in the path Tomcat installation directory/webappson the server.

3. Run the commands to extract the compressed file:

cd /data/tomcat/webapps

unzip webroot.zip

Configuring the Parameter (Optional)

The web application server for deploying the FineReport project must meet specific configuration requirements.

If the web application server does not meet the project requirements, downtime issues may occur.

You are advised to configure the required parameters before starting the Tomcat server.

Note: 

You need to pay special attention to JVM-related setting items first. Other settings can be verified after the project is started.

Modifying the Port Number (Optional)

If multiple Tomcat instances are running on the Linux system, you need to check whether the default port 8080 is already in use. If no project has been deployed on the server before, you can skip this section.

1. You can use the command to check if the default port 8080 is already in use:

netstat -anp |grep 8080

2. If it is in use, you need to modify the Tomcat port number. For details, see Tomcat Port Configuration.

Starting Tomcat

1. Enter the bin directory. (You need to modify the path in the following command to the actual path.)

cd /data/tomcat/webapps

2. Start Tomcat.

./startup.sh

2. Check the real-time log. If the consumed time is displayed in the log, the project has been started successfully.

cd /data/tomcat/webapps

tail -f catalina.out

Note: 

If the error message "Database is not initialized" is displayed after Tomcat is started, you need to check your read/write permissions. You can configure the permissions using the command chmod -R 777 tomcat.

Accessing the Decision-making Platform

Enter the URL http://IP address:Port number/Project name/decision in a browser. If the initial configuration page of FineReport is opened, the deployment is successful, as shown in the following figure.

Note:

1. In the URL, the default port number of Tomcat is 8080, and the default project name is webroot.

2. The username and password are those of the copied project in the "Obtaining the Project File" section. If the project has never been logged in to before, you will enter the initial configuration page directly.