dockurr/portainer-backup

Portainer Backup

基于https://github.com/SavageSoftware/portainer-backup%E7%9A%84Fork%E7%89%88%E6%9C%AC%EF%BC%8C%E5%8C%85%E5%90%AB%E4%B8%80%E4%BA%9B%E5%B0%8Fbug%E4%BF%AE%E5%A4%8D%E5%92%8C%E4%BE%9D%E8%B5%96%E6%9B%B4%E6%96%B0%E3%80%82

特性 ✨

• 备份整个Portainer数据库
• 备份在Portainer web界面中创建的stack的docker-compose文件
• 支持使用密码保护归档文件

使用方法 🐳

通过Docker Compose：

yaml
services:
  portainer-backup:
    image: dockurr/portainer-backup
    container_name: portainer-backup
    command: schedule
    environment:
      TZ: "America/New_York"
      PORTAINER_BACKUP_URL: "http://portainer:9000"
      PORTAINER_BACKUP_TOKEN: "PORTAINER_ACCESS_TOKEN"
      PORTAINER_BACKUP_PASSWORD: ""
      PORTAINER_BACKUP_OVERWRITE: 1
      PORTAINER_BACKUP_SCHEDULE: "0 0 0 * * *"
      PORTAINER_BACKUP_STACKS: 1
      PORTAINER_BACKUP_DRYRUN: 0
      PORTAINER_BACKUP_CONCISE: 1
      PORTAINER_BACKUP_DIRECTORY: "/backup"
      PORTAINER_BACKUP_FILENAME: "portainer-backup.tar.gz"
    volumes:
      - ./backup:/backup
    restart: always

通过Docker CLI：

shell
docker run -it --rm \
  --name portainer-backup \
  --volume "${PWD:-.}/backup:/backup" \
  --env PORTAINER_BACKUP_URL="http://portainer:9000" \
  --env PORTAINER_BACKUP_TOKEN="YOUR_ACCESS_TOKEN" \
  dockurr/portainer-backup \
  backup

---

支持的命令与操作 ⚙️

此工具需要通过单个命令执行内置操作之一。

Backup

backup操作将对指定服务器执行一次Portainer数据备份。备份文件为TAR.GZ归档，可选择使用密码保护（--password）。操作完成后进程立即终止。

以下Docker命令将执行Portainer数据备份：

shell
docker run -it --rm \
  --name portainer-backup \
  --volume ${PWD:-.}/backup:/backup \
  --env TZ="America/New_York" \
  --env PORTAINER_BACKUP_URL="http://portainer:9000" \
  --env PORTAINER_BACKUP_TOKEN="PORTAINER_ACCESS_TOKEN" \
  --env PORTAINER_BACKUP_OVERWRITE=true  \
  --env PORTAINER_BACKUP_DIRECTORY=/backup \
  dockurr/portainer-backup:latest \
  backup

Test

test操作将对指定服务器执行一次Portainer数据备份，但不会将数据保存到文件系统。test操作等同于使用--dryrun选项。操作完成后进程立即终止。

以下Docker命令将执行Portainer数据测试备份：

shell
docker run -it --rm \
  --name portainer-backup \
  --volume ${PWD:-.}/backup:/backup \
  --env TZ="America/New_York" \
  --env PORTAINER_BACKUP_URL="http://portainer:9000" \
  --env PORTAINER_BACKUP_TOKEN="PORTAINER_ACCESS_TOKEN" \
  --env PORTAINER_BACKUP_DIRECTORY=/backup \
  dockurr/portainer-backup:latest \
  test

Schedule

schedule操作将对指定服务器执行持续的定时备份。--schedule选项或PORTAINER_BACKUP_SCHEDULE环境变量接受cron格式字符串定义备份计划。进程将持续运行，除非启动时验证步骤失败。

以下Docker命令将执行Portainer数据定时备份：

shell
docker run -it --rm \
  --name portainer-backup \
  --volume ${PWD:-.}/backup:/backup \
  --env TZ="America/New_York" \
  --env PORTAINER_BACKUP_URL="http://portainer:9000" \
  --env PORTAINER_BACKUP_TOKEN="PORTAINER_ACCESS_TOKEN" \
  --env PORTAINER_BACKUP_OVERWRITE=true  \
  --env PORTAINER_BACKUP_DIRECTORY=/backup \
  --env PORTAINER_BACKUP_SCHEDULE="0 0 0 * * *" \
  dockurr/portainer-backup:latest \
  schedule

Info

info操作将向指定Portainer服务器发送信息请求。操作完成后进程立即终止。

以下Docker命令将从Portainer获取信息：

shell
docker run -it --rm \
  --name portainer-backup \
  --env PORTAINER_BACKUP_URL="http://portainer:9000" \
  dockurr/portainer-backup:latest \
  info

Stacks

stacks操作将对指定服务器执行一次Portainer stacks的docker-compose数据备份。此操作不备份Portainer数据库/数据文件，仅备份stacks配置。也可通过backup操作中的--stacks选项包含stacks备份。操作完成后进程立即终止。

以下Docker命令将执行Portainerstacks备份：

shell
docker run -it --rm \
  --name portainer-backup \
  --volume ${PWD:-.}/backup:/backup \
  --env TZ="America/New_York" \
  --env PORTAINER_BACKUP_URL="http://portainer:9000" \
  --env PORTAINER_BACKUP_TOKEN="PORTAINER_ACCESS_TOKEN" \
  --env PORTAINER_BACKUP_OVERWRITE=true  \
  --env PORTAINER_BACKUP_DIRECTORY=/backup \
  dockurr/portainer-backup:latest \
  stacks

恢复

生成的备份文件可用于Portainer内置的恢复功能。详情参见：[***]

---

返回值

Portainer-backup进程退出后将返回数值。

---

命令行选项与环境变量

Portainer-backup支持通过命令行参数和环境变量配置所有选项。

注意： 如果同时配置了环境变量和命令行选项，命令行选项将优先生效。

---

调度表达式

Portainer-backup通过--schedule选项或PORTAINER_BACKUP_SCHEDULE环境变量接受cron格式字符串表达式定义备份计划。

注意： 支持的cron语法详情参见：https://github.com/node-cron/node-cron/blob/master/README.md#cron-syntax

语法格式：

    ┌──────────────────────── 秒（可选）
    │   ┌──────────────────── 分
    │   │   ┌──────────────── 时
    │   │   │   ┌──────────── 日
    │   │   │   │   ┌──────── 月
    │   │   │   │   │   ┌──── 周
    │   │   │   │   │   │
    │   │   │   │   │   │
    *   *   *   *   *   *

示例：

    0   0   0   *   *   *   每天午夜12:00
    0   0   5   1   *   *   每月1日凌晨5:00
    0 */15  0   *   *   *   每15分钟

允许的字段值

使用多值

使用范围

使用步长值

步长值可与范围结合使用，在范围后添加/和数字。例如：1-10/2等同于2,4,6,8,10。也可在星号后使用步长，如每2分钟执行可使用*/2。

使用名称

月和周字段也可使用名称或缩写名称。例如：

---

文件名与目录的日期/时间替换

Portainer-backup支持通过替换语法为目录和文件名选项动态分配日期时间元素。

所有替换预设和/或令牌使用双花括号包裹：{{ PRESET|TOKEN }}

示例：

  --filename "portainer-backup-{{DATE}}.tar.gz"

Portainer-backup使用https://moment.github.io%E5%BA%93%E8%A7%A3%E6%9E%90%E6%97%A5%E6%9C%9F%E6%97%B6%E9%97%B4%E8%AF%AD%E6%B3%95%E3%80%82%E6%9B%B4%E5%A4%9A%E4%BF%A1%E6%81%AF%E5%8F%82%E8%A7%81%EF%BC%9Ahttps://moment.github.io/luxon/#/formatting

所有日期时间均使用运行portainer-backup工具的系统本地时间渲染。也可在任何令牌前添加UTC_前缀以使用UTC时间。

文件名还会经过sanitize函数处理，去除不支持的字符：:替换为_，/替换为-。

支持的预设

portainer-backup定义了以下替换预设：

以下替换预设由https://moment.github.io%E5%BA%93%E6%8F%90%E4%BE%9B%E5%B9%B6%E8%A2%AB**portainer-backup**%E6%94%AF%E6%8C%81%EF%BC%9A （更多信息参见Luxon文档：https://moment.github.io/luxon/#/formatting?id=presets%EF%BC%89

（以下预设使用1983年10月14日13:30:23