ethanchrisp/salvage

Salvage

!GitHub Workflow Status !Docker Pulls !Docker Image Size (tag)

Salvage将Docker Compose文件备份到GitHub并通知变更。

设置

尽管非必需，但建议使用*** Webhook接收通知。

无论选择哪种设置方式，Salvage均适用于任务调度器，如cron。

环境变量

• LOG_LEVEL：Loguru严重级别，用于输出到控制台。
• LOG_DISCORD_WEBHOOK_URL：*** Webhook URL，用于接收日志事件。
• LOG_DISCORD_WEBHOOK_LEVEL：转发到***的最低Loguru严重级别。
• GITHUB_ACCESS_TOKEN（必填）：GitHub的https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic%E3%80%82
• GITHUB_REPOSITORY（必填）：用于存储备份的私有GitHub仓库名称。
• DISCORD_WEBHOOK_URL：*** Webhook URL，用于接收变更通知。
• GLOB_PATTERNS：用于本地文件发现的逗号分隔路径模式。默认值为**/compose.yaml。
• PROJECTS_DIRECTORY：存储项目的目录。默认值为./projects。

Docker（推荐）

修改以下compose.yaml示例文件，然后运行docker compose up。

yaml
services:
  salvage:
    container_name: salvage
    image: ethanchrisp/salvage:latest
    environment:
      LOG_LEVEL: INFO
      LOG_DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/YYYYYYYY/YYYYYYYY
      LOG_DISCORD_WEBHOOK_LEVEL: WARNING
      GITHUB_ACCESS_TOKEN: XXXXXXXX
      GITHUB_REPOSITORY: XXXXXXXX
      DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/XXXXXXXX/XXXXXXXX
    volumes:
      - /home/username/projects:/salvage/projects:ro

独立运行

Salvage适用于Python 3.13或更高版本。

1. 使用https://github.com/astral-sh/uv%E5%AE%89%E8%A3%85%E6%89%80%E9%9C%80%E4%BE%9D%E8%B5%96%EF%BC%9A%60uv sync`
2. 将.env.example重命名为.env，然后配置环境变量。
3. 确保项目目录包含Docker Compose文件。
4. 启动Salvage：python salvage.py