nicxx2/fireflyiii-quickstart

Firefly III Quickstart Docker镜像

镜像概述

Firefly III Quickstart Docker镜像是一个优化的自定义Docker镜像，专为简化和加速Firefly III的部署而设计。Firefly III是一款免费开源的个人财务管理工具，本镜像通过自动化环境配置和简化设置流程，让用户能够以最少的手动操作快速启动应用。

核心功能与特性

• 自动化环境设置：自动从官方源获取并配置.env和.db.env文件，确保环境变量正确设置，无需手动创建配置文件。
• 简化配置流程：预配置必要的基础设置，只需最小化的个性化调整即可启动应用，降低配置门槛。
• Docker Compose支持：内置Docker Compose文件，方便部署和管理Firefly III相关服务（如数据库、定时任务等）。

适用场景

适用于希望快速部署Firefly III个人财务管理工具的用户，尤其适合对Docker配置不熟悉、希望减少手动操作的个人用户，同时支持树莓派5硬件环境。

快速启动指南

拉取Docker镜像

bash
docker pull nicxx2/fireflyiii-quickstart

使用Docker Compose运行

从仓库获取Docker Compose文件，根据需求调整环境变量后启动服务：

bash
docker-compose up -d

该命令将部署Firefly III及其依赖服务（如数据库、定时任务）。

访问Firefly III

打开浏览器，访问 http://localhost:8081 即可使用Firefly III。

配置说明

通过修改Docker Compose文件中的环境变量进行个性化配置，关键变量包括：

• APP_KEY：Laravel应用的唯一密钥，确保安全性。
• MYSQL_RANDOM_ROOT_PASSWORD：设为"yes"可启用随机生成的MySQL root密码，增强安全性。
• MYSQL_USER / MYSQL_PASSWORD：数据库访问凭证。
• STATIC_CRON_TOKEN：定时任务的安全令牌。

Docker Compose配置示例

基础配置（含数据库和定时任务）

yaml
version: '3.3'

services:
  app:
    image: nicxx2/fireflyiii-quickstart:latest  # 使用Docker Hub镜像
    container_name: firefly_iii_core
    restart: always
    volumes:
      - /Data/firefly_iii/upload:/var/www/html/storage/upload  # 上传文件持久化卷
      - /Data/firefly_iii/export:/var/www/html/storage/export  # 导出文件持久化卷
    networks:
      - firefly_network
    ports:
      - "8081:8080"  # 容器8080端口映射到主机8081端口
    depends_on:
      - db
    environment:
      - APP_KEY=aaadd7f048dcb455a863144ccd44bc27
      - MYSQL_RANDOM_ROOT_PASSWORD=yes
      - MYSQL_USER=firefly
      - MYSQL_PASSWORD=secret_firefly_password
      - MYSQL_DATABASE=firefly
      - STATIC_CRON_TOKEN=aaadd7f048dcb455a863144ccd44bc2d

  db:
    image: mariadb:lts
    container_name: firefly_iii_db
    restart: always
    volumes:
      - /Data/firefly_iii/db:/var/lib/mysql  # 数据库持久化卷
    networks:
      - firefly_network
    environment:
      - MYSQL_RANDOM_ROOT_PASSWORD=yes
      - MYSQL_USER=firefly
      - MYSQL_PASSWORD=secret_firefly_password
      - MYSQL_DATABASE=firefly

  cron:
    image: alpine
    restart: always
    container_name: firefly_iii_cron
    command: >-
      /bin/sh -c "echo '0 3 * * * wget -qO- http://app:8081/api/v1/cron/$STATIC_CRON_TOKEN' | crontab - && crond -f -L /dev/stdout"
    networks:
      - firefly_network
    depends_on:
      - app
    environment:
      - STATIC_CRON_TOKEN=aaadd7f048dcb455a863144ccd44bc2d

networks:
  firefly_network:
    driver: bridge

包含数据导入器（data_importer）的配置

如需同时部署Firefly III和数据导入器，使用以下Docker Compose配置，确保组件间网络互通：

yaml
version: '3.3'

services:
  app:
    image: nicxx2/fireflyiii-quickstart:latest  # 使用Docker Hub镜像
    container_name: firefly_iii_core
    restart: always
    volumes:
      - /Data/firefly_iii/upload:/var/www/html/storage/upload  # 上传文件持久化卷
      - /Data/firefly_iii/export:/var/www/html/storage/export  # 导出文件持久化卷
    networks:
      - firefly_network
    ports:
      - "8081:8080"  # 容器8080端口映射到主机8081端口
    depends_on:
      - db
    environment:
      - APP_KEY=aaadd7f048dcb455a863144ccd44bc27
      - MYSQL_RANDOM_ROOT_PASSWORD=yes
      - MYSQL_USER=firefly
      - MYSQL_PASSWORD=secret_firefly_password
      - MYSQL_DATABASE=firefly
      - STATIC_CRON_TOKEN=aaadd7f048dcb455a863144ccd44bc2d

  db:
    image: mariadb:lts
    container_name: firefly_iii_db
    restart: always
    volumes:
      - /Data/firefly_iii/db:/var/lib/mysql  # 数据库持久化卷
    networks:
      - firefly_network
    environment:
      - MYSQL_RANDOM_ROOT_PASSWORD=yes
      - MYSQL_USER=firefly
      - MYSQL_PASSWORD=secret_firefly_password
      - MYSQL_DATABASE=firefly

  cron:
    image: alpine
    restart: always
    container_name: firefly_iii_cron
    command: >-
      /bin/sh -c "echo '0 3 * * * wget -qO- http://app:8081/api/v1/cron/$STATIC_CRON_TOKEN' | crontab - && crond -f -L /dev/stdout"
    networks:
      - firefly_network
    depends_on:
      - app
    environment:
      - STATIC_CRON_TOKEN=aaadd7f048dcb455a863144ccd44bc2d

  data-importer:
    image: fireflyiii/data-importer:version-1.4.5
    container_name: firefly_iii_data_importer
    ports:
      - "8082:8080"  # 数据导入器端口映射
    environment:
      FIREFLY_III_ACCESS_TOKEN: "your_ACCESS_TOKEN"  # Firefly III访问令牌
      FIREFLY_III_URL: "http://app:8080"  # Firefly III服务地址
      NORDIGEN_ID: "your_nordigen_id_here"  # Nordigen API ID（如需）
      NORDIGEN_KEY: "your_nordigen_key_here"  # Nordigen API密钥（如需）
      SPECTRE_APP_ID: "your_spectre_app_id_here"  # Spectre应用ID（如需）
      SPECTRE_SECRET: "your_spectre_secret_here"  # Spectre密钥（如需）
    networks:
      - firefly_network
    depends_on:
      - app
    restart: always

networks:
  firefly_network:
    driver: bridge

Firefly III数据导入器设置

前提条件

• 运行中的Firefly III实例：确保Firefly III已启动并可访问，数据导入器需通过访问令牌与其通信。

生成FIREFLY_III_ACCESS_TOKEN

1. 登录Firefly III实例。
2. 导航至选项 > OAuth > 个人访问令牌。
3. 创建新令牌：输入描述性名称（如“数据导入器访问”）。
4. 复制并安全保存令牌：令牌仅显示一次，需妥善保管。

配置Docker Compose

将生成的访问令牌更新到data-importer服务的环境变量中：

yaml
data-importer:
  environment:
    FIREFLY_III_ACCESS_TOKEN: "粘贴你的令牌"