Project Backup

  • Last update: 2026-09-24
  • Overview

    Backup Management is used to centrally back up project files, configurations, and related component data of O&M projects. It reduces the risk of data loss caused by misoperations or failures through manual backup, automatic backup, and minimal unit backup.

    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 restoration from backups created within the previous 24 hours.

    V1.16.0

    Added support for Backup Management for FineDataLink applications.

    V2.7.0

    Simplified the backup content by canceling the backup of the following folders to avoid taking too much time:

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

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

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

    4. Canceled 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 alerts for backup failures.

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

    V2.34.0

    1. Added a Minimum Unit Backup solution that backed up necessary content on a scheduled, mandatory basis as a final safeguard for data security.

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

    V2.40.0Added support for backup storage location settings, allowing you to select the FineOps local directory or self-managed S3 storage.

    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-provided 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

    Check Item
    Description
    Management permission

    Use a FineOps admin account.

    Without management permissions, you cannot configure global backup policies or perform project backups.

    Image repository

    FineOps must have been properly connected to the image repository.

    If no image repository has been configured, the system displays the prompt "Use this function after configuring the image repository on the project management page." Backups cannot be performed. For details, see Image Management.

    Backup scope

    Confirm the components to be backed up.

    If self-provided components or external components are not covered, back them up separately and restore them during restoration.

    Local spaceWhen a local directory is used, sufficient disk space must have been reserved. Insufficient space blocks backups.

    Configuring Backup Policies and Storage Locations

    The configuration of Backup Setting takes effect for all projects in FineOps.

    Configuring Backup Limits and Disk 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 3 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 the FineOps 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.

    Configuring Backup Storage Locations

    From V2.40.0, custom backup storage locations are supported.

    Backup Location
    Application Scenario
    Local DirectoryThe local mounting disk has sufficient space.
    S3 Object StorageThe local disk space is insufficient, physical disk expansion or remounting is costly, or backups need to be stored separately from the FineOps server.

    1. Log in to FineOps as the admin and choose Setting > Backup Setting.

    2. In Backup Location, select Local Directory or S3 Object Storage, enter the required information, and click Save.

    • When Local Directory is selected, the path cannot be customized. The default path is /ops/resources/backup in the FineOps mounting directory.

    • When S3 Object Storage is selected, enter the self-managed S3 connection information.

    Setting Item
    Description
    Endpoint

    The access domain name of the S3 service

    Make sure the FineOps server can access the S3 Endpoint.

    Region

    The physical location of the S3 service

    Note that this value does not include the bucket prefix.

    AccessKey

    The key used to identify the account

    Make sure the account has read and write permissions on the target bucket.

    SecretKey

    The access secret that matches the AccessKey

    SecretKey is usually visible only when it is created. Store it securely in advance.

    Bucket

    The name of the bucket used to store backup objects

    You are advised to use an independent bucket or directory for project backups to avoid mixing backups with other business data.

    Path Prefix

    The directory prefix in the bucket for storing backups

    The default value is fineops-backup/.

    Path-Style AccessThis item usually does not need to be configured. Enable it only when the S3 service requires path-style access or when connection errors related to certificates or domain name resolution occur.
    SignerThis item is usually left empty. Enter a value only when a signature type is required.


    Confirming Backup Content

    The backup scope of a project depends on the project deployment method and component source.

    FineOps-Deployed Project

    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.

    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

    Backing Up Projects

    FineOps provides 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

    1. Go to Project Management as the admin, select a project, and choose Maintenance > Backup Management.

    2. Select whether to also back up images or JAR packages based on the project type.

    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.

        3. Click Start Backup, enter a unique backup name, 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. When a local directory is used, and the remaining space does not meet the requirements in the "Configuring Backup Limits and Disk Limits" section, the backup fails.

        3. Backup file names must be unique.


        Scheduled Automatic Backup

        1. Go to Project Management as the admin, select a project, and choose Maintenance > Backup Management.

        2. Select whether to also back up images or JAR packages based on the project type.

        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.

        3. Enable Automatic Backup and set the execution frequency and time.

        FineOps automatically creates backups at the specified time. The backup name is the execution time.

        iconNote:
        1. If the number of automatic backups exceeds the upper limit set in the "Configuring Backup Limits and Disk 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 "Configuring Backup Limits and Disk Limits" section, no automatic backup will be executed.

        Minimum Unit Backup

        From V2.34.0, minimal unit backup is provided as a data safety fallback when automatic backup is not enabled.

        Item 
        Description
        Enablement rule

        If Automatic Backup is enabled, Minimal Unit Backup is disabled.

        If Automatic Backup is disabled, Minimal Unit Backup is enabled by default and forcibly executed. It cannot be disabled on the frontend page.

        Backup contentConfiguration files of the external configuration database of the project. This covers FineOps-deployed projects and Non-FineOps-deployed projects, as well as FineOps-deployed and user-prepared external configuration databases.
        Execution frequency

        Once a day

        The default execution time is 02:00.

        Retention quantitySame as the backup limit in the "Configuring Backup Limits and Disk Limits" section. Old backups are automatically deleted after new backups are generated.
        Size limitThe configuration files of the external configuration database of the project cannot exceed 4 GB. If the limit is exceeded, the backup cannot be completed.
        Restoration methodRestoration on the frontend page is not supported. To use this backup, contact FanRuan operations personnel to perform operations at the underlying level.

        On the backup list page, the green backup icon indicates that minimal unit backup is running properly.


        Managing Backups

        Viewing Backup Information

        View the following information in Backup Management > Backup Record.

        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

        Deleting a Backup

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

        Renaming a Backup

        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.

        Checking the Backup/Restoration Failure Record

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

        A Project Backup Anomaly alert has been added since V2.29.0 to support automatic alerts for backup failures.

        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