fireflyiii/data-importer

Firefly III 数据导入工具

https://github.com/firefly-iii/data-importer/stargazers

Firefly III 数据导入工具

将交易记录导入 Firefly III
查阅文档

https://github.com/firefly-iii/firefly-iii/issues · https://github.com/firefly-iii/firefly-iii/issues · https://github.com/firefly-iii/firefly-iii/discussions

关于此数据导入工具

"Firefly III" 是一款（自托管的）个人财务管理工具。它可以帮助您跟踪支出和收入，从而减少开支、增加储蓄。数据导入工具用于帮助您将交易记录导入 Firefly III，出于安全和维护考虑，它与 Firefly III 主程序分离。

数据导入工具不直接连接您的银行，而是通过 Nordigen 和 SaltEdge 连接全球 6000 多家银行。这些服务对 Firefly III 用户免费，但需要注册。

您也可以导入从银行下载的 CSV 文件。其他导入方式正在开发中。

准备开始使用？请查阅官方文档！

寻求帮助

如果您在使用 Firefly III 或相关工具时需要支持，请通过以下渠道联系我们：

• https://github.com/firefly-iii/firefly-iii/discussions/
• Gitter.im（实时聊天与快速解答）
• https://github.com/firefly-iii/firefly-iii/issues
• ***（关注获取新闻与更新）

特性

• 支持从全球 6000 多家银行导入
• 命令行导入，便于自动化
• API 导入，便于自动化
• 使用规则和数据映射，确保交易记录清晰

更多特性请查阅 官方文档。

适用人群

本工具适用于希望跟踪个人财务、关注资金状况且不想将财务记录上传到云端的用户。您应具备一定技术能力，喜欢开源软件，并且不介意自行维护（自托管）服务器。

快速开始

Docker 部署方案示例

使用 Docker 快速部署 Firefly III 数据导入工具：

bash
docker run -d \
  --name firefly-iii-importer \
  -p 8080:8080 \
  -e FIREFLY_III_URL="https://your-firefly-iii-instance.com" \
  -e NORDIGEN_ID="your-nordigen-id" \
  -e NORDIGEN_KEY="your-nordigen-key" \
  -e APP_KEY="随机32位字符串" \
  -v firefly-iii-importer-data:/var/www/html/storage \
  fireflyiii/data-importer:latest

环境变量说明：

• FIREFLY_III_URL: Firefly III 主程序的访问 URL
• NORDIGEN_ID 和 NORDIGEN_KEY: Nordigen 服务注册凭证（需在 Nordigen 注册获取）
• APP_KEY: 用于加密敏感数据的随机 32 位字符串
• 数据卷 firefly-iii-importer-data 用于持久化存储配置和日志

使用 docker-compose：

yaml
version: '3'
services:
  importer:
    image: fireflyiii/data-importer:latest
    ports:
      - "8080:8080"
    environment:
      - FIREFLY_III_URL=https://your-firefly-iii-instance.com
      - NORDIGEN_ID=your-nordigen-id
      - NORDIGEN_KEY=your-nordigen-key
      - APP_KEY=随机32位字符串
    volumes:
      - firefly-iii-importer-data:/var/www/html/storage
volumes:
  firefly-iii-importer-data:

启动服务：docker-compose up -d

贡献指南

您可以通过以下方式参与贡献：

• 联系开发者：***
• 提交 Issue 或功能请求：https://github.com/firefly-iii/firefly-iii/issues
• 参与讨论：Gitter 或 https://github.com/firefly-iii/firefly-iii/discussions

贡献前请查阅 https://github.com/firefly-iii/data-importer/blob/main/.github/contributing.md 和 https://github.com/firefly-iii/data-importer/blob/main/.github/code_of_conduct.md%E3%80%82%E6%82%A8%E5%8F%AF%E4%BB%A5%E5%B8%AE%E5%8A%A9%E4%BF%AE%E5%A4%8D%E6%BC%8F%E6%B4%9E%E3%80%81%E6%8F%90%E5%87%BA%E6%96%B0%E5%8A%9F%E8%83%BD%E6%88%96%E5%8F%82%E4%B8%8E%E7%BF%BB%E8%AF%91%E3%80%82

Sonarcloud 提供代码质量扫描，可通过其报告发现优化空间：

支持开发

如果 Firefly III 帮助您更好地管理财务，欢迎通过以下方式支持开发：

• Patreon
• https://github.com/***/JC5

许可证

本项目采用 GNU Affero通用公共许可证 v3 授权，详情见 https://github.com/firefly-iii/data-importer/blob/main/LICENSE%E3%80%82

联系方式

• ：
• GitHub Discussions：https://github.com/firefly-iii/firefly-iii/discussions/
• Gitter.im：实时聊天
• GitHub Issues：https://github.com/firefly-iii/firefly-iii/issues

鸣谢

Firefly III 标志由 Cherie Woo 设计。