caomeiyouren/auto-backup-database repository overview

# 使用 pnpm
pnpm install

# 使用 npm
npm install

oss:
  region: "${OSS_REGION}"
  accessKeyId: "${OSS_ACCESS_KEY_ID}"
  accessKeySecret: "${OSS_ACCESS_KEY_SECRET}"
  bucket: "${OSS_BUCKET}"
  endpoint: "${OSS_ENDPOINT}"

security:
  backupPassword: "${BACKUP_PASSWORD}"

projects:
  - name: my-app-db
    dbType: sqlite
    dbPath: "/data/apps/my-app/*.db" # 支持 Glob 语法
    backupSchedule: "0 2 * * *" # 每天凌晨 2 点
    compress:
      enabled: true
      password: true # 使用环境变量中的 BACKUP_PASSWORD 加密
    retention:
      local:
        days: 7
        maxSize: 2GB
      remote:
        days: 30
        maxSize: 10GB
    options:
      localEnabled: true
      remoteEnabled: true

  - name: mongo-prod
    dbType: mongodb
    connection:
      uri: "${MONGODB_URI}"
      database: "${MONGODB_DATABASE:-app}"
    dumpOptions:
      archive: true
      authenticationDatabase: "${MONGODB_AUTH_DB:-admin}"
      extraArgs: []
    backupSchedule: "0 3 * * *"
    compress:
      enabled: true
      password: true
    retention:
      local:
        days: 7
        maxSize: 5GB
      remote:
        days: 30
        maxSize: 20GB
    options:
      localEnabled: true
      remoteEnabled: true

  - name: mysql-prod
    dbType: mysql
    connection:
      uri: "${MYSQL_URI}"
      database: "${MYSQL_DATABASE:-app}"
    dumpOptions:
      singleTransaction: true
      quick: true
      routines: true
      events: true
      extraArgs: []
    backupSchedule: "0 3 * * *"
    compress:
      enabled: true
      password: true
    retention:
      local:
        days: 7
        maxSize: 5GB
      remote:
        days: 30
        maxSize: 20GB
    options:
      localEnabled: true
      remoteEnabled: true

  - name: postgres-prod
    dbType: postgresql
    connection:
      uri: "${POSTGRESQL_URI}"
      database: "${POSTGRESQL_DATABASE:-app}"
    dumpOptions:
      format: custom
      compression: 0
      noOwner: true
      extraArgs: []
    backupSchedule: "0 4 * * *"
    compress:
      enabled: true
      password: true
    retention:
      local:
        days: 7
        maxSize: 5GB
      remote:
        days: 30
        maxSize: 20GB
    options:
      localEnabled: true
      remoteEnabled: true

  - name: my-files
    dbType: file # 通用备份模式：直接备份指定的文件或文件夹
    paths: # 支持 Glob 语法，可混合文件和目录
      - "/data/apps/my-app/config"
      - "/data/archives/*.zip"
    backupSchedule: "0 1 * * *"
    compress:
      enabled: true
      password: true
      skipExtensions: [".zip", ".tar.gz"] # 已压缩文件扩展名白名单（可选，默认内置常见压缩格式）
    retention:
      local:
        days: 7
        maxSize: 2GB
      remote:
        days: 30
        maxSize: 10GB
    options:
      localEnabled: true
      remoteEnabled: true

# 通知配置（可选）
notify:
  enabled: true
  type: Dingtalk # 支持多种推送方式，详见 push-all-in-one
  config:
    DINGTALK_ACCESS_TOKEN: "${DINGTALK_ACCESS_TOKEN}"
    DINGTALK_SECRET: "${DINGTALK_SECRET}"

# OSS 配置（支持阿里云 OSS、腾讯云 COS、AWS S3 等）
OSS_REGION=oss-cn-hangzhou
OSS_ACCESS_KEY_ID=your-access-key-id
OSS_ACCESS_KEY_SECRET=your-access-key-secret
OSS_BUCKET=your-bucket-name
OSS_ENDPOINT=https://oss-cn-hangzhou.aliyuncs.com

# 备份加密密码（可选）
BACKUP_PASSWORD=your-secure-password

# MongoDB（可选）
MONGODB_URI=mongodb://username:[email protected]:27017/app?authSource=admin
MONGODB_DATABASE=app
MONGODB_AUTH_DB=admin

# MySQL（可选）
MYSQL_URI=mysql://root:[email protected]:3306
MYSQL_DATABASE=app

# PostgreSQL（可选）
POSTGRESQL_URI=postgresql://postgres:[email protected]:5432
POSTGRESQL_DATABASE=app

# 通知配置（可选）
DINGTALK_ACCESS_TOKEN=your-token
DINGTALK_SECRET=your-secret

# 启动调度器（默认模式）
pnpm run start

# 单次执行所有项目备份
pnpm run start -- -m once

# 单次执行指定项目备份
pnpm run start -- -m once -p my-app-db

# 指定配置文件
pnpm run start -- -c /path/to/config.yml -e /path/to/.env

# 构建并启动
docker-compose up -d

# 查看日志
docker-compose logs -f

# 构建镜像
docker build -t auto-backup-database .

# 运行容器
docker run -d \
  --name auto-backup-database \
  -v $(pwd)/config:/app/config:ro \
  -v $(pwd)/backups:/app/backups \
  -v /path/to/databases:/app/data:ro \
  auto-backup-database

# 开发模式
pnpm run dev

# 构建
pnpm run build

# 代码检查
pnpm run lint

# 运行测试
pnpm run test

# 提交代码
pnpm run commit

src/
├── cli.ts              # CLI 入口
├── index.ts            # 模块导出
├── config/
│   └── loader.ts       # 配置加载器
├── providers/
│   ├── database.ts     # 数据库提供者抽象类
│   ├── mongodb.ts      # MongoDB 提供者
│   ├── mysql.ts        # MySQL 提供者
│   ├── postgresql.ts   # PostgreSQL 提供者
│   └── sqlite.ts       # SQLite 提供者
├── services/
│   ├── backup.ts       # 备份服务
│   └── scheduler.ts    # 调度服务
├── storage/
│   ├── local.ts        # 本地存储
│   └── oss.ts          # OSS 存储
├── notify/
│   └── index.ts        # 通知服务
├── types/
│   └── config.ts       # 配置类型定义
└── utils/
    ├── compress.ts     # 压缩工具
    └── encrypt.ts      # 加密工具