restic-backup-restore

镜像概述和主要用途

restic-backup-restore是一个基于Restic工具的Docker镜像，用于在AWS S3存储服务上初始化Restic仓库、将数据备份到该仓库以及从仓库恢复数据。通过环境变量配置所有参数，无需修改镜像内部即可灵活实现备份与恢复操作。

核心功能和特性

• 支持三种操作模式：初始化Restic仓库（init）、执行数据备份（backup）、执行数据恢复（restore）
• 通过环境变量完全配置化，包括AWS认证信息、Restic仓库参数、备份源/目标路径等
• 支持自定义备份参数（如排除文件、包含文件等）和旧备份清理策略（如保留时间、数量）
• 支持为备份添加标签和指定主机名，便于备份管理和识别
• 与AWS S3无缝集成，通过AWS访问密钥进行身份验证和数据传输

使用场景和适用范围

适用于需要将服务器数据、应用数据等备份到AWS S3的场景，尤其适合自动化备份流程（如定时任务）或需要快速部署备份/恢复能力的环境。建议用于对数据可靠性有要求，需要灵活控制备份保留策略的用户。注意：推荐S3 bucket不开启版本控制，因为Restic仓库文件的旧版本无实际用途。

使用方法和配置说明

前提条件

1. 创建用于存储备份的AWS S3 bucket（建议关闭版本控制）

操作步骤

1. 配置所有必要的环境变量
2. 初始化Restic仓库（仅需执行一次）
3. 根据需求执行备份或恢复操作

环境变量说明

Docker部署示例

1. 初始化Restic仓库（仅需一次）

docker run -e AWS_ACCESS_KEY_ID="your_aws_access_key" \
           -e AWS_SECRET_ACCESS_KEY="your_aws_secret_key" \
           -e AWS_DEFAULT_REGION="us-east-1" \
           -e FSBACKUP_MODE="init" \
           -e RESTIC_PASSWORD="your_repo_password" \
           -e RESTIC_REPOSITORY="s3:s3.amazonaws.com/your-bucket/restic" \
           silintl/restic-backup-restore

2. 执行数据备份

docker run -v /local/source/path:/source \  # 挂载本地源目录到容器内
           -e AWS_ACCESS_KEY_ID="your_aws_access_key" \
           -e AWS_SECRET_ACCESS_KEY="your_aws_secret_key" \
           -e AWS_DEFAULT_REGION="us-east-1" \
           -e FSBACKUP_MODE="backup" \
           -e RESTIC_PASSWORD="your_repo_password" \
           -e RESTIC_REPOSITORY="s3:s3.amazonaws.com/your-bucket/restic" \
           -e SOURCE_PATH="/source" \  # 容器内源目录路径（与挂载路径对应）
           -e RESTIC_TAG="daily-backup" \
           -e RESTIC_HOST="server01" \
           -e RESTIC_BACKUP_ARGS="--exclude=.git" \  # 排除.git目录
           -e RESTIC_FORGET_ARGS="--keep-daily 7 --keep-weekly 5" \  # 保留7天日备份、5周周备份
           silintl/restic-backup-restore

3. 执行数据恢复

docker run -v /local/target/path:/target \  # 挂载本地目标目录到容器内
           -e AWS_ACCESS_KEY_ID="your_aws_access_key" \
           -e AWS_SECRET_ACCESS_KEY="your_aws_secret_key" \
           -e AWS_DEFAULT_REGION="us-east-1" \
           -e FSBACKUP_MODE="restore" \
           -e RESTIC_PASSWORD="your_repo_password" \
           -e RESTIC_REPOSITORY="s3:s3.amazonaws.com/your-bucket/restic" \
           -e TARGET_PATH="/target" \  # 容器内目标目录路径（与挂载路径对应）
           silintl/restic-backup-restore

Docker Hub地址

该镜像在Docker Hub上自动构建，地址为：silintl/restic-backup-restore