🐳 Deployment Guide (Docker)

This page provides a quick guide for deploying F²-Gen using Docker and Docker Compose. This method is recommended for users who want an isolated, reproducible environment without manually setting up dependencies.

💡 For manual (non-Docker) setup instructions, see the Deployment Instructions (Non-Docker).
📘 For usage guidance and system walkthrough, refer to the Usage Guide and Demo Video.
⚙️ For technical details, see the Engine Overview and Technical Report.

🚀 Quick Start

Install Docker and Docker Compose to quickly get started with the project.

1. Clone the Git Repository

First, clone the code repository to the local directory：

git clone https://github.com/sethGu/FinancialFraudDataGenerator.git
cd generate-visualization-main

🛠 Optional: Configure Docker Hub Mirror for Faster Builds

For users in regions with slow or unstable access to Docker Hub (e.g., mainland China), you can speed up image pulls by configuring a registry mirror in Docker Desktop.

Add the following to your Docker Engine’s daemon.json (Docker Desktop → Settings → Docker Engine):

{ “registry-mirrors”: [“https://mirror.gcr.io”] }

🚨 重要提示（中国大陆用户必看） 🚨

如果您位于国内，并且尚未配置 Docker 镜像加速（或刚刚全新安装 Docker），在继续构建镜像前务必先进行以下设置，否则可能会出现下载极慢或直接连接失败的情况。

  1. 打开 Docker Desktop → Settings → Docker Engine
  2. 在配置中添加如下内容（如已有其他配置，请合并）：

{ “registry-mirrors”: [“https://mirror.gcr.io”] }

2. Build Docker Images

Run the following command to build the required Docker images:

docker-compose build

3. Create Docker Volumes

Create Docker volumes for the database and application data:

docker volume create --name=vol_smart_pgdata
docker volume create --name=vol_smart_data

📌 You can rename volumes if needed, but make sure to reflect the change in docker-compose.yml.

4. Run Database Migrations

Ensure that the database is initialized and run the migration command:

docker-compose run --rm backend python manage.py dbcheck
docker-compose run --rm backend python manage.py migrate

5. Start the Application

Start all the containers:

docker-compose up -d

6. Access the Platform

Once all containers are running, open your browser and visit:

👉 http://localhost:9528

Login using the default credentials:

🔐 Username: editor
🔐 Password: FdpDg@2024

Note

When you use the Docker mode. Comment out 'HOST': '127.0.0.1' in the generate-visualization-main/backend/web/setting.py file and uncomment 'HOST': 'db'; in the smart_finance_main/src/utils/config.py file, comment out host='localhost' and uncomment host='db'.

📦 Download

You can also download the platform source code from the latest release:

🧩 Additional Resources