Project Backup

  • Last update: 2026-08-07
  • Overview

    Version

    FineOps Version
    Functional Change

    V1.5.5

    /

    V1.12.0

    Enhanced pre-backup disk space check requirements to avoid disk space exhaustion caused by backups.

    Adjusted O&M projects' backup and restoration requirements, and allowed restoring from backups made within 24 hours.

    V1.16.0

    Supported the backup management of FineDataLink applications.

    V2.7.0

    Simplified the backup content by cancelling backing up the following folders to avoid taking too much time:

    1. Cancelled the backup of standalone FineReport templates of previous versions: /assets/vcs.

    2. Cancelled the backup of standalone FineDataLink snapshots of previous versions: /dpworks/records.

    3. Cancelled the backup of the cluster's Excel source files: /assets/temp_attach.

    4. Cancelled the backup of FineDataLink cluster's snapshots of previous versions: /dpworks/records.

    V2.10.0

    Stopped backing up the data storage component content for FineBI 6.1 projects. Backed up only the configuration of the data storage component.

    V2.29.0

    1. Added a Project Backup Anomaly alert to support automatic alert reminder upon backup failure.

    2. Added backup integrity check logic to prevent invalid backup files.

    V2.34.0

    1. Added a Minimum Unit Backup solution that regularly and forcibly backed up necessary content as a final safeguard for data security.

    2. Supported backup of configuration files for self-provided configuration databases, further improving data security.

    Application Scenario

    FineReport, FineBI, and FineDataLink applications have built-in backup and restoration functions, but limitations exist:

    1. Application backup files can only be stored in the project directory and do not support off-site backups. If the project is accidentally deleted, the backup may also be deleted.

    2. As the number of templates and data within the application increases, the backup speed decreases.

    3. During application backups, JAR packages, templates, and configurations are backed up separately, but these contents need to be backed up uniformly according to time points in most cases.

    iconNote:

    When backing up containerized projects, the self-prepared components will not be backed up and cannot be restored.

    You are advised to manually back up these self-provided components when backing up the project, and restore them simultaneously during restoration.

    Function Description

    FineOps provides a Backup Management function.

    • You can choose one-click backup or automatic backup.

    • You can back up projects to the FineOps server for off-site backup.

    • You can manage backups and view backup failure records and other information on the page.

    Prerequisite

    Confirming Image Repository Configuration

    When backing up FineOps-deployed projects, you may need to back up relevant images. Therefore, you must ensure the platform is properly connected to the image repository.

    If the platform is not configured with an image repository, the backup function cannot be used, and a prompt will appear: "Use this function after configuring the image repository."

    Setting Backup Limits

    Since backups consume server memory, you need to limit the number of backups and the disk space they consume.

    Log in to FineOps as the admin, set the limits under Setting > Backup Setting, and click Save.

    These settings apply to all projects within FineOps.

    Setting Content

    Description

    Backup Limit

    You can limit the maximum number of backups for each O&M project.

    When the number of manual or automatic backup files for a project reaches the upper limit, the earliest backup file will be automatically deleted. You can keep three manual and three automatic backups by default.

    Disk Limit

    You can limit the remaining available disk space for the backup storage directory in FineOps

    The backups are normally stored in /ops/resources/backup of FineOps's mounting directory.

    • If no backups exist, the first backup will not proceed if the remaining available space in the backup storage directory is less than (2 * Set value).

    • If backups already exist, the new backup will not proceed if the remaining available space in the backup storage directory is less than (2 * Latest backup size + Set value).

    • The default value is 5 GB.

    Understand Backup Content

    FineOps-Deployed Project

    1. Backup Scope

    The coverage of project backup depends on the component source:

    Component Source
    Backup Scope
    Project components deployed via FineOpsBackup scope: all backup content listed below
    Self-provided project components
    • V2.34.0 and later: The configuration files in the project configuration database are backed up. Other content is not backed up.

    • V2.33.0 and earlier: The following content is not backed up at all.

    You are advised to manually back up these self-provided components when backing up the project, and restore them simultaneously during restoration.

    2. Backup Content

    Component
    Backup Content (Path in the Container)Description

    bi-web/bi6/fr/fdl
    (Project application)

    /usr/local/tomcat/webapps/webroot/APP/classesDefault and custom class files called by the project
    /usr/local/tomcat/webapps/webroot/APP/configFiles related to the configuration database (FineDB) called by the platform
    /usr/local/tomcat/webapps/webroot/APP/customlibProject-customized or externally imported JAR packages, fonts, and other files
    /usr/local/tomcat/webapps/webroot/APP/driversDrivers uploaded through Driver Management
    /usr/local/tomcat/webapps/webroot/APP/pluginsPlugin-related files

    bi6/fr/fdl
    (Project application;

    This part is backed up only when the project is a single-application project.)
    /usr/local/tomcat/webapps/webroot/APP/assets
    Content in this folder except temp_attach and vcs is backed up.
    Common shared persistence directory
    /usr/local/tomcat/webapps/webroot/APP/dashboards

    Files related to dashboards in FineBI of old versions

    (If the directory does not exist, it is not backed up.)

    /usr/local/tomcat/webapps/webroot/APP/dpworks
    Content in this folder except record and records is backed up.

    Configuration files related to FineDataLink tasks

    (If the directory does not exist, it is not backed up.)

    /usr/local/tomcat/webapps/webroot/APP/reportletsFineReport template storage directory
    /usr/local/tomcat/webapps/webroot/APP/resourcesProject-related resource configuration files
    /usr/local/tomcat/webapps/webroot/APP/scheduleFiles generated by scheduled tasks
    bi-engine-master
    (FineBI 6.1 engine metadata)
    /data/polars/rocks_dataPersistent storage for metadata
    bi-engine-worker
    (FineBI 6.1 engine computing)
    No directory is backed up. Only the container configuration is backed up./
    bi-minio
    (FineBI 6.1 data storage)
    No directory is backed up. Only the container configuration is backed up./
    nginx
    (FanRuan internal gateway)
    /usr/local/nginx/confNginx configuration files
    /usr/local/nginx/luaLua script files
    mysql
    (External configuration database)
    /var/lib/mysql
    Content in this folder except mysql.sock is backed up.
    Actual data files of the MySQL database
    elasticsearch
    (Log service)
    /usr/share/elasticsearch/config/elasticsearch.ymlElasticsearch configuration file
    /run/secretsSome sensitive information or security-related files of Elasticsearch
    filebeat
    (Log collection)
    /usr/share/filebeat/filebeat.ymlFilebeat configuration file
    /usr/share/filebeat/dataFilebeat data directory
    /usr/share/filebeat/configInput files
    redis
    (Status service)
    /dataRedis data directory
    minio
    (File storage)
    assets
    Content in this folder except temp_attach and vcs is backed up.
    Common shared persistence directory
    dashboards

    Files related to dashboards in FineBI of old versions

    (If the directory does not exist, it is not backed up.)

    dpworks
    Content in this folder except record and records is backed up.

    Configuration files related to FineDataLink tasks

    (If the directory does not exist, it is not backed up.)

    reportletsFineReport template storage directory
    resourcesProject-related resource configuration files
    scheduleFiles generated by scheduled tasks
    nacos
    (Service registry)
    /home/nacos/dataData such as the Derby database
    nacos_mysql
    (Configuration storage required by the nacos service)
    /var/lib/mysql
    Content in this folder except mysql.sock is backed up.
    Actual data files of the MySQL database
    kafka
    (Pipeline service)
    No directory is backed up. Only the container configuration is backed up./

    Non-FineOps-Deployed Project

    Only project-related files are backed up. External configuration databases, log storage components, and other components are not backed up.

    You are advised to manually back up these necessary components when backing up the project, and restore them at the same time during restoration.

    Location
    Backup ContentDescription

    bi/fr/fdl
    (Application node)

    /webroot/WEB-INF/classesDefault and custom class files called by the project
    /webroot/WEB-INF/configFiles related to the configuration database (FineDB) called by the platform
    /webroot/WEB-INF/customlibProject-customized or externally imported JAR packages, fonts, and other files
    /webroot/WEB-INF/driversDrivers uploaded through Driver Management
    /webroot/WEB-INF/pluginsPlugin-related files
    Standalone: On the bi/fr/fdl application node
    Cluster: On the file server
    /webroot/WEB-INF/assets
    Content in this folder except temp_attach and vcs is backed up.
    Common shared persistence directory
    /webroot/WEB-INF/dashboards

    Files related to dashboards in FineBI of old versions

    (If the directory does not exist, it is not backed up.)

    /webroot/WEB-INF/dpworks
    Content in this folder except record and records is backed up.

    Configuration files related to FineDataLink tasks

    (If the directory does not exist, it is not backed up.)

    /webroot/WEB-INF/reportletsFineReport template storage directory
    /webroot/WEB-INF/resourcesProject-related resource configuration files

    Project Backup

    Two backup methods:

    • Manual backup: You (the admin) can manually trigger project backups.

    • Automatic backup: You can set the automatic backup time. FineOps will automatically back up the project at specified time points.

    Manual Backup

    Log in to FineOps as the admin, click a project, and choose Maintenance > Backup Management.

    1. Select the backup content.

    Project Type

    Selection

    Backup Content

    FineOps-deployed Projects

    Image Backup unticked

    All content listed in the "FineOps-Deployed Project" section is backed up.

    iconNote:
    Only project components deployed via FineOps are backed up. Self-provided components are not backed up.
    You are advised to manually back up these user-provided components when backing up the project, and restore them at the same time during restoration.

      Image Backup ticked

      1. The image files of the current versions of project components are backed up.
      2. All content listed in the "FineOps-Deployed Project" section is backed up.

      iconNote:
      Only project components deployed via FineOps are backed up. Self-provided components are not backed up.
      You are advised to manually back up these user-provided components when backing up the project, and restore them at the same time during restoration.

        Non-FineOps-Deployed Projects

        JAR Package Backup unticked

        All content listed in the "Non-FineOps-Deployed Project" section is backed up.

        iconNote:

        Only project-related files are backed up. External configuration databases, log storage components, and other components are not backed up.

        You are advised to manually back up these necessary components when backing up the project, and restore them at the same time during restoration.

        JAR Package Backup ticked

        1. The JAR package files of the current version used by the project are backed up.
        2. All content listed in the "Non-FineOps-Deployed Project" section is backed up.

        iconNote:

        Only project-related files are backed up. External configuration databases, log storage components, and other components are not backed up.

        You are advised to manually back up these necessary components when backing up the project, and restore them at the same time during restoration.

        2. Start the backup.

        Click Start Backup, name the backup file, and click OK.

        After starting the backup, you can switch to other pages, as the backup process can run in the background.

        iconNote:

        1. If the number of manual backups exceeds the upper limit, a prompt will appear: "There are already X manual backups of this project. This backup will overwrite the earliest manual backup. Do you want to continue?"

        2. If the remaining available space in the backup storage directory is less than the limit set in section "Setting Backup Limits", the backup will fail.

        3. Backup file names must be unique.


        Scheduled Automatic Backup

        Log in to FineOps as the admin, click a project, and choose Maintenance > Backup Management.

        1. Select the backup content.

        Project Type

        Selection

        Backup Content

        FineOps-deployed Projects

        Image Backup unticked

        All content listed in the "FineOps-Deployed Project" section is backed up.

        iconNote:
        Only project components deployed via FineOps are backed up. Self-provided components are not backed up.
        You are advised to manually back up these user-provided components when backing up the project, and restore them at the same time during restoration.

        Image Backup ticked

        1. The image files of the current versions of project components are backed up.
        2. All content listed in the "FineOps-Deployed Project" section is backed up.

        iconNote:
        Only project components deployed via FineOps are backed up. Self-provided components are not backed up.
        You are advised to manually back up these user-provided components when backing up the project, and restore them at the same time during restoration.

        Non-FineOps Deployed Projects

        JAR Package Backup unticked

        All content listed in the "Non-FineOps-Deployed Project" section is backed up.

        iconNote:

        Only project-related files are backed up. External configuration databases, log storage components, and other components are not backed up.

        You are advised to manually back up these necessary components when backing up the project, and restore them at the same time during restoration.

        JAR Package Backup ticked

        1. The JAR package files of the current version used by the project are backed up.
        2. All content listed in the "Non-FineOps-Deployed Project" section is backed up.

        iconNote:

        Only project-related files are backed up. External configuration databases, log storage components, and other components are not backed up.

        You are advised to manually back up these necessary components when backing up the project, and restore them at the same time during restoration.

        2. Start the backup.

        Enable Automatic Backup and set Backup Frequency. FineOps will automatically back up the project at the specified time.

        The name of the automatically generated backup will be the backup time.

        iconNote:
        1. If the number of automatic backups exceeds the upper limit set in the "Setting Backup Limits" section, the earliest backup file will be automatically deleted.

        2. If the remaining available space in the backup storage directory is less than the limit set in the "Setting Backup Limits" section, no automatic backup will be executed.

        Minimum Unit Backup

        The Minimum Unit Backup solution has been introduced since FineOps V2.34.0 for projects as a final safeguard for data security.

        • Solution description: If Automatic Backup is enabled, Minimum Unit Backup is disabled. If Automatic Backup is disabled, Minimum Unit Backup is enabled by default and forcibly executed, and it cannot be disabled on the frontend page.

        • Backup content: It includes configuration files of the project's external configuration database. (This scope applies to both FineOps-deployed and non-FineOps-deployed projects, and both FineOps-deployed and self-provided external configuration databases.)

        • Backup frequency: The backup is performed once a day. The default execution time is 2:00 a.m.

        • Backup file: Backups are generated on the FineOps server. The number of retained backups is the same as the value set in the "Setting Backup Limits" section. After a new minimum unit backup is generated, the previous minimum unit backup is automatically deleted.

        • Backup limit: A size limit applies to the minimum unit backup. If the limit is exceeded, the backup cannot be completed. The configuration files of the project's external configuration database are limited to 4 GB.

        • Restoration: The minimum unit backup does not support restoration on the frontend page. It is stored only as a final safeguard. To use a minimum unit backup for restoration, contact O&M personnel.

        On the backup list page, a green backup icon indicates that minimum unit backup is running normally.

        Backup Management

        Backup Generation Location

        The backup file generated by automatic or manual backup is stored in FineOps's mounting directory/ops/resources/backup. You cannot modify the backup location.

        You can use different servers for FineOps and projects to realize off-site backup.

        iconNote:

        1. The storage location of project backups cannot be modified or customized.

        2. For details about locating the mounting directory, see Exporting FineOps Deployment Information.

        3. Integrity checks are performed on backup content during backup storage, routine inspection, and restoration. Therefore, do not manually modify backup content. Otherwise, the backup may become invalid.

        Displayed Backup Information

        Details of each backup are displayed in a detail table in Full Backup. The remaining available space in the backup storage directory is displayed in the upper right corner.

        Item

        Description

        Backup Name

        Name of the backup file

        Backup Type

        Backup type (Values include Manual Backup and Automatic Backup.)

        Start Time

        Time when the backup started (accurate to the second)

        End Time

        Time when the backup ended (accurate to the second)

        Backup Size

        Backup file size

        Backup Deletion

        Select a backup and click the Delete button to delete it, as shown in the following figure:

        Backup Renaming

        Click the  icon next to a backup, rename the backup, and click OK to apply the new name.

        iconNote:
        Backup file names must be unique.

        Backup/Restoration Failure Record

        Click Record of Backup Failure and Restoration to view the detail table of failed backup and restoration records. See the following figure:

        A Project Backup Anomaly alert has been added since V2.29.0 to support automatic alert reminder upon backup failure.

        Viewing the Backup Storage Directory Name

        For projects deployed in a non-containerized mode, manually generated backups in the backup storage directory of FineOps are named by backup ID, which makes it difficult to correlate backups with the names displayed on the frontend page and makes restoration inconvenient.

        For projects deployed in a non-containerized mode, you can hover over a backup to view the directory name and click the  icon to copy the name.


        Attachment List


        Theme: Project Management
        • 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