Fred's Blog

四通八達

使用 GitHub Action 备份 Artalk 数据至仓库

Posted on # 教程向
On this page

今年我吃了不少因为数据未备份的亏,而且目前使用的 Artalk 是一个自托管的评论系统,数据存储在服务器上。评论数据一旦丢失很难找回,所以定期备份是一件很重要的事。目前,对我来说最适合存储类似 Artalk 数据的平台非 GitHub 莫属,而 GitHub 又提供 Actions,能够让我实现定期执行备份操作。故选择使用 GitHub Actions 将数据拉取到仓库。

写在前面

在 Artalk 文档中,提到了可以使用 artalk export ./artrans 的指令导出 Artrans 格式(本质为 JSON)。若出现故障,可以通过直接在新 Artalk 实例中导入这个文件快速恢复数据。且 Artrans 是单文件,可以很方便地储存在 GitHub 仓库中。故选择基于这个命令的方式进行备份。

配置仓库 Secret

在开始之前,你需要创建一个 SSH 密钥并记录下私钥。如果你是 1Panel 用户但不知道如何创建 SSH 密钥,可参考我之前的这篇文章。

创建一个 GitHub 仓库, 进入 Settings - Secrets and variables - Actions,添加以下变量:

仓库密钥设置页面

过程介绍

容器内导出

docker exec [容器名称] artalk export /data/artrans

docker exec 让命令在容器内部运行,所以 /data/artrans 是容器内的路径。你 docker run 时如果有 -v ./data:/data,它同时也对应宿主机的 ./data/artrans,但不能想当然地认为宿主机根目录下就有 /data/artrans。

将文件搬迁至宿主机

docker cp [容器名称]:/data/artrans /tmp/artrans

docker cp 是容器与宿主机之间传文件的标准方式,不依赖 volume 映射路径,最可靠。

从服务器拉到 Action Runner

scp -i /tmp/deploy_key -P $PORT user@ip:/tmp/artrans ./artalk/artalk-$(date +%Y%m%d).artrans

关键是要用 -i 指定私钥文件。Action 内部会处理好私钥,但它只在其内部生效;后续独立的 scp 命令是系统命令,并不知道 KEY Secret 的存在,必须自己把私钥写到文件再用 -i 指定。

把产物存进仓库

GitHub 托管的临时存储 Artifact 会存储从服务器中拉取的 Artrans 文件,默认 90 天过期。想要长期归档,最直接的方式是把文件 git push 回仓库。这需要给 workflow 显式声明写权限:

permissions:
  contents: write

因为 Action 默认只有读取仓库权限,若不加这一行直接 push 会返回 403。

最终 Action 配置文件

根据以上内容,我们便可以着手写 Action 文件,在我和蓝色大鲸鱼的共同努力下,写出了下方配置。

更新频率建议根据站点评论频率来决定,目前我的方案是一周一次。

Talk is cheap, show me the code!

name: Artalk Weekly Backup

on:
  schedule:
    - cron: '0 0 * * 1'  // 一周一次
  workflow_dispatch:

permissions:
  contents: write

jobs:
  backup:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Export Artrans inside container
        uses: appleboy/ssh-action@v1.2.5
        with:
          host: ${{ secrets.SERVER_IP }}
          username: ${{ secrets.USERNAME }}
          port: ${{ secrets.PORT }}
          key: ${{ secrets.KEY }}
          passphrase: ${{ secrets.PASSPHRASE }}
          script: |
            set -e
            docker exec [你的容器名称] artalk export /data/artrans
            docker cp [你的容器名称]:/data/artrans /tmp/artrans
            SIZE=$(stat -c%s /tmp/artrans)
            if [ "$SIZE" -lt 100 ]; then
              echo "ERROR: 备份产物异常,大小仅 ${SIZE} 字节。"
              exit 1
            fi
            echo "备份产物大小: ${SIZE} 字节"

      - name: Download artrans from server
        run: |
          echo "${{ secrets.KEY }}" > /tmp/deploy_key
          chmod 600 /tmp/deploy_key

          mkdir -p ./artalk
          scp -o StrictHostKeyChecking=no \
            -i /tmp/deploy_key \
            -P ${{ secrets.PORT }} \
            ${{ secrets.USERNAME }}@${{ secrets.SERVER_IP }}:/tmp/artrans \
            ./artalk/artalk-$(date +%Y%m%d).artrans

          rm -f /tmp/deploy_key

      - name: Cleanup remote temp file
        if: always()
        uses: appleboy/ssh-action@v1.2.5
        with:
          host: ${{ secrets.SERVER_IP }}
          username: ${{ secrets.USERNAME }}
          port: ${{ secrets.PORT }}
          key: ${{ secrets.KEY }}
          passphrase: ${{ secrets.PASSPHRASE }}
          script: |
            rm -f /tmp/artrans
            docker exec [你的容器名称] rm -f /data/artrans || true

      - name: Prune old backups (keep latest 5)
        run: |
          ls -1t ./artalk/artalk-*.artrans 2>/dev/null | tail -n +6 | xargs -r rm -f
          echo "当前备份文件:"
          ls -1 ./artalk/ || true

      - name: Commit and push backup to repository
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
          git add -A artalk/
          git commit -m "Artalk backup $(date +%Y-%m-%d)" || echo "No changes to commit"

          # 把本地提交 rebase 到远程最新提交之上,避免 push 被拒绝
          if ! git pull --rebase origin ${{ github.ref_name }}; then
            echo "::warning::检测到 rebase 冲突,使用本地备份文件版本"
            # rebase 中 theirs 指本地提交版本
            git checkout --theirs -- artalk/ 2>/dev/null || true
            git add artalk/
            if ! GIT_EDITOR=true git rebase --continue; then
              git rebase --abort
              echo "ERROR: 无法自动解决 rebase 冲突,请手动处理"
              exit 1
            fi
          fi

          git push

其中,请将 [你的容器名称] 内容替换为你的 Artalk 容器名称。

保存文件,推送。当以上内容完成之后,恭喜你🎉,你已经可以成功地实现定时备份 Artalk 内容啦!

本文完。

Comment