southclaws/restic-robot
southclaws
自动构建
Restic Robot是Restic的轻量级包装应用，提供自动化备份功能，包括自动创建仓库、定时备份、Prometheus指标监控、JSON日志及前后脚本钩子，无需系统级Cron即可实现可靠备份。
下载次数: 0状态：自动构建维护者：southclaws仓库类型：镜像最近更新：4 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
Restic Robot
由机器人高效完成的备份解决方案！
这是一个针对https://github.com/restic/restic/%E7%9A%84%E8%BD%BB%E9%87%8F%E7%BA%A7%E5%8C%85%E8%A3%85%E5%BA%94%E7%94%A8%EF%BC%8C%E4%B8%BB%E8%A6%81%E6%8F%90%E4%BE%9B%E4%BB%A5%E4%B8%8B%E5%8A%9F%E8%83%BD%EF%BC%9A
- 自动创建仓库（若仓库不存在）
- 定时备份 - 无需系统级Cron
- Prometheus指标 - 实时监控备份状态
- JSON日志 - 便于机器处理
- 前后置Shell脚本钩子 - 支持自定义行为（感谢@opthomas-prime！）
核心功能与特性
- 自动化仓库管理：首次运行时自动初始化Restic仓库，无需手动操作
- 灵活的定时备份：通过Cron表达式配置备份频率，摆脱系统Cron依赖
- 全面监控指标：集成Prometheus指标，跟踪备份成功率、时长、文件变化等关键数据
- 结构化日志：输出JSON格式日志，便于日志聚合和分析
- 自定义工作流：支持备份前后执行Shell命令，满足个性化需求（如备份前清理临时文件、备份后发送通知）
使用场景
- 服务器数据定期备份
- 容器化应用数据保护
- 需要监控备份状态的关键业务系统
- 需自定义备份流程的场景（如数据库备份前执行dump操作）
使用方法
直接运行
可通过go build编译后直接运行，或使用Docker镜像：southclaws/restic-robot
环境变量配置
| 环境变量 | 说明 |
|---|---|
SCHEDULE | Cron调度表达式（用于设置备份频率） |
RESTIC_REPOSITORY | Restic仓库名称 |
RESTIC_PASSWORD | 仓库加密密码 |
RESTIC_ARGS | 备份命令的额外参数（如指定备份目录） |
RUN_ON_BOOT | 启动时是否立即执行一次备份 |
PROMETHEUS_ENDPOINT | Prometheus指标暴露端点 |
PROMETHEUS_ADDRESS | 指标服务监听地址（格式：host:port） |
PRE_COMMAND | 备份开始前执行的Shell命令 |
POST_COMMAND | 备份成功后执行的Shell命令 |
Prometheus指标
| 指标名称 | 说明 |
|---|---|
backups_all_total | 尝试备份的总次数（含失败） |
backups_successful_total | 成功的备份次数 |
backups_failed_total | 失败的备份次数 |
backup_duration_milliseconds | 备份持续时间（毫秒） |
backup_files_new | 新增文件数量 |
backup_files_changed | 修改文件数量 |
backup_files_unmodified | 未修改文件数量 |
backup_files_processed | 扫描的文件总数 |
backup_added_bytes | 添加到仓库的总字节数 |
backup_processed_bytes | 扫描的总字节数 |
Docker Compose部署示例
将以下配置添加到您的Compose文件中，即可快速集成备份功能：
ymlservices: # # 其他服务配置... # backup: image: southclaws/restic-robot restart: always environment: # 每天凌晨2点执行备份 SCHEDULE: 0 0 2 * * * RESTIC_REPOSITORY: my_service_repository RESTIC_PASSWORD: ${MY_SERVICE_RESTIC_PASSWORD} # restic-robot会执行`restic backup ${RESTIC_ARGS}` # 此处指定备份目录及其他参数 RESTIC_ARGS: /data # 若使用Backblaze B2等存储后端，需添加对应环境变量 B2_ACCOUNT_ID: ${B2_ACCOUNT_ID} B2_ACCOUNT_KEY: ${B2_ACCOUNT_KEY} volumes: # 挂载需要备份的目录到容器内 # 可安全地将同一目录挂载到多个容器 - "/container_data/blog/wordpress:/data/wordpress"
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 restic-robot 镜像标签
docker pull docker.xuanyuan.run/southclaws/restic-robot:<标签>
DockerHub 原生拉取命令
docker pull southclaws/restic-robot:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"