pathwaycommons/rethinkdb-backup

rethinkdb-backup镜像说明

镜像概述

本镜像基于NodeJS构建，用于实现RethinkDB数据库的备份功能。它支持将数据导出为压缩存档，并可与rClone等文件同步服务集成，将备份文件复制到远程存储。同时提供Web服务端点，方便用户管理备份文件。

核心功能

1. 事件驱动备份：监听RethinkDB factoid数据库document表的变化（新增、状态更新为public等）触发备份；
2. 压缩存档：备份数据以<DB_NAME>_dump_<DATETIME>.tar.gz格式压缩存储；
3. 同步集成：支持与rClone等同步服务对接，将备份文件复制到远程存储；
4. Web管理端点：提供/（列出备份）、/backup（触发备份，需API密钥）、/<dump name>（下载备份）等HTTP接口；
5. 批量备份控制：可配置备份延迟时间，避免短时间内频繁触发备份。

使用场景

• 需要对RethinkDB数据进行事件驱动或手动触发备份的场景；
• 需要将RethinkDB备份文件同步到远程存储（如云盘）的场景；
• 需要通过Web接口快速查看、下载或触发备份的场景。

配置说明

通过环境变量配置镜像，主要参数分类如下：

通用配置

• NODE_ENV：运行环境（production/development，默认development）；
• PORT：Web服务端口（默认3000）；
• LOG_LEVEL：日志级别（info/warn/error，默认info）；
• DUMP_DIRECTORY：备份文件存储目录（默认archives）；
• API_KEY：保护/backup端点的API密钥（可选）。

数据库配置

• DB_NAME：目标数据库名称（默认factoid）；
• DB_HOST：RethinkDB主机地址（默认localhost）；
• DB_PORT：RethinkDB端口（默认28015）；
• DB_USER：数据库用户名（可选）；
• DB_PASS：数据库密码（可选）；
• DB_CERT：TLS证书路径（若数据库启用TLS，可选）。

备份配置

• DUMP_DATE_FORMAT：备份文件名的日期格式（默认yyyy-MM-dd_HH-mm-ss-SSS）；
• BACKUP_DELAY_MIN：触发备份前的延迟时间（分钟，默认180）。

同步服务配置

• SYNC_ENABLED：是否启用同步服务（默认true）；
• SYNC_HOST：同步服务主机（默认localhost）；
• SYNC_PORT：同步服务端口（默认5572）；
• SYNC_LOGIN：同步服务用户名（可选）；
• SYNC_PASSWORD：同步服务密码（可选）；
• SYNC_CMD：同步命令（如rClone的sync/copy）；
• SYNC_SRC：同步源路径（如drive:src）；
• SYNC_DST：同步目标路径（如drive:dst）。

Docker部署示例

Docker Run命令

bash
docker run -d \
  --name rethinkdb-backup \
  -p 3000:3000 \
  -e DB_HOST=your-rethinkdb-host \
  -e DB_NAME=your-db-name \
  -e SYNC_ENABLED=true \
  -e SYNC_HOST=rclone-host \
  -v ./backup-archives:/app/archives \
  docker.xuanyuan.run/pathwaycommons/rethinkdb-backup

Docker Compose示例

yaml
version: '3'
services:
  rethinkdb-backup:
    image: pathwaycommons/rethinkdb-backup
    ports:
      - "3000:3000"
    environment:
      DB_HOST: rethinkdb
      DB_NAME: factoid
      PORT: 3000
      SYNC_ENABLED: "true"
      SYNC_HOST: rclone
    volumes:
      - ./backup-archives:/app/archives
    depends_on:
      - rethinkdb
      - rclone

  rethinkdb:
    image: rethinkdb:2.3
    ports:
      - "28015:28015"
      - "8080:8080"

  rclone:
    image: rclone/rclone:latest
    volumes:
      - ./rclone-config:/config/rclone
    command: rcd --rc-addr=0.0.0.0:5572 --rc-user=user --rc-pass=pass