Confirming Server Configuration of the FineReport Project

  • Last update: 2026-06-04
  • Overview

    You can use FineOps to deploy FineReport 11.0 projects.

    This document offers four standard deployment schemes based on user volumes and business usage. Choose the one that best meets your needs.

    Scheme Selection

    The schemes in this document are designed for new project deployment scenarios, providing recommended server configuration based on user volumes and business usage.

    1. Uncertain Usage

    If you are uncertain about the business usage, you can estimate the user volume based on the number of employees and select the corresponding scheme.

    2. Mismatch Between User Volume and Business Usage

    If the user volume and business usage correspond to different schemes, choose the scheme with the higher configuration.

    For example, if the number of registered users is 1800 (which corresponds to Scheme One) and the number of concurrent scheduled tasks is 90 (which corresponds to Scheme Two), you should select Scheme Two, which requires higher configuration.

    3. Increased Growth

    As usage increases over time, if your current server resources become insufficient and require expansion, contact FanRuan technical support personnel for assistance.

    Usage TypeUsage DescriptionMinimum Configuration Scheme

    Scheme One

    Standalone (Elementary)

    Scheme Two

    Standalone (Recommended)

    Scheme Three

    Dual-Node Cluster


    Scheme Four

    Multi-node Cluster


    User Volume

    Number of system users

    Number of FineReport system users

    You can estimate it based on the number of employees.

    10002000 400080004000 * N
    Number of concurrent users

    Number of users sending requests to the FineReport system per minute

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

    50100200400200 * N

    Business Usage - Template Data Volume

    Number of data rows in a single datasetMaximum number of data rows in a single dataset in templates that are viewed/exported/printed300 thousand500 thousand1 millionmillionmillion
    Number of cells in a single templateMaximum number of cells (Row count * Column count) in a single template  that is viewed/exported/printed 500 thousandmillionmillionmillionmillion
    Total number of cells

    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.

    million10 million40 million< 40 million * 240 million N 
    Business Usage - Export and Print Concurrency
    Number of concurrent exports using large datasetsNumber of concurrent template exports using large datasets in the FineReport system30306012060 * N
    Number of regular prints per secondNumber of template prints per second in the FineReport system3030306030 * N
    Number of custom streaming interface prints per secondNumber of template prints per second using custom streaming interfaces in the FineReport system10001000100010001000 * N

    Business Usage - Data Entry

    Number of Excel cells per importMaximum number of cells (Row count * Column count) imported from the Excel file per import during data submission500 thousand1 millionmillionmillionmillion
    Number of cells submitted to the database per submissionMaximum volume of data submitted to the database per submission500 thousandmillionmillionmillionmillion
    Business Usage - Scheduled Task Concurrency
    Number of concurrent scheduled tasks Number of concurrent scheduled tasks running in the FineReport system 50100100200100 * N

    Scheme and Configuration

    SchemeDescription

    Server Configuration

    Minimum Configuration SchemeIt is designed for customers with minimal business usage.

    For customers with minimal business usage, FineReport and FineOps can be deployed on one server.

    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 Nginx (the internal gateway), MySQL (the configuration database), and Elasticsearch (the log storage service).

    It is used to deploy all FineOps components.

    Scheme OneIt provides the recommended elementary configuration for single-node projects.

    Main application server: 16-core CPU, 64 GB of memory, and 500 GB of disk space

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

    It is used to deploy all FineOps components.

    Scheme TwoIt provides the recommended advanced configuration for single-node projects.

    1. FineReport main application server: 16-core CPU, 64 GB of memory, and 300 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.

    Scheme ThreeIt 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. Server for FineReport components and FineOps: 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.

    It is used to deploy all FineOps components.

    Scheme FourIt provides the optimal configuration for multi-node clusters.

    1. N main application servers

    N = (Number of System 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. Server for FineReport components and FineOps: 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.

    It is used to deploy all FineOps components.


    Minimum Configuration Scheme

    iconNote:

    1. This scheme is intended for customers with little business usage and limited server resources only.

    Ensure the usage meets the following requirements: The number of system users, concurrent users, data rows in a single dataset, cells in a single template, and total cells is less than 1000, 50, 300 thousand, 500 thousand, and five million, respectively.

    2. The deployment scheme cannot ensure disaster recovery because FineOps and the FanRuan project are deployed on the same server.

    If the server fails, both FineOps and the FanRuan project will become unavailable. You cannot quickly restore the FanRuan project through off-site backups via FineOps.

    If you have explicit requirements for disaster recovery and can provide additional server resources, you are advised to deploy FineOps, the main application of the FanRuan project, and the component services of the FanRuan project on separate servers to eliminate single points of failure and enable rapid recovery from an off-site backup. For more information about the distributed deployment scheme, contact FanRuan technical support.

    It requires one main application server with an 8-core CPU, 32 GB of memory, and 300 GB of disk space.

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

    • It is used to deploy all FineOps components.

    ConfigurationServer for the FineReport Application and FineOps
    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 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 components, see Understanding the Roles of FineOps Components.

    iconNote:
    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

    Basic server requirementNon-VM (Recommended)Due to the nature of virtual machines, such as competing for resources, unexpected system failures may occur. Therefore, you are not advised to deploy FanRuan applications on virtual machines.
    Operating systemOperating system typeLinux
    Operating system architectureX86_64
    Operating system kernelV3.10 and later versions
    Operating system software

    Recommended: Ubuntu 22

    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

    iconNote:

    You are advised to use Ubuntu since CentOS is discontinued.

    When using Ubuntu, verify the user privilege (as the default root user is not a superuser). For details, see the notes in the following content.

    CPUCPU core quantity8 cores
    CPU clock speed2.4 GHz and above
    MemoryRemaining free physical memory32 GB
    DiskRemaining free disk space

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

    iconNote:
    There must be a single partition that meets the condition.
    Disk read/write speedRandom read/write throughput (1024k) > 50 MiB/s
    Mounting pathMounting directory preparation

    For details, see Preparing the FineReport Mounting Directory.

    For details, see Preparing the FineOps Server.

    iconNote:
    The mounting path cannot be /, /usr, /root, or /usr/local. You can create folders in these paths for file mounting.
    File system auto-mounting

    Ensure that the file system of the mounting directory is configured to be automatically mounted during a boot.

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

    Non-shared path

    The mounting path cannot be a shared-use path.

    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.

    Permission and commandsTar command

    Ensure the server has tar installed.

    tar is a commonly used command-line tool for archiving and compressing files.

    FineOps requires this command to decompress files.


    Sed command

    Ensure the server has sed installed.

    The sed command is used for text processing.

    FineOps requires this command to process text.


    SSH

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

    Ensure the password used for the SSH connection contains no English single quotation marks ('), or the privilege will fail to be validated during deployment.


    Sudo privilege

    The server user responsible for deploying the project must have the necessary sudo privileges.

    1. You are advised to use the root user account for project deployment and operation.

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

    iconNote:
    The default root user of an Ubuntu operating system is not a superuser. Ensure the user privileges meet the requirements.
    Port and networkInternal network latencyLess than 1 ms
    Internal network bandwidth (between project components) At least 1000 Mbps (125 MB/s)
    Public internet bandwidth (between the project and clients)

    At least 20 Mbps (2.5 MB/s)

    iconNote:

    1. Increase the bandwidth accordingly as the number of concurrent project sessions grows.

    2. If the business databases (databases connected via data connections) and self-provided components are all on the internal network, the required public internet bandwidth can be reduced accordingly.


    Component-occupied port

    Component port connectivity

    For details, see Confirming the FineReport Server Network.

    For details, see Preparing the FineOps Server.

    OthersAbsence of Podman

    If the server is running the Kylin operating system, ensure that Podman is not installed on the server.

    The version of runc bundled with Podman is too low and conflicts with the Docker installation managed by FanRuan, which may cause deployment failures.

    Refer to the relevant document to uninstall Podman. You are advised to verify the impact of uninstallation in a non-production environment first.

    Absence of Kingsoft Antivirus 

    Ensure that Kingsoft Antivirus is not installed on the server.

    This antivirus software may trigger server connection interruptions when the dockerd command is executed, resulting in deployment failures.

    Refer to the relevant document to uninstall Podman. You are advised to verify the impact of uninstallation in a non-production environment first.

    Scheme One

    iconNote:

    The deployment scheme cannot ensure disaster recovery because FineOps and the FanRuan project are deployed on the same server.

    If the server fails, both FineOps and the FanRuan project will become unavailable. You cannot quickly restore the FanRuan project through off-site backups via FineOps.

    If you have explicit requirements for disaster recovery and can provide additional server resources, you are advised to deploy FineOps, the main application of the FanRuan project, and the component services of the FanRuan project on separate servers to eliminate single points of failure and enable rapid recovery from an off-site backup. For more information about the distributed deployment scheme, contact FanRuan technical support

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

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

    It is used to deploy all FineOps components.

    ConfigurationServer for the FineReport Application and FineOps
    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 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 components, see Understanding the Roles of FineOps Components.

    iconNote:
    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

    Basic server requirement Time consistency

    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

    All servers must be set to the same time zone.

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

    Internal network connectivity

    All servers can communicate with each other on the internal network or have open ports for access.

    For details about port requirements, see the following content.

    Non-VM (Recommended) Due to the nature of virtual machines, such as competing for resources, unexpected system failures may occur. Therefore, you are not advised to deploy FanRuan applications on virtual machines.
    Operating systemOperating system typeLinux
    Operating system architectureX86_64
    Operating system kernel

    V3.10 and later versions

    Operating system software

    Recommended: Ubuntu 22

    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

    iconNote:

    You are advised to use Ubuntu since CentOS is discontinued.

    When using Ubuntu, verify the user privilege (as the default root user is not a superuser). For details, see the notes in the following content.

    CPUCPU core quantity16 cores
    CPU clock speed 2.4 GHz and above
    Memory

    Remaining free physical memory

    64 GB

    iconNote:

    Registration and authentication must be completed after project deployment.

    For the internal network environment that can be connected to the FanRuan cloud or the public internet environment, you are advised to authenticate registration via a public cloud. For details, see Public Cloud Authentication.

    For the pure internal network environment, you need to install a registration service component on the project component server and authenticate registration via private cloud on FineOps. Therefore, you must ensure at least 2 GB of additional available physical memory on this server. For details, see New Project Registration

    DiskRemaining free disk space

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

    iconNote:

    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 the self-provided Elasticsearch, the required remaining free disk space on the server can be reduced by 100 GB.

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

    Disk read/write speedRandom read/write throughput (1024k) > 50 MiB/s
    Mounting pathMounting directory preparation

    For details, see Preparing the FineReport Mounting Directory.

    For details, see Preparing the FineOps Server.

    iconNote:
    The mounting path cannot be /, /usr, /root, or /usr/local. You can create folders in these paths for file mounting.
    File system auto-mounting

    Ensure that the file system of the mounting directory is configured to be automatically mounted during a boot.

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

    Non-shared path

    The mounting path cannot be a shared-use path.

    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.

    Permission and commandsTar command 

    Ensure the server has tar installed.

    tar is a commonly used command-line tool for archiving and compressing files.

    FineOps requires this command to decompress files.

    Sed command

    Ensure the server has sed installed.

    The sed command is used for text processing.

    FineOps requires this command to process text.

    SSH

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

    Ensure the password used for the SSH connection contains no English single quotation marks ('), or the privilege will fail to be validated during deployment.

    Sudo privilege

    The server user responsible for deploying the project must have the necessary sudo privileges.

    1. You are advised to use the root user account for project deployment and operation.

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

    iconNote:
    The default root user of an Ubuntu operating system is not a superuser. Ensure the user privileges meet the requirements.
    Port and network Internal network latencyLess than 1 ms
    Internal network bandwidth (between project components) At least 1000 Mbps (125 MB/s)
    Public internet bandwidth (between the project and clients)

    At least 20 Mbps (2.5 MB/s)

    iconNote:

    1. Increase the bandwidth accordingly as the number of concurrent project sessions grows.

    2. If the business databases (databases connected via data connections) and self-provided components are all on the internal network, the required public internet bandwidth can be reduced accordingly.

    Component-occupied port

    Component port connectivity

    For details, see Confirming the FineReport Server Network.

    For details, see Preparing the FineOps Server.

    OthersAbsence of Podman

    If the server is running the Kylin operating system, ensure that Podman is not installed on the server.

    The version of runc bundled with Podman is too low and conflicts with the Docker installation managed by FanRuan, which may cause deployment failures.

    Refer to the relevant document to uninstall Podman. You are advised to verify the impact of uninstallation in a non-production environment first.

    Absence of Kingsoft Antivirus 

    Ensure that Kingsoft Antivirus is not installed on the server.

    This antivirus software may trigger server connection interruptions when the dockerd command is executed, resulting in deployment failures.

    Refer to the relevant document to uninstall Podman. You are advised to verify the impact of uninstallation in a non-production environment first.

    Scheme Two

    iconNote:

    The deployment scheme cannot ensure disaster recovery because FineOps and the FanRuan project components are deployed on the same server.

    If the server fails, both FineOps and the FanRuan project will become unavailable. You cannot quickly restore the FanRuan project through off-site backups via FineOps.

    If you have explicit requirements for disaster recovery and can provide additional server resources, you are advised to deploy FineOps, the main application of the FanRuan project, and the component services of the FanRuan project on separate servers to eliminate single points of failure and enable rapid recovery from an off-site backup. For more information about the distributed deployment scheme, contact FanRuan technical support.

    It requires two servers:

    1. FineReport main application server: 16-core CPU, 64 GB of memory, and 300 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.

    ConfigurationFineReport Main Application ServerServer for FineReport Components and FineOps
    Component to be installed

    It is used to install components of the FineReport project.

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

    • FineReport

    • Filebeat

    • OPS Agent

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

    For details about the role of 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 components, see Understanding the Roles of FineOps Components.

    iconNote:
    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

    Basic server requirement Time consistencyThe 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

    All servers must be set to the same time zone.

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

    Internal network connectivity

    All servers can communicate with each other on the internal network or have open ports for access.

    For details about port requirements, see the following content.

    Non-VM (Recommended)Due to the nature of virtual machines, such as competing for resources, unexpected system failures may occur. Therefore, you are not advised to deploy FanRuan applications on virtual machines.
    Operating systemOperating system typeLinux
    Operating system architecture

    X86_64

    Operating system kernel V3.10 and later versions
    Operating system software

    Recommended: Ubuntu 22

    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

    iconNote:

    You are advised to use Ubuntu since CentOS is discontinued.

    When using Ubuntu, verify the user privilege (as the default root user is not a superuser). For details, see the notes in the following content.

    CPUCPU core quantity 16 cores 8 cores
    CPU clock speed 2.4 GHz and above
    Memory Remaining free physical memory64 GB

    32 GB

    iconNote:

    Registration and authentication must be completed after project deployment.

    For the internal network environment that can be connected to the FanRuan cloud or the public internet environment, you are advised to authenticate registration via a public cloud. For details, see Public Cloud Authentication.

    For the pure internal network environment, you need to install a registration service component on the project component server and authenticate registration via private cloud on FineOps. Therefore, you must ensure at least 2 GB of additional available physical memory on this server. For details, see New Project Registration

    DiskRemaining free disk space

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

    iconNote:
    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.

    iconNote:

    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 the self-provided Elasticsearch, the required remaining free disk space on the server can be reduced by 100 GB.

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

    Disk read/write speedRandom read/write throughput (1024k) > 50 MiB/s
    Mounting pathMounting directory preparation

    For details, see Preparing the FineReport Mounting Directory.

    iconNote:
    The mounting path cannot be /, /usr, /root, or /usr/local. You can create folders in these paths for file mounting.

    For details, see Preparing the FineReport Mounting Directory.

    For details, see Preparing the FineOps Server.

    iconNote:
    The mounting path cannot be /, /usr, /root, or /usr/local. You can create folders in these paths for file mounting.
    File system auto-mounting

    Ensure that the file system of the mounting directory is configured to be automatically mounted during a boot.

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

    Non-shared pathThe mounting path cannot be a shared-use path.

    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.

    Permission and commands Tar commandEnsure the server has tar installed.

    tar is a commonly used command-line tool for archiving and compressing files.

    FineOps requires this command to decompress files.

    Sed command

    Ensure the server has sed installed.

    The sed command is used for text processing.

    FineOps requires this command to process text.

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

    Ensure the password used for the SSH connection contains no English single quotation marks ('), or the privilege will fail to be validated during deployment.

    Sudo privilege

    The server user responsible for deploying the project must have the necessary sudo privileges.

    1. You are advised to use the root user account for project deployment and operation.

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

    iconNote:
    The default root user of an Ubuntu operating system is not a superuser. Ensure the user privileges meet the requirements.
    Port and network Internal network latency Less than 1 ms
    Internal network bandwidth (between project components) At least 1000 Mbps (125 MB/s)
    Public internet bandwidth (between the project and clients)At least 50 MB/s6.25 MB/s

    iconNote:

    1. Increase the bandwidth accordingly as the number of concurrent project sessions grows.

    2. If the business databases (databases connected via data connections) and self-provided components are all on the internal network, the required public internet bandwidth can be reduced accordingly.


    At least 50 MB/s6.25 MB/s

    Component-occupied port

    Component port connectivity

    For details, see Confirming the FineReport Server Network.

    For details, see Confirming the FineReport Server Network.

    For details, see Preparing the FineOps Server.

    OthersAbsence of Podman 

    If the server is running the Kylin operating system, ensure that Podman is not installed on the server.

    The version of runc bundled with Podman is too low and conflicts with the Docker installation managed by FanRuan, which may cause deployment failures.

    Refer to the relevant document to uninstall Podman. You are advised to verify the impact of uninstallation in a non-production environment first.

    Absence of Kingsoft Antivirus Ensure that Kingsoft Antivirus is not installed on the server.

    This antivirus software may trigger server connection interruptions when the dockerd command is executed, resulting in deployment failures.

    Refer to the relevant document to uninstall Podman. You are advised to verify the impact of uninstallation in a non-production environment first.

    Scheme Three 

    iconNote:

    The deployment scheme cannot ensure disaster recovery because FineOps and the FanRuan project components are deployed on the same server.

    If the server fails, both FineOps and the FanRuan project will become unavailable. You cannot quickly restore the FanRuan project through off-site backups via FineOps.

    If you have explicit requirements for disaster recovery and can provide additional server resources, you are advised to deploy FineOps, the main application of the FanRuan project, and the component services of the FanRuan project on separate servers to eliminate single points of failure and enable rapid recovery from an off-site backup. For more information about the distributed deployment scheme, contact FanRuan technical support.

    It requires three servers: two for main applications, and one for FineReport components and FineOps

    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. Server for FineReport components and FineOps: 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.

    • It is used to deploy all FineOps components.

    ConfigurationFineReport Main Application Server One FineReport Main Application Server Two Server for FineReport Components and FineOps
    Component to be installed 

    It is used to install the FineReport project.

    For details about the role of 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 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 components, see Understanding the Roles of O&M Project Components.

    • Nginx

    • Elasticsearch, MinIO, MySQL, and Redis (Self-provided components are supported.)

    • OPS Agent

    2. It is used to install FineOps.

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

    iconNote:
    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

    Basic server requirement Time consistency

    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

    All servers must be set to the same time zone.

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

    Internal network connectivity

    All servers can communicate with each other on the internal network or have open ports for access.

    For details about port requirements, see the following content.

    Non-VM (Recommended) Due to the nature of virtual machines, such as competing for resources, unexpected system failures may occur. Therefore, you are not advised to deploy FanRuan applications on virtual machines.
    Operating system Operating system type Linux
    Operating system architecture X86_64
    Operating system kernel V3.10 and later versions
    Operating system software

    Recommended: Ubuntu 22

    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

    iconNote:

    You are advised to use Ubuntu since CentOS is discontinued.

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


    CPU CPU core quantity 16 cores 16 cores 8 cores
    CPU clock speed 2.4 GHz and above
    Memory Remaining free physical memory

    64 GB 

    64 GB

    32 GB

    iconNote:

    Registration and authentication must be completed after project deployment.

    For the internal network environment that can be connected to the FanRuan cloud or the public internet environment, you are advised to authenticate registration via a public cloud. For details, see Public Cloud Authentication.

    For the pure internal network environment, you need to install a registration service component on the project component server and authenticate registration via private cloud on FineOps. Therefore, you must ensure at least 2 GB of additional available physical memory on this server. For details, see New Project Registration

    DiskRemaining free disk space

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

    iconNote:
    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.

    iconNote:
    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.

    iconNote:

    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 the self-provided Elasticsearch, the required remaining free disk space on the server can be reduced by 100 GB.

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

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

    Disk read/write speed 

    Random read/write throughput (1024k) > 100 MiB/s


    Disk type//

    If you have not prepared the file service component, the FineBI MinIO component must be deployed, and the recommended disk type is XFS.

    iconNote:

    1. The default disk type of Ubuntu systems is typically not XFS. Adjust it accordingly.

    2. The default disk type of Alibaba Cloud servers is typically not XFS. Adjust it accordingly.

    3. This operation may format the disk. FanRuan does not provide related guidance. Follow the instructions from your server vendor and proceed with caution.

    Mounting path Mounting directory preparationFor details, see Preparing the FineReport Mounting Directory.
    iconNote:
    The mounting path cannot be /, /usr, /root, or /usr/local. You can create folders in these paths for file mounting.


    For details, see Preparing the FineReport Mounting Directory.

    For details, see Preparing the FineOps Server.

    iconNote:
    The mounting path cannot be /, /usr, /root, or /usr/local. You can create folders in these paths for file mounting.

    File system auto-mounting

    Ensure that the file system of the mounting directory is configured to be automatically mounted during a boot.

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

    Non-shared path

    The mounting path cannot be a shared-use path.

    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.

    Permission and commands Tar command 

    Ensure the server has tar installed.

    tar is a commonly used command-line tool for archiving and compressing files.

    FineOps requires this command to decompress files.

    Sed command


    Ensure the server has sed installed.

    The sed command is used for text processing.

    FineOps requires this command to process text.

    SSH 

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

    Ensure the password used for the SSH connection contains no English single quotation marks ('), or the privilege will fail to be validated during deployment.

    Sudo privilege

    The server user responsible for deploying the project must have the necessary sudo privileges.

    1. You are advised to use the root user account for project deployment and operation.

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

    iconNote:
    The default root user of an Ubuntu operating system is not a superuser. Ensure the user privileges meet the requirements.
    Port and network Internal network latencyLess than 1 ms
    Internal network bandwidth (between project components) At least 1000 Mbps (125 MB/s)
    Public internet bandwidth (between the project and clients)

    At least 100 Mbps (12.5 MB/s)

    iconNote:

    1. Increase the bandwidth accordingly as the number of concurrent project sessions grows.

    2. If the business databases (databases connected via data connections) and self-provided components are all on the internal network, the required public internet bandwidth can be reduced accordingly.

    At least 100 Mbps (12.5 MB/s)

    Component-occupied port

    Component port connectivity

    For details, see Confirming the FineReport Server Network.

    For details, see Confirming the FineReport Server Network.

    For details, see Preparing the FineOps Server.

    OthersAbsence of Podman 

    If the server is running the Kylin operating system, ensure that Podman is not installed on the server.

    The version of runc bundled with Podman is too low and conflicts with the Docker installation managed by FanRuan, which may cause deployment failures.

    Refer to the relevant document to uninstall Podman. You are advised to verify the impact of uninstallation in a non-production environment first.

    Absence of Kingsoft Antivirus 

    Ensure that Kingsoft Antivirus is not installed on the server.

    This antivirus software may trigger server connection interruptions when the dockerd command is executed, resulting in deployment failures.

    Refer to the relevant document to uninstall Podman. You are advised to verify the impact of uninstallation in a non-production environment first.

    Scheme Four

    iconNote:

    The deployment scheme cannot ensure disaster recovery because FineOps and the FanRuan project are deployed on the same server.

    If the server fails, both FineOps and the FanRuan project will become unavailable. You cannot quickly restore the FanRuan project through off-site backups via FineOps.

    If you have explicit requirements for disaster recovery and can provide additional server resources, you are advised to deploy FineOps, the main application of the FanRuan project, and the component services of the FanRuan project on separate servers to eliminate single points of failure and enable rapid recovery from an off-site backup. For more information about the distributed deployment scheme, contact FanRuan technical support.

    It requires N+1 servers: N for main applications, where N = (Number of system users)/4000, and one for FineReport components and FineOps

    1. N main application servers, where N = (Number of system 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. Server for FineReport components and FineOps: 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.

    • It is used to deploy all FineOps components.

    ConfigurationEach FineReport Main Application Server Server for FineReport Components and FineOps
    Component to be installed 

    It is used to install the FineReport project.

    For details about the role of 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 components, see Understanding the Roles of O&M Project Components.

    • Nginx

    • Elasticsearch, MinIO, MySQL, and Redis (Self-provided components are supported.)

    • OPS Agent

    2. It is used to install FineOps.

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

    iconNote:
    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

    Basic server requirement Time consistency

    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

    All servers must be set to the same time zone.

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

    Internal network connectivity

    All servers can communicate with each other on the internal network or have open ports for access.

    For details about port requirements, see the following content.

    Non-VM (Recommended) Due to the nature of virtual machines, such as competing for resources, unexpected system failures may occur. Therefore, you are not advised to deploy FanRuan applications on virtual machines.
    Operating system Operating system typeLinux
    Operating system architecture X86_64
    Operating system kernel V3.10 and later versions
    Operating system software

    Recommended: Ubuntu 22

    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

    iconNote:

    You are advised to use Ubuntu since CentOS is discontinued.

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


    CPUCPU core quantity 16 cores 8 cores
    CPU clock speed 2.4 GHz and above
    Memory Remaining free physical memory64 GB

    32 GB

    iconNote:

    Registration and authentication must be completed after project deployment.

    For the internal network environment that can be connected to the FanRuan cloud or the public internet environment, you are advised to authenticate registration via a public cloud. For details, see Public Cloud Authentication.

    For the pure internal network environment, you need to install a registration service component on the project component server and authenticate registration via private cloud on FineOps. Therefore, you must ensure at least 2 GB of additional available physical memory on this server. For details, see New Project Registration

    DiskRemaining free disk space

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

    iconNote:
    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.

    iconNote:

    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 the self-provided Elasticsearch, the required remaining free disk space on the server can be reduced by 100 GB.

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

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

    3. An extra 50 GB of disk space is required for each additional project node connected to FineOps.

    Disk read/write speed Random read/write throughput (1024k) > 100 MiB/s
    Disk type /

    If you have not prepared the file service component, the FineBI MinIO component must be deployed, and the recommended disk type is XFS.

    iconNote:

    1. The default disk type of Ubuntu systems is typically not XFS. Adjust it accordingly.

    2. The default disk type of Alibaba Cloud servers is typically not XFS. Adjust it accordingly.

    3. This operation may format the disk. FanRuan does not provide related guidance. Follow the instructions from your server vendor and proceed with caution.

    Mounting path Mounting directory preparation

    For details, see Preparing the FineReport Mounting Directory.

    iconNote:
    The mounting path cannot be /, /usr, /root, or /usr/local. You can create folders in these paths for file mounting.

    For details, see Preparing the FineReport Mounting Directory.

    For details, see Preparing the FineOps Server.

    iconNote:
    The mounting path cannot be /, /usr, /root, or /usr/local. You can create folders in these paths for file mounting.
    File system auto-mounting

    Ensure that the file system of the mounting directory is configured to be automatically mounted during a boot.

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

    Non-shared path

    The mounting path cannot be a shared-use path.

    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.

    Permission and commands Tar command 

    Ensure the server has tar installed.

    tar is a commonly used command-line tool for archiving and compressing files.

    FineOps requires this command to decompress files.


    Sed command

    Ensure the server has sed installed.

    The sed command is used for text processing.

    FineOps requires this command to process text.


    SSH 

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

    Ensure the password used for the SSH connection contains no English single quotation marks ('), or the privilege will fail to be validated during deployment.


    Sudo privilege

    The server user responsible for deploying the project must have the necessary sudo privileges.

    1. You are advised to use the root user account for project deployment and operation.

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

    iconNote:
    The default root user of an Ubuntu operating system is not a superuser. Ensure the user privileges meet the requirements.
    Port and network Internal network latency Less than 1 ms
    Internal network bandwidth (between project components) At least 1000 Mbps (125 MB/s)
    Public internet bandwidth (between the project and clients)

    At least 100 Mbps (12.5 MB/s)

    iconNote:

    1. Increase the bandwidth accordingly as the number of concurrent project sessions grows.

    2. If the business databases (databases connected via data connections) and self-provided components are all on the internal network, the required public internet bandwidth can be reduced accordingly.

    At least 100 Mbps (12.5 MB/s)

    Component-occupied port

    Component port connectivity

    For details, see Confirming the FineReport Server Network.

    For details, see Confirming the FineReport Server Network.

    For details, see Preparing the FineOps Server.

    OthersAbsence of Podman 

    If the server is running the Kylin operating system, ensure that Podman is not installed on the server.

    The version of runc bundled with Podman is too low and conflicts with the Docker installation managed by FanRuan, which may cause deployment failures.

    Refer to the relevant document to uninstall Podman. You are advised to verify the impact of uninstallation in a non-production environment first.

    Absence of Kingsoft Antivirus 

    Ensure that Kingsoft Antivirus is not installed on the server.

    This antivirus software may trigger server connection interruptions when the dockerd command is executed, resulting in deployment failures.

    Refer to the relevant document to uninstall Podman. You are advised to verify the impact of uninstallation in a non-production environment first.

    Annex

    FineReport Performance Test Report

    FineReport 11.0 Performance Test Report.pdf

    Required Resources of FineReport Components 

    The configuration requirements in the above tables must be met because each component of FineReport projects has minimum operational requirements, as shown in the following table.

    iconNote:

    1. To prevent resource over-provisioning, a CPU-sharing strategy is used, as the components do not run at full load simultaneously. Therefore, the required number of server CPU cores is not the total number of maximum CPU cores used by each container.

    2. The server memory size must be at least the total of the maximum memory used by each container to implement the JAVA memory configuration for each container, including Xmx, off-heap memory, FineIO read/write memory, CodeCache, and Metaspace.


    ComponentMaximum CPU UsageMaximum Memory UsageMemory Configuration (Xmx)Disk Space

    FineReport

    8 cores 

    Elasticsearch deployedXmx+ 5 GB

    Elasticsearch not deployed: Xmx+ 8 GB

    Server memory - 8 GB

    30 GB at most

    200 GB
    OPS Agent1 core1 GB//
    Filebeat0.1 core0.3 GB//
    Elasticsearch1 core4 GB2 GB50 GB
    Nginx1 core2 GB//
    MySQL2 cores6 GB/50 GB
    Redis1 core4.5 GB4 GB/
    MinIO1 core2 GB/100 GB



    Attachment List


    Theme: FanRuan Project Deployment
    Previous
    Next
    • Helpful
    • Not helpful
    • Only read

    滑鼠選中內容,快速回饋問題

    滑鼠選中存在疑惑的內容,即可快速回饋問題,我們將會跟進處理。

    不再提示

    10s後關閉

    Get
    Help
    Online Support
    Professional technical support is provided to quickly help you solve problems.
    Online support is available from 9:00-12:00 and 13:30-17:30 on weekdays.
    Page Feedback
    You can provide suggestions and feedback for the current web page.
    Pre-Sales Consultation
    Business Consultation
    Business: international@fanruan.com
    Support: support@fanruan.com
    Page Feedback
    *Problem Type
    Cannot be empty
    Problem Description
    0/1000
    Cannot be empty

    Submitted successfully

    Network busy