hermes

Hermes (赫尔墨斯)

基于 Rclone 的轻量级云端备份自动化管家

Hermes 取名自希腊神话中的信使。它是一套高效的备份工具集，旨在通过简单的配置实现多项目、多远端的自动化备份。

📖 概述

项目由两个核心组件组成：

• hermes-backup 后台守护进程：基于 config.yaml 配置文件，借助 rclone 定时完成云端备份任务。
• hermes 终端命令行工具：提供备份项目管理、配置查看/编辑、服务控制及手动触发备份的能力。

📦 安装

1. 获取并运行脚本：

   curl -fsSL https://hermes.elysiapro.cn/install.sh | bash
   

   安装脚本会将最新的 hermes-backup 与 hermes 下载到 ~/.local/bin。

2. 手动下载：也可以从 GitHub Releases 下载对应平台的二进制文件。

---

🚀 使用指南

1. 配置管理 (Config)

用于管理基础运行环境。

• 参数说明：--config 默认为可执行文件同目录下的 config.yaml。
• 查看配置：hermes config show [--config path]。
• 编辑配置：hermes config edit [--config path]。

2. 项目管理 (Project)

管理具体的备份任务。

• 参数说明：--config 默认逻辑同上。
• 列表查看：hermes project list (或 ls)。
• 增删改查：
  • hermes project add [--config path]：添加新备份项目。
  • hermes project update <name> [--config path]：更新现有项目。
  • hermes project delete <name> [--config path] ：删除指定项目。

3. 后台管理 (Server)

控制守护进程的运行状态。

• 参数说明：
  • --binary：默认为 hermes 所在目录下的 hermes-backup。
  • --config：默认逻辑同上。
• 控制命令：
  • hermes server start [--config path] [--binary path]：启动后台守护进程。
  • hermes server stop [--config path] [--binary path]：停止后台服务。
  • hermes server restart [--config path] [--binary path]：重启后台服务。

4. 备份触发 (Backup)

手动强制执行备份任务。

• 手动触发：hermes backup run --projects <name1,name2>。
• 注意：多个项目名称请使用英文逗号分隔。

---

📄 配置文件示例 (config.yaml)

logging:
  path: /hermes/logs/service.log # 运行日志存储位置
  debug: true # 是否在终端同步打印日志

defaults:
  rclone_remote: aliyun # 默认 rclone 配置名
  bucket: racknerd-vps # 默认桶名称
  cron: 0 1 * * * # 默认执行定时
  mode: copy # 默认同步模式: copy/sync

projects:
  - name: vaultwarden # 项目名称
    mode: sync # 该项目的同步模式
    source_paths: # 需要同步的源路径列表
      - /opt/vaultwarden/data
    cron: 0 2 * * * # 项目独立定时
    rclone_remotes: # 远端配置
      - name: aliyun
        bucket: racknerd-vps

---

#