Confirming Server Configuration of the FineReport Project

User Volume

Number of FineReport system users

You can estimate it based on the number of employees.

Number of users sending requests to the FineReport system per minute

You can estimate it following Number of registered users * (0.5% to 5%).

Business Usage - Template Data Volume

Total number of template cells in all active sessions in the FineReport system

For multi-node clusters, this must be calculated based on the number of sessions across all nodes.

Business Usage - Data Entry

Main application server: 8-core CPU, 32 GB of memory, and 300 GB of disk space

It is used to deploy the FineReport application and components including Nginx (the internal gateway), MySQL (the configuration database), and Elasticsearch (the log storage service provider).

It is used to deploy all FineOps components.

It provides recommended elementary configuration for single-node projects.

1. FineReport main application server: 8-core CPU, 32 GB of memory, and 200 GB of disk space

It is used to deploy the FineReport application.

2. Server for FineReport components and FineOps: 8-core CPU, 32 GB of memory, and 300 GB of disk space

It is used to deploy the following components: Nginx, MySQL, and Elasticsearch.

It is used to deploy all FineOps components.

It provides recommended advanced configuration for single-node projects.

1. FineReport main application server: 16-core CPU, 64 GB of memory, and 200 GB of disk space

It is used to deploy the FineReport application.

2. Server for FineReport components and FineOps: 8-core CPU, 32 GB of memory, and 300 GB of disk space

It is used to deploy the following components: Nginx, MySQL, and Elasticsearch.

It is used to deploy all FineOps components.

It provides the optimal configuration for dual-node clusters.

1. FineReport main application server one: 16-core CPU, 64 GB of memory, and 200 GB of disk space

It is used to deploy the FineReport application.

2. FineReport main application server two: 16-core CPU, 64 GB of memory, and 200 GB of disk space

It is used to deploy the FineReport application.

3. FineReport component server: 4-core CPU, 16 GB of memory, and 300 GB of disk space

It is used to deploy the following components: Nginx, MySQL, Elasticsearch, and the cluster component.

4. FineOps server: 4-core CPU, 16 GB of memory, and 200 GB of disk space

It is used to deploy all FineOps components.

It provides the optimal configuration for multi-node clusters.

1. Number of main application servers: N (Number of registered users/4000)

Each main application server: 16-core CPU, 64 GB of memory, and 200 GB of disk space

Each main application server is used to deploy a FineReport application.

2. Component server: 8-core CPU, 32 GB of memory, and 500 GB of disk space

It is used to deploy the following components: Nginx, MySQL, Elasticsearch, and the cluster component.

3. FineOps server: 4-core CPU, 16 GB of memory, and 100 GB + 50 * N GB  of disk space

It is used to deploy all FineOps components.

Component to be installed

1. It is used to install the FineReport project as well as log and configuration components.

For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.

• FineReport

• Nginx

• MySQL (The self-provided component is supported.)

• Elasticsearch (The self-provided component is supported.)

• Filebeat

• Ops Agent

2. It is used to install FineOps.

For details about the role of FineOps components, see Understanding the Roles of FineOps Components.

Note:

If you have installed FineOps, skip this part. 

• Ops and Nginx

• Pushgateway, Prometheus, Grafana, and Alertmanager

• Elasticsearch and SkyWalking OAP

• Registry (The self-provided component is supported.)

• Ops Agent

Supported:

Ubuntu 18.04.4 and later releases (Ubuntu 20.04 is not supported.) 

CentOS 7.3 to 7.9

Red Hat 7.6 and later releases 

Rocky Linux 8.8 to 9.4

Note:

1. Since CentOS is discontinued, you are advised to use Ubuntu. 

2. When using Ubuntu, verify the user privilege (as the default root user is not a super administrator) and confirm that the disk type is XFS. For details, see notes in the following content.

CPU clock speed

Remaining free physical memory

The server shall have a partition with remaining free space of more than 300 GB.

Note:

There must be a single partition that meets the condition.

The disk read/write speed must be greater than 100 MB/s.

Mounting directory preparation

For details, see Preparing the FineReport Mounting Directory.

For details, see Preparing the FineOps Server.

Note:

It is forbidden to mount projects directly in the /, /usr, /root, /usr/local paths. You can create folders at these locations for mounting.

Otherwise, containers may fail to access these directories, leading to data loss or application startup issues.

Sharing the file system may cause performance degradation, file permission issues, and data inconsistency, affecting the reliability and response speed of applications running in the container.

Ensure the server has the tar command installed.                                               

The tar command is a commonly used tool for packaging and compressing files.

FineOps requires this command for file extraction.

Ensure the server has the sed command installed.     

The sed command is used for text processing. 

FineOps requires this command for text processing.

1. Using the root user (superuser) for project deployment and operation is preferred.

2. To use a non-root user for deployment and operation, see Linux User Privilege Explanation.

Note:

On Ubuntu, the default root user is not a superuser. Ensure that the user privileges meet the requirements.

At least 100 MB/s

At least 100 Mbps (12.5 MB/s)

Note:

1. As the concurrent volume of project sessions increases, scale resources accordingly.

2. External bandwidth requirements can be appropriately lowered if the connected business database and self-prepared components operate in the intranet environment. 

Component-used port and component port interconnection

For details, see Confirming the FineReport Server Network.

For details, see Preparing the FineOps Server.

Component to be installed

It is used to install the FineReport project.

For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.

• FineReport

• Filebeat

• Ops Agent

For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.

• Nginx

• MySQL (The self-provided component is supported.)

• Elasticsearch (The self-provided component is supported.)

• Ops Agent

2. It is used to install FineOps.

For details about the role of FineOps components, see Understanding the Roles of FineOps Components.

Note:

If you have installed FineOps, skip the content in this column.

• Ops and Nginx

• Pushgateway, Prometheus, Grafana, and Alertmanager

• Elasticsearch and Skywalking OAP

• Registry (The self-provided component is supported.)

• Ops Agent

The time on all servers must be synchronized, with a maximum difference of no more than 5 seconds.

Inconsistent server time can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies.

Time zone consistency

Inconsistent server time zones can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies.

Supported:

Ubuntu 18.04.4 and later releases (Ubuntu 20.04 is not supported.) 

CentOS 7.3 to 7.9

Red Hat 7.6 and later releases 

Rocky Linux 8.8 to 9.4

Note:

1. Since CentOS is discontinued, you are advised to use Ubuntu. 

2. When using Ubuntu, verify the user privilege (as the default root user is not a super administrator) and confirm that the disk type is XFS. For details, see notes in the following content.

CPU clock speed

Remaining free physical memory

The server shall have a partition with remaining free space of more than 200 GB.

Note:

1. There must be a single partition that meets the condition.

The server shall have a partition with remaining free space of more than 300 GB.

Note:

1. There must be a single partition that meets the condition.

2. The required disk space decreases if you use self-prepared components. 

If you use a self-provided Elasticsearch component, the required remaining free disk space on the server can be reduced by 100 GB. 

If you use a self-provided external configuration database component, the required remaining free disk space on the server can be reduced by 50 GB.

The disk read/write speed must be greater than 100 MB/s.

Mounting directory preparation

For details, see Preparing the FineReport Mounting Directory.

Note:

It is forbidden to mount projects directly in the /, /usr, /root, /usr/local paths. You can create folders at these locations for mounting.

For details, see Preparing the FineOps Server.

Note:

It is forbidden to mount projects directly in the /, /usr, /root, /usr/local paths. You can create folders at these locations for mounting.

Otherwise, containers may fail to access these directories, leading to data loss or application startup issues.

Sharing the file system may cause performance degradation, file permission issues, and data inconsistency, affecting the reliability and response speed of applications running in the container.

Ensure the server has the tar command installed.                                               

The tar command is a commonly used tool for packaging and compressing files.

FineOps requires this command for file extraction.

Ensure the server has the sed command installed.     

The sed command is used for text processing. 

FineOps requires this command for text processing.

Ensure you can connect to the FineOps server via the SSH protocol.

Ensure the password used for SSH connection contains no single English quotation marks, otherwise, the permission will fail to be validated during deployment.

1. Using the root user (superuser) for project deployment and operation is preferred.

2. To use a non-root user for deployment and operation, see Linux User Privilege Explanation.

Note:

On Ubuntu, the default root user is not a superuser. Ensure that the user privileges meet the requirements.

At least 100 MB/s

At least 100 Mbps (12.5 MB/s)

Note:

1. As the concurrent volume of project sessions increases, scale resources accordingly.

2. External bandwidth requirements can be appropriately lowered if the connected business database and self-prepared components operate in the intranet environment. 

Component-used port and component port interconnection

For details, see Confirming the FineReport Server Network.

For details, see Confirming the FineReport Server Network.

For details, see Preparing the FineOps Server.

Component to be installed

It is used to install the FineReport project.

For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.

• FineReport

• Filebeat

• Ops Agent

For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.

• Nginx

• MySQL (The self-provided component is supported.)

• Elasticsearch (The self-provided component is supported.)

• Ops Agent

2. It is used to install FineOps.

For details about the role of FineOps components, see Understanding the Roles of FineOps Components.

Note:

If you have installed FineOps, skip the content in this column.

• Ops and Nginx

• Pushgateway, Prometheus, Grafana, and Alertmanager

• Elasticsearch and Skywalking OAP

• Registry (The self-provided component is supported.)

• Ops Agent

The time on all servers must be synchronized, with a maximum difference of no more than 5 seconds.

Inconsistent server time can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies.

Time zone consistency

Inconsistent server time zones can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies.

Supported:

Ubuntu 18.04.4 and later releases (Ubuntu 20.04 is not supported.) 

CentOS 7.3 to 7.9

Red Hat 7.6 and later releases 

Rocky Linux 8.8 to 9.4

Note:

1. Since CentOS is discontinued, you are advised to use Ubuntu. 

2. When using Ubuntu, verify the user privilege (as the default root user is not a super administrator) and confirm that the disk type is XFS. For details, see notes in the following content.

CPU clock speed

Remaining free physical memory

The server shall have a partition with remaining free space of more than 200 GB.

Note:

1. There must be a single partition that meets the condition.

2. The required disk space decreases if you use self-prepared components. 

If you use a self-provided Elasticsearch component, the required remaining free disk space on the server can be reduced by 100 GB. 

If you use a self-provided external configuration database component, the required remaining free disk space on the server can be reduced by 50 GB.

The server shall have a partition with remaining free space of more than 300 GB.

Note:

There must be a single partition that meets the condition.

The disk read/write speed must be greater than 100 MB/s.

Mounting directory preparation

For details, see Preparing the FineReport Mounting Directory.

Note:

It is forbidden to mount projects directly in the /, /usr, /root, /usr/local paths. You can create folders at these locations for mounting.

For details, see Preparing the FineOps Server.

Note:

It is forbidden to mount projects directly in the /, /usr, /root, /usr/local paths. You can create folders at these locations for mounting.

Otherwise, containers may fail to access these directories, leading to data loss or application startup issues.

Sharing the file system may cause performance degradation, file permission issues, and data inconsistency, affecting the reliability and response speed of applications running in the container.

Ensure the server has the tar command installed.                                               

The tar command is a commonly used tool for packaging and compressing files.

FineOps requires this command for file extraction.

Ensure the server has the sed command installed.     

The sed command is used for text processing. 

FineOps requires this command for text processing.

Ensure you can connect to the FineOps server via the SSH protocol.

Ensure the password used for SSH connection contains no single English quotation marks, otherwise, the permission will fail to be validated during deployment.

1. Using the root user (superuser) for project deployment and operation is preferred.

2. To use a non-root user for deployment and operation, see Linux User Privilege Explanation.

Note:

On Ubuntu, the default root user is not a superuser. Ensure that the user privileges meet the requirements.

At least 100 MB/s

At least 100 Mbps (12.5 MB/s)

Note:

1. As the concurrent volume of project sessions increases, scale resources accordingly.

2. External bandwidth requirements can be appropriately lowered if the connected business database and self-prepared components operate in the intranet environment. 

Component-used port and component port interconnection

For details, see Confirming the FineReport Server Network.

For details, see Preparing the FineOps Server.

Component to be installed

It is used to install the FineReport project.

For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.

• FineReport

• Filebeat

• Ops Agent

It is used to install the FineReport project.

For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.

• FineReport

• Filebeat

• Ops Agent

1. It is used to install the FineReport cluster as well as log and configuration components.

For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.

• Nginx

• Elasticsearch (The self-provided component is supported.)

• MinIO (The self-provided component is supported.)

• MySQL (The self-provided component is supported.)

• Redis (The self-provided component is supported.)

• Ops Agent

For details about the role of FineOps components, see Understanding the Roles of FineOps Components.

Note:

1. If you have installed FineOps, skip the content in this column.

2. If the FineReport component and FineOps are to be deployed on the same server, the server's configuration should be the combined total of required configuration of the FineReport component server and the FineOps server.

• Ops and Nginx

• Pushgateway, Prometheus, Grafana, and Alertmanager

• Elasticsearch and Skywalking OAP

• Registry (The self-provided component is supported.)

• Ops Agent

The time on all servers must be synchronized, with a maximum difference of no more than 5 seconds.

Inconsistent server time can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies.

Time zone consistency

Inconsistent server time zones can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies.

Supported:

Ubuntu 18.04.4 and later releases (Ubuntu 20.04 is not supported.) 

CentOS 7.3 to 7.9

Red Hat 7.6 and later releases 

Rocky Linux 8.8 to 9.4

Note:

1. Since CentOS is discontinued, you are advised to use Ubuntu. 

2. When using Ubuntu, verify the user privilege (as the default root user is not a super administrator) and confirm that the disk type is XFS. For details, see notes in the following content.

CPU clock speed

Remaining free physical memory

The server shall have a partition with remaining free space of more than 200 GB.

Note:

There must be a single partition that meets the condition. 

The server shall have a partition with remaining free space of more than 200 GB.

Note:

There must be a single partition that meets the condition.

The server shall have a partition with remaining free space of more than 300 GB.

Note:

1. There must be a single partition that meets the condition. 

2. The required disk space decreases if you use self-prepared components. 

If you use a self-provided Elasticsearch component, the required remaining free disk space on the server can be reduced by 100 GB. 

If you use a self-provided external configuration database component, the required remaining free disk space on the server can be reduced by 50 GB.

If you use a self-provided file storage component, the required remaining free disk space on the server can be reduced by 100 GB.

The server shall have a partition with remaining free space of more than 120 GB.

Note:

There must be a single partition that meets the condition.

The disk read/write speed must be greater than 100 MB/s.

Disk type

Mounting directory preparation

For details, see Preparing the FineReport Mounting Directory.

Note:

It is forbidden to mount projects directly in the /, /usr, /root, /usr/local paths. You can create folders at these locations for mounting.

For details, see Preparing the FineOps Server.

Note:

It is forbidden to mount projects directly in the /, /usr, /root, /usr/local paths. You can create folders at these locations for mounting.

Otherwise, containers may fail to access these directories, leading to data loss or application startup issues.

Sharing the file system may cause performance degradation, file permission issues, and data inconsistency, affecting the reliability and response speed of applications running in the container.

Ensure the server has the tar command installed.                                               

The tar command is a commonly used tool for packaging and compressing files.

FineOps requires this command for file extraction.

Ensure the server has the sed command installed.     

The sed command is used for text processing. 

FineOps requires this command for text processing.

Ensure you can connect to the FineOps server via the SSH protocol.

Ensure the password used for SSH connection contains no single English quotation marks, otherwise, the permission will fail to be validated during deployment.

1. Using the root user (superuser) for project deployment and operation is preferred.

2. To use a non-root user for deployment and operation, see Linux User Privilege Explanation.

Note:

On Ubuntu, the default root user is not a superuser. Ensure that the user privileges meet the requirements.

At least 100 MB/s

/

At least 100 Mbps (12.5 MB/s)

Note:

1. As the concurrent volume of project sessions increases, scale resources accordingly.

2. External bandwidth requirements can be appropriately lowered if the connected business database and self-prepared components operate in the intranet environment. 

Component-used port and component port interconnection

For details, see Confirming the FineReport Server Network.

For details, see Preparing the FineOps Server.

Component to be installed

It is used to install the FineReport project.

For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.

• FineReport

• Filebeat

• Ops Agent

1. It is used to install the FineReport cluster as well as log and configuration components.

For details about the role of FineBI components, see Understanding the Roles of O&M Project Components.

• Nginx

• Elasticsearch (The self-provided component is supported.)

• MinIO (The self-provided component is supported.)

• MySQL (The self-provided component is supported.)

• Redis (The self-provided component is supported.)

• Ops Agent

For details about the role of FineOps components, see Understanding the Roles of FineOps Components.

Note:

1. If you have installed FineOps, skip the content in this column.

2. If the FineReport component and FineOps are to be deployed on the same server, the server's configuration should be the combined total of required configuration of the FineReport component server and the FineOps server.

• Ops and Nginx

• Pushgateway, Prometheus, Grafana, and Alertmanager

• Elasticsearch and Skywalking OAP

• Registry (The self-provided component is supported.)

• Ops Agent

The time on all servers must be synchronized, with a maximum difference of no more than 5 seconds.

Inconsistent server time can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies.

Time zone consistency

Inconsistent server time zones can cause issues such as incorrect execution of scheduled tasks, disorganized log records, and data inconsistencies.

Supported:

Ubuntu 18.04.4 and later releases (Ubuntu 20.04 is not supported.) 

CentOS 7.3 to 7.9

Red Hat 7.6 and later releases 

Rocky Linux 8.8 to 9.4

Note:

1. Since CentOS is discontinued, you are advised to use Ubuntu. 

2. When using Ubuntu, verify the user privilege (as the default root user is not a super administrator) and confirm that the disk type is XFS. For details, see notes in the following content.

CPU clock speed

Remaining free physical memory

The server shall have a partition with remaining free space of more than 200 GB.

Note:

There must be a single partition that meets the condition. 

The server shall have a partition with remaining free space of more than 500 GB.

Note:

1. There must be a single partition that meets the condition. 

2. The required disk space decreases if you use self-prepared components. 

If you use a self-provided Elasticsearch component, the required remaining free disk space on the server can be reduced by 100 GB. 

If you use a self-provided external configuration database component, the required remaining free disk space on the server can be reduced by 50 GB.

If you use a self-provided file storage component, the required remaining free disk space on the server can be reduced by 100 GB.

The server shall have a partition with remaining free space of more than 100 GB + 50 * N GB.

Note:

1. There must be a single partition that meets the condition.

2. The required disk space of the FineOps server increases with the number of nodes of the O&M project to be connected (if any). An extra 50 GB is required per node.

The disk read/write speed must be greater than 100 MB/s.

Disk type

Mounting directory preparation

For details, see Preparing the FineReport Mounting Directory.

Note:

It is forbidden to mount projects directly in the /, /usr, /root, /usr/local paths. You can create folders at these locations for mounting.

For details, see Preparing the FineOps Server.

Note:

It is forbidden to mount projects directly in the /, /usr, /root, /usr/local paths. You can create folders at these locations for mounting.

Otherwise, containers may fail to access these directories, leading to data loss or application startup issues.

Sharing the file system may cause performance degradation, file permission issues, and data inconsistency, affecting the reliability and response speed of applications running in the container.

Ensure the server has the tar command installed.                                               

The tar command is a commonly used tool for packaging and compressing files.

FineOps requires this command for file extraction.

Ensure the server has the sed command installed.     

The sed command is used for text processing. 

FineOps requires this command for text processing.

Ensure you can connect to the FineOps server via the SSH protocol.

Ensure the password used for SSH connection contains no single English quotation marks, otherwise, the permission will fail to be validated during deployment.

1. Using the root user (superuser) for project deployment and operation is preferred.

2. To use a non-root user for deployment and operation, see Linux User Privilege Explanation.

Note:

On Ubuntu, the default root user is not a superuser. Ensure that the user privileges meet the requirements.

At least 100 MB/s

/

At least 100 Mbps (12.5 MB/s)

Note:

1. As the concurrent volume of project sessions increases, scale resources accordingly.

2. External bandwidth requirements can be appropriately lowered if the connected business database and self-prepared components operate in the intranet environment. 

Component-used port and component port interconnection

For details, see Confirming the FineReport Server Network.

For details, see Preparing the FineOps Server.

FineReport

Deployed with Elasticsearch: Xmx+ 5 GB

Server memory - 8 GB

30 GB at most