Docker-Backup 技术文档

Docker-Backup 技术文档

docker-backup A tool to create & restore complete, self-contained backups of Docker containers 项目地址: https://gitcode.com/gh_mirrors/do/docker-backup

1. 安装指南

环境要求

• Go 1.11 或更高版本
• Docker 18.02 (API version 1.36) 或更新版本

安装步骤

从源码安装

1. 克隆项目仓库：

   git clone https://github.com/muesli/docker-backup.git
   

2. 进入项目目录：

   cd docker-backup
   

3. 编译项目：

   go build
   

使用包管理器安装

• Arch Linux:

  pacman -S docker-backup
  

2. 项目使用说明

创建备份

备份单个容器

使用 backup 命令并提供容器ID：

docker-backup backup <container ID>

这将创建一个 .json 文件，包含容器的元数据，以及一个文件，包含所有需要备份的卷。

直接创建 .tar 文件

docker-backup backup --tar <container ID>

备份所有运行中的容器

docker-backup backup --all

备份所有容器（包括停止的容器）

docker-backup backup --all --stopped

直接启动备份程序

docker-backup backup --all --launch "restic -r /dest backup --password-file pwfile --tag %tag --files-from %list"

恢复备份

恢复容器

docker-backup restore <backup file>

docker-backup 会自动检测你提供的 .tar 或 .json 文件，并恢复容器及其端口映射和数据卷。

恢复后启动容器

docker-backup restore --start <backup file>

3. 项目API使用文档

命令行接口

备份命令

• backup <container ID>: 备份指定容器。
• backup --tar <container ID>: 创建 .tar 文件备份。
• backup --all: 备份所有运行中的容器。
• backup --all --stopped: 备份所有容器（包括停止的容器）。
• backup --all --launch <command>: 直接启动备份程序。

恢复命令

• restore <backup file>: 恢复指定备份文件。
• restore --start <backup file>: 恢复并启动容器。

4. 项目安装方式

从源码安装

1. 克隆项目仓库：

   git clone https://github.com/muesli/docker-backup.git
   

2. 进入项目目录：

   cd docker-backup
   

3. 编译项目：

   go build
   

使用包管理器安装

• Arch Linux:

  pacman -S docker-backup
  

通过以上步骤，您可以成功安装并使用 docker-backup 工具来备份和恢复 Docker 容器。

docker-backup A tool to create & restore complete, self-contained backups of Docker containers 项目地址: https://gitcode.com/gh_mirrors/do/docker-backup