Actual Budget 备份 Docker 容器

概述

本Docker容器专为Actual Budget（实际预算）应用设计，提供数据远程备份功能。基于Rclone实现与多种远程存储系统的集成，支持定时备份、自定义备份保留策略及灵活的文件命名规则，确保Actual Budget数据安全存储于远程位置。

重要提示：使用前请确保已阅读Actual Budget***文档并已部署运行Actual Budget实例。

核心功能与特性

• 多存储系统支持：通过Rclone集成OneDrive、Google Drive、S3等60+种远程存储服务
• 定时备份：基于supercronic实现自定义Cron表达式的定时备份任务
• 备份保留策略：可配置自动删除旧备份文件（按天数保留）
• 灵活命名规则：支持自定义备份文件后缀，解决单日多次备份的文件名冲突问题
• 安全配置：支持环境变量、.env文件及Docker Secrets管理敏感信息（如密码）
• 配置验证：提供Rclone配置检查工具，确保远程存储连接有效性

使用场景

适用于已部署Actual Budget实例的用户，需将财务数据定期备份至远程存储以防止本地数据丢失，尤其适合：

• 个人用户备份预算数据至私有云存储（如OneDrive、坚果云）
• 团队环境中需将Actual Budget数据集中备份至企业存储（如S3、SharePoint）
• 对数据安全性有要求，需定期自动备份并清理旧备份的场景

使用方法

1. 配置Rclone（⚠️ 必须阅读 ⚠️）

备份功能依赖Rclone配置，未配置将导致备份失败。

备份文件通过Rclone上传至远程存储系统，需先完成Rclone配置。不同存储系统的令牌获取方式不同，详见Rclone***文档。

1.1 配置Rclone

通过以下命令生成Rclone配置（会启动交互式配置界面）：

docker run --rm -it \
  --mount type=volume,source=actualbudget-rclone-data,target=/config/ \
  rodriguestiago0/actualbudget-backup:latest \
  rclone config

推荐配置：将远程存储名称设为ActualBudgetBackup，若使用其他名称，需通过RCLONE_REMOTE_NAME环境变量指定。

1.2 验证配置

配置完成后，通过以下命令检查配置是否生效：

docker run --rm -it \
  --mount type=volume,source=actualbudget-rclone-data,target=/config/ \
  rodriguestiago0/actualbudget-backup:latest \
  rclone config show

示例输出（OneDrive）：

[ActualBudgetBackup]
type = onedrive
token = {"access_token":"xxx","token_type":"Bearer","refresh_token":"xxx","expiry":"2024-01-01T00:00:00Z"}
drive_id = xxxxxxxx
drive_type = personal

2. 启动备份服务

2.1 使用Docker Compose（推荐）

1. 下载docker-compose.yml至本地
2. 编辑文件中的环境变量（见下文"环境变量说明"）
3. 启动服务：

# 启动（后台运行）
docker-compose up -d

# 停止
docker-compose stop

# 重启
docker-compose restart

# 移除容器（保留数据卷）
docker-compose down

2.2 直接使用Docker命令

默认配置下（每日0点执行备份）启动容器：

docker run -d \
  --restart=always \
  --name actualbudget_backup \
  --mount type=volume,source=actualbudget-rclone-data,target=/config/ \
  -e ACTUAL_BUDGET_URL="[***]" \
  -e ACTUAL_BUDGET_PASSWORD="your-actual-password" \
  -e ACTUAL_BUDGET_SYNC_ID="your-sync-id" \
  rodriguestiago0/actualbudget-backup:latest

环境变量配置

必选环境变量

密码特殊字符处理：若密码含单引号（'），在docker-compose中需替换为两个单引号（''）。例如密码为Super'Pass，应写为ACTUAL_BUDGET_PASSWORD: 'Super''Pass'。

可选环境变量

高级环境变量（不建议随意修改）

配置方式扩展

使用.env文件

若需通过文件管理环境变量，可将变量写入.env文件并挂载至容器/.env路径：

docker run -d \
  --mount type=volume,source=actualbudget-rclone-data,target=/config/ \
  --mount type=bind,source=/path/to/your/.env,target=/.env \
  rodriguestiago0/actualbudget-backup:latest

使用Docker Secrets

敏感信息（如密码）可通过Docker Secrets传递，只需在环境变量名后添加_FILE并指向密钥文件路径：

docker run -d \
  --mount type=volume,source=actualbudget-rclone-data,target=/config/ \
  -e ACTUAL_BUDGET_PASSWORD_FILE=/run/secrets/actual-password \
  --secret source=actual-password,target=/run/secrets/actual-password \
  rodriguestiago0/actualbudget-backup:latest

配置优先级

环境变量加载顺序（从高到低）：

1. 容器运行时指定的环境变量（-e参数）
2. 环境变量_FILE指向的文件内容（如PASSWORD_FILE=/run/secrets/pw）
3. .env文件中定义的_FILE变量
4. .env文件中直接定义的环境变量

高级功能

• 多远程存储目标：同时备份至多个远程存储
• 多Sync ID备份：备份多个Actual Budget实例的Sync ID数据
• 手动触发备份：无需等待定时任务，立即执行备份
• 加密备份文件：启用端到端加密保护备份数据

许可证

本项目采用MIT许可证 - 详见LICENSE。