Using PostgreSQL as the External Configuration Database

  • Last update: 2026-04-09
  • Overview

    In FanRuan applications, you (the admin) typically configure users, mount directories, assign permissions, and set scheduling plans. All the configuration is stored in a configuration database.

    In production environments, you can prepare a PostgreSQL database to connect it with FanRuan applications for configuration storage. A stable external database ensures the reliable operation of FanRuan applications under high load.

    This document explains how to connect a FanRuan project to a PostgreSQL database to store project configuration information:

    • You can prepare a tablespace in a PostgreSQL database and tune parameters.

    • After a project is deployed, you can connect the project to this configuration database.

    Preparing Project Configuration

    Checking Project Configuration

    For projects not deployed via FineOps, open the server.xml file in Tomcat installation directory/conf/server.xml.

    Inside the Host tags, check whether Context-related content is configured. Ensure reloadable=false. (Skip this if Context-related content is not configured).

    Installing the Plugin

    You need to install the PostgreSQL Database plugin to connect to a PostgreSQL configuration database.

    Uploading the Driver for the FanRuan Project

    By default, PostgreSQL drivers are not built into FanRuan projects. You need to upload them manually. You must perform this section; otherwise, the connection will fail.

    1. Go to the PostgreSQL official website and download the driver package that matches your database version: PostgreSQL JDBC Driver

    2. Upload the driver to the project. For details, see Driver Management.

    Preparing the Configuration Database

    You must prepare and deploy the PostgreSQL database and tablespace by yourself.

    FanRuan does not provide detailed guidance on database deployment. Only essential requirements are specified. Refer to the official PostgreSQL documentation for additional assistance.

    iconNote:
    If you lack database O&M expertise, select Deploy Mysql8 when deploying a new project via FineOps. This eliminates the need for manual deployment and tuning. 

    Database Version

    The following table lists FanRuan-tested environments.

    • Databases of earlier versions not mentioned are generally not supported or contain known issues; thus, they are not recommended.

    • You can test databases of higher versions that are not mentioned. If issues arise, premium customers can contact technical support. For details about how to contact technical support, see Technical Support Channel Introduction.

    PostgreSQL Database Plugin Version
    Database TypeDatabase Version
      V1.0PostgreSQL9.2.3, 9.4.7, 9.5.0, 9.5.2, 9.6.0
      V1.0.3PostgreSQL9.2.3, 9.4.7, 9.5.0, 9.5.2, 9.6.0, 13.0

    Server Configuration

    Configuration Type
    Minimum ConfigurationRecommended ConfigurationNotes
    Memory1 GB2 GB

    It refers to the memory allocated to the configuration database, not total server memory.

    A dedicated server for the configuration database is recommended. 

    If resources are limited, ensure that no content other than the FanRuan application is deployed on the server hosting the configuration database, and ensure sufficient memory is allocated to the configuration database.

     CPU4 cores8 cores/
     Network speed50 Mbps100 Mbps

    The configuration database, application, and other components should be on the same network segment to avoid network instability.

    Ensure network connectivity and accessible ports between the configuration database, application, and other components.

     FineDB-used space1 GB2 GB

    Adjust it based on usage.

    Allocate 1 to 2 times the recommended size of space.

     Disk space100 GB200 GB/
     Disk I/O speed50 MB/s100 MB/s/

    Creating a Tablespace

    Different FanRuan projects cannot share the same database tablespace as the configuration database. Otherwise, data corruption may occur.

    Therefore, you are advised to create a new tablespace in the database to store configuration data.

    • You are advised to use an all-English tablespace name. The tablespace name supports only letters, numbers, underscores (_), and dots (.).

    • Do not store any other data (such as business data and logs) in this tablespace.

    Preparing Configuration Database Information

    Prepare the following tablespace information to connect it to the project as the configuration database.

    Setting Item
    Description
     Database name

    Name of the tablespace created in the "Creating a Tablespace" section

    You are advised to use an all-English tablespace name. The tablespace name supports only letters, numbers, underscores (_), and dots (.).

     Host

    IP address of the database server

    The host name supports only letters, numbers, underscores (_), hyphens (-), and dots (.).

     PortDatabase port on the server
     Username

    Database username

    1. The user must have CREATE, DELETE, ALTER, UPDATE, SELECT, INSERT, and INDEX privileges to support configuration table structure changes and configuration updates. 

    2. Since the database schema is usually named after the user, you are advised to use only letters and numbers. Special characters are not recommended.

     Password

    Database user password

    After the configuration database is successfully connected, do not change the username or password. Otherwise, the project will fail to start.

     Schema

    Name of the prepared database user

    If you use another schema, the schema name must not contain uppercase letters.

    Connecting the Project to the Configuration Database

    You can configure a self-prepared PostgreSQL database as the configuration database under System Management > System Setting > General of the FanRuan application.

    iconNote:
    PostgreSQL databases are not supported by default. Therefore, it cannot be configured in FineOps. You can only view related information or switch to other database types in FineOps.

    Ensuring a Single Active Application (Required for Multi-application Projects)

    For multi-application projects, ensure only one application node is active during configuration service connection or migration.

    Log in to FineOps as the admin. Select the target project and choose Maintenance > Component Management. Check if multiple bi-web/fr/fdl containers are active.

    If multiple containers exist, click the  icon of each container to stop other containers, leaving only one in active status.

    iconNote:
    For projects not deployed via FineOps, stop other main applications by referring to Closing or Restarting the FineBI Project and keep only one active.

    Configuring the External Configuration Database

    1. Log in to the FanRuan application as the admin. Choose System Management > System Setting > General

    2. Locate External Database and configure it.

    3. Enter the database information:

    • Database Type: Select postgresql.

    • Driver: No change is required. Keep org.postgresql.Driver.

    • Database NameHostPortUsernamePassword: Enter the information prepared in the "Preparing Configuration Database Information" section.

    4. Set Schema:

    • After filling in all the above information correctly, click Click to Connect Database in the drop-down list of Schema. The system will automatically connect to the database and read the schema.

    • Prefer the schema that matches the database username.

    5. Database Connection URL:

    Generally, no manual modification is needed. It is generated from other configuration and preset parameters.

    6. Choose whether to tick Migrate Data to Database to Be Enabled:

    Scenario
    New PostgreSQL Server Configuration Database Status
     Use the current project's existing configuration.

    1. Migrate Data to Database to Be Enabled must be ticked.

    2. After a successful connection, the existing configuration data of the project will be migrated to the tablespace.

    3. Any existing data in the new PostgreSQL Server tablespace will be cleared and cannot be recovered.

     Use the configuration from another project. (For example, copy the production environment configuration to a test environment.)

    1. Upload the prepared configuration data to the new PostgreSQL tablespace.

    Ensure the JAR package version of the source project exactly matches the JAR package version of the current project

    2. Do not tick Migrate Data to Database to Be Enabled

    3. After a successful connection, the project will use the data in the tablespace as its configuration. 

    4. Original connection information will be backed up to the db.properties.bak file in the config directory of the project

    7. Click Enable New Database. The message “Migrated successfully” indicates a normal connection.

    Ensuring Multi-application Configuration Synchronization (Required for Multi-application Projects)

    1. Copy the db.properties file.

    Navigate to the server hosting the single active bi-web/fr/fdl container and copy the db.properties file in the component mounting path /config.

    Paste the file to the same location on all other bi-web/fr/fdl container servers.

    iconNote:
    For projects not deployed via FineOps, copy db.properties from /webroot/WEB-INF/embed in the single active application directory to the same location in all other application directories.


    2. Stop all applications.

    Log in to FineOps as the admin and choose Maintenance > Component Management.

    Click Stop on all FineBI - Application Node/FineReport/FineDataLink components. Ensure all bi-web/fr/fdl containers are in the exited status.

    iconNote:
    For projects not deployed via FineOps, stop the single active application by referring to Closing or Restarting the FineBI Project.

    3. Restart all applications.

    Click Start on all FineBI - Application Node/FineReport/FineDataLink components under Maintenance > Component Management. Ensure all bi-web/fr/fdl containers are in the running status.

    iconNote:
    For projects not deployed via FineOps, start all main applications in the cluster one by one by referring to Closing or Restarting the FineBI Project.


    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