Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Docker 应用备份

部署(不用下载源码)

镜像由 GitHub Actions 自动构建,支持 amd64 / arm64 / armv7:ghcr.io/lu8010252/docker-backup:latest

  1. 在服务器上新建一个文件夹(如 1Panel 的 /opt/1panel/apps/docker-backup),把本仓库的 docker-compose.yml 内容保存进去 (或在 1Panel「容器 → 编排 → 创建编排」里直接粘贴)。
  2. 把 AUTH_USER / AUTH_PASS / NOTIFY_URL 的 CHANGE_ME 改成自己的值;按需修改备份输出目录(默认 /opt/docker-backups)。
  3. 启动:docker compose up -d,访问 http://IP:8800 。
  4. 更新:docker compose pull && docker compose up -d(1Panel 里对应「拉取镜像 → 重建」)。设置数据保存在 ./config,更新不会丢。

第一次使用时,如果拉取镜像提示无权限/找不到,说明镜像还没设为公开,见文末「镜像拉取失败」。

想自己改代码、本地构建:克隆仓库后把 compose 里的 image: 一行换成 build: .,再 docker compose up -d --build。

架构

基础镜像 python:3.12-alpine 支持 amd64 / arm64 / armv7,在目标机器上直接 build 即可, Armbian、Debian、Ubuntu、群晖等只要装了 Docker 都能用,无需改动。

备份策略

  • 第一次为完整备份,之后为增量(只打包新增/修改的文件),每 N 次增量自动再做一次完整备份。
  • 只保留最近 M 组(完整 + 其增量),旧的自动删除;设置页可改 N 和 M。
  • 备份目录结构: 应用名/时间戳/{data.tar.gz, images.tar(仅个人应用的完整备份), meta.json} 隐藏目录 .state 是增量快照,不需要同步到网盘(丢了下次会自动做完整备份)。
  • 还原到某个时间点 = 先解压完整备份,再按顺序叠加到该点的增量。删除完整备份会连带删除依赖它的增量。
  • 还原不会删除“备份后被删掉的文件”(宁可多留,不误删)。

脱离本程序/1Panel 还原(重要)

每个备份目录里都有自包含的 restore.sh(docker run 型应用还有 containers.sh), 只需要 root、docker、GNU tar,不需要 docker-backup、不需要 1Panel:

sh 应用名/时间戳/restore.sh
sh 应用名/时间戳/restore.sh --map /opt/1panel/apps=/srv/apps   # 换路径(自动改 compose/.env 里的路径)
sh 应用名/时间戳/restore.sh --no-images                        # 不加载镜像

脚本会: 停旧容器 → 创建外部网络(如 1panel-network) → 加载镜像(CPU 架构不同则跳过,改为拉取) → 依次解压完整备份+增量 → docker compose up -d(或 docker run)。 数据是标准 tar.gz,镜像是标准 docker save,手动 tar -xzpf 也能解开。 同一应用的各时间戳目录请一起保存/同步,不要单独挪走其中一个。

在新机器上用本程序还原

  1. 新机器部署本程序,把备份目录(整个 应用名/时间戳 结构)拷到/挂载到 /backups。
  2. 打开「备份」页 → 点某个时间点的「还原到此」→ 可填「新路径」实现自定义还原路径,再点开始。
  3. 新路径必须让程序能写入: 要么在 docker-compose.yml 里挂载(宿主机路径=容器内路径), 要么启用「宿主机模式」(取消注释 privileged / pid: host,并设置 HOST_BACKUP_DIR),此时新路径可以是宿主机任意路径。

多路径自定义还原(飞牛/群晖/裸机通用)

还原窗口会把备份里涉及的每一个原路径单独列一行,右边填新路径即可,留空就还原回原位置。 不再要求所有路径共用一个前缀 —— 比如原来分别在 /opt/1panel/apps/typecho/usr 和 /opt/1panel/docker/compose/typecho, 可以分别改成 /vol1/docker/typecho/usr 和 /vol1/docker/typecho/compose,互不影响。 也可以在上方"统一放到目录"里填一个目录(如 /vol1/docker),点"一键填入", 会按每个原路径最后一段自动填好,再按需微调。 Docker 命名卷(路径形如 /var/lib/docker/volumes/...)不支持改名,原样还原。

校验备份

「备份」页每条记录旁的"校验"按钮,会检查 data.tar.gz / images.tar 是否完整、没有损坏(不会真的解压覆盖数据), 适合定期抽查,或者在准备迁移前先确认这份备份可用。

日志

「日志」页保存每次备份/还原/校验的完整记录,可展开查看,支持清空,保留条数在设置页可调(默认 30 条,0 = 不清理)。 首页顶部的小圆点会显示当前有没有任务在跑。

多服务器

在「设置」页底部添加其它已部署本程序的服务器(地址+账号密码),顶部下拉框切换后, 应用/备份/日志/设置这几页都会转发到选中的服务器,可以在一个页面里管理多台机器。 这份服务器列表只保存在你打开的这台机器的 /config 里,不会同步给被添加的服务器。

已修复: 备份自身导致体积暴涨

早期版本如果把 docker-backup 自己也勾选备份,会把它自己的备份输出目录当成数据打包进去, 每次都比上次更大。现在会自动识别并跳过自己容器挂载的 /backups 和 /config,不受影响。 如果之前已经产生过异常巨大的备份,建议直接在「备份」页把那几条删掉,重新备份一次即可。

再次修复: 自身排除逻辑改为更可靠的方式(2026-09-29)

上一版的自排除依赖容器内执行 docker inspect $HOSTNAME,如果这条命令第一次运行时因任何原因 失败(网络模式、hostname 被覆盖等),结果会被记住且不会重试,导致整次运行排除失效; 另外如果这个应用的 compose 工作目录被识别成了一个很大的上级目录(比如 /opt 本身), 之前的方案也无法处理"备份目录是这个上级目录的子目录"的情况。 现在改为直接比较文件系统的设备号+inode: 不管 /backups 挂载点是从哪条路径被看到的 (哪怕是绕道 /opt 这种更大的挂载点),只要底层是同一个目录就能识别并自动跳过, 且每次备份都重新判断,不会被一次性失败锁死。 如果你之前已经产生过异常巨大的备份,请先在「备份」页删掉,再重新备份一次确认体积恢复正常。

第三次修复: 工作目录/挂载源等于整个根目录时直接跳过(2026-09-29)

如果某个应用的 docker-compose.yml 没有放在专属子文件夹里(比如直接放在 /opt 根目录下), Docker 会把它的"工作目录"识别成 /opt 本身,导致备份时把 /opt 下所有其它应用都打包进来。 现在遇到工作目录或挂载源精确等于 /opt、/var/lib/docker/volumes 等一批已知过大的根目录时, 会直接跳过并在日志里提示,不会再整个打包。 但更根本的解决办法,是给该应用的 compose 文件建一个专属子文件夹(和其它应用一样), 例如把 /opt/docker-compose.yml 移到 /opt/docker-backup-app/docker-compose.yml, 重新 up -d,这样它的工作目录就会收窄为这个专属子文件夹,和其它应用行为一致。

下载与批量下载(2026-09-30)

「备份」页每条记录有「下载」按钮,左侧勾选多条后点「批量下载」,会流式打成一个 .tar(不占服务器临时空间)。 包内保持 应用名/时间戳/ 目录结构,解开后其中的 restore.sh 仍可直接使用。 默认勾选「下载时附带还原所需的完整备份/前置增量」:下载某个增量时会自动带上它依赖的完整备份和之前的增量,重复的只打一次;取消勾选则只下载所选的那几个。 顶部选了其它服务器时,下载会通过本机转发过来(流式,不占内存)。页面上还有「批量删除」和按应用名筛选。

外观

右上角按钮可一键切换浅色/深色。「设置 → 外观」里可选「跟随时间 / 始终浅色 / 始终深色」,设置只保存在当前浏览器。

搜索框被自动填入账号

浏览器把 Basic 认证保存的账号误当成搜索框内容填进去了。搜索框已加 autocomplete=off 和聚焦后才可编辑的处理, 设置页服务器表单的密码框也改为 new-password,浏览器不会再把它当登录框。

通知(ntfy)

「设置 → 通知」里开启后,每次备份/还原/校验(包括定时备份)结束都会推送到 ntfy: 成功 ✅(普通优先级)、有错误 ❌(高优先级,附前几条错误信息和耗时)。可选「只通知失败」。 docker-compose.yml 里的 NOTIFY_URL 是默认地址(例如 https://ntfy.example.com/notice,留空则不设默认),页面里改了以页面为准。 服务器名称显示在标题里,多台服务器各自设置、各自推送,建议给每台起个名字方便区分。 ntfy 开了权限控制时,填访问令牌(Bearer);令牌保存后不会再回显,留空=不改,填 - 清除。 「发送测试通知」按钮用表单里当前的内容发送,不用先保存。发送失败只写容器日志,不影响备份本身。

导出源文件 / 导出数据(2026-10-02)

「应用」页勾选应用后:

  • 导出源文件:下载一个 zip,只含 compose / .env / Dockerfile / 配置 / 代码,不含数据目录(挂载的目录和命名卷),可以直接发给别人。 .env、compose 文件(和 docker run 型应用生成的 docker-run.sh)里名字像密码/令牌的变量(含 PASS、SECRET、TOKEN、KEY、AUTH、NOTIFY 等)会替换成 CHANGE_ME, URL 里的 user:密码@ 也会脱敏;包里的 README-部署说明.txt 会列出镜像、被脱敏的变量名、没打进来的数据目录。 规则:挂载的目录算数据、不打包;挂载的单个文件(如 nginx.conf)算配置、会打包;单个文件超过 10MB 跳过。 其它配置文件(config.json、*.conf 等)不做脱敏,分享前请自己再看一眼。
  • 导出数据:只含挂载的目录和命名卷,实时流式打成 .tar.gz(不占服务器临时空间),遵守设置里的排除规则,并自动跳过本程序自己的备份/设置目录。 还原回原位置:tar -xzpf 文件.tar.gz -C /。勾选「备份时临时停止容器」时,导出期间容器会一直停着,下载结束或取消后自动启动。
  • 注意:普通备份包里的 meta.json 和 data.tar.gz 含有原样的环境变量(包括密码),不要直接分享,要分享请用「导出源文件」。

增量备份怎么用

增量包只含上一次备份之后新增/修改的文件,不能单独使用,要配合它所属的完整备份(备份页里写着“基于 xxx”)。 还原到某个时间点 = 先解完整备份,再按时间顺序叠加到该点的所有增量。网页里点「还原」会自动完成; 脱离本程序时,把同一应用的所有时间戳文件夹放在同一目录,运行 sh 时间戳/restore.sh 即可,或手动依次 tar -xzpf data.tar.gz -C /。

备份范围开关(2026-10-02)

「应用」页每个应用有一列「备份范围」,可选:

  • 应用+数据(默认):和以前一样。
  • 只备份应用:只打包 compose / .env / Dockerfile / 配置 / 代码,挂载的数据目录和命名卷全部跳过(单个文件的挂载算配置,仍会备份)。 适合数据库等已经用别的方式备份(如 1Panel 的 .sql)的应用,也不用再为它停容器。
  • 只备份数据:只打包挂载的目录和命名卷,不含 compose 和配置,也不备份镜像。 这类备份的 restore.sh 只还原数据并启动原来的容器,应用本身需要先用源文件部署好。 手动备份的范围在应用列表里按应用选择;自动备份在「设置 → 自动备份」里用列表勾选要备份的应用,并给每个应用单独选范围(应用+数据 / 只应用 / 只数据),没勾选的不会自动备份。 备份页的记录上会标「仅应用」/「仅数据」。 改了范围后,下一次备份会自动做一次完整备份(不接在旧的增量链后面)。

镜像拉取失败

  • 提示 unauthorized / not found:镜像还是私有的。仓库所有者到 GitHub 个人主页 → Packages → 点开该镜像 → Package settings → Change visibility 设为 Public(只需设置一次)。
  • 国内服务器拉 ghcr.io 很慢或超时:换用能访问 ghcr.io 的机器拉取后 docker save / docker load,或给 Docker 配置镜像加速/代理。

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages