huacnlee/gobackup

GoBackup 镜像文档

镜像概述和主要用途

GoBackup 是一款类似 https://github.com/backup/backup 的一站式备份工具，专为中小型服务器/个人服务器设计，配合 Crontab 可实现定时自动备份。通过简单的配置文件，可一次性完成数据库导出、文件归档、打包压缩，并将备份文件存储到本地、FTP、云存储等多种目的地。

详细中文介绍：Ruby China 专题 | https://gobackup.github.io/

核心功能和特性

主要特性

• 无依赖：无需额外安装依赖组件
• 多数据库支持：可备份多种类型数据库
• 多存储类型支持：支持本地及多种云存储服务
• 文件归档：将指定路径或文件打包为 tar 归档文件

支持状态详情

数据库

• MySQL
• PostgreSQL
• Redis（支持 sync/copy 模式）
• MongoDB

归档

通过 tar 命令将多个文件或路径归档为 .tar 文件

压缩器

• Tgz（生成 .tar.gz 文件）
• 无压缩（生成 .tar 文件）

加密器

• OpenSSL（采用 aes-256-cbc 加密算法）

存储服务

• 本地存储
• FTP
• SCP（通过 SSH 复制上传）
• Amazon S3
• 阿里云 OSS
• Google Cloud Storage
• Backblaze B2 Cloud Storage
• Cloudflare R2
• DigitalOcean Spaces
• 腾讯云 COS
• 优刻得 US3
• 七牛云 Kodo

使用场景和适用范围

适用于中小型服务器、个人服务器场景，需定期备份以下内容：

• 数据库（MySQL、PostgreSQL 等）数据
• 服务器配置文件（Nginx、Redis 等配置）
• 重要文件或目录
• 需要将备份文件存储到本地或多种云存储服务的场景

详细使用方法和配置说明

安装（macOS/Linux）

通过以下命令一键安装：

bash
curl -sSL https://git.io/gobackup | bash

安装完成后，可通过以下命令验证：

bash
gobackup -h

输出应类似：

NAME:
   gobackup - Easy full stack backup operations on UNIX-like systems

USAGE:
   gobackup [global options] command [command options] [arguments...]

VERSION:
   1.0.0

COMMANDS:
     perform
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

配置文件

GoBackup 会按以下路径查找配置文件：

• ~/.gobackup/gobackup.yml
• /etc/gobackup/gobackup.yml

配置示例

yaml
models:
  gitlab:
    compress_with:
      type: tgz  # 压缩类型：tgz 或 无压缩
    store_with:
      type: scp  # 存储类型：local/ftp/scp/s3 等
      path: ~/backup  # 存储路径
      host: your-host.com  # SCP 主机地址
      private_key: ~/.ssh/id_rsa  # SSH 私钥路径
      username: ubuntu  # 用户名
      password: password  # 密码（可选）
      timeout: 300  # 超时时间（秒）
    databases:
      gitlab:
        type: mysql  # 数据库类型：mysql/postgresql/redis/mongodb
        host: localhost
        port: 3306
        database: gitlab_production  # 数据库名
        username: root  # 用户名
        password:  # 密码（可选）
        additional_options: --single-transaction --quick  # 额外导出参数
      gitlab_redis:
        type: redis
        mode: sync  # 模式：sync/copy
        rdb_path: /var/db/redis/dump.rdb  # RDB 文件路径
        invoke_save: true  # 是否执行 SAVE 命令
        password:  # Redis 密码（可选）
    archive:
      includes:  # 需要归档的文件/目录
        - /home/git/.ssh/
        - /etc/mysql/my.conf
        - /etc/nginx/nginx.conf
        - /etc/nginx/conf.d
        - /etc/redis/redis.conf
        - /etc/logrotate.d/
      excludes:  # 排除的文件/目录
        - /home/ubuntu/.ssh/known_hosts
        - /etc/logrotate.d/syslog
  gitlab_repos:
    store_with:
      type: local
      path: /data/backups/gitlab-repos/  # 本地存储路径
    archive:
      includes:
        - /home/git/repositories  # 需要归档的仓库目录

执行备份

通过以下命令执行备份任务：

bash
gobackup perform

执行示例输出：

2017/09/08 06:47:36 ======== ruby_china ========
2017/09/08 06:47:36 WorkDir: /tmp/gobackup/1504853256396379166
2017/09/08 06:47:36 ------------- Databases --------------
2017/09/08 06:47:36 => database | Redis: mysql
2017/09/08 06:47:36 Dump mysql dump to /tmp/gobackup/1504853256396379166/mysql/ruby-china.sql
...
2017/09/08 06:48:04 ======= End ruby_china =======

定时备份配置

配合 Crontab 实现定时备份，编辑定时任务：

bash
crontab -e

添加以下内容（每天凌晨 0 点执行备份）：

bash
0 0 * * * /usr/local/bin/gobackup perform >> ~/.gobackup/gobackup.log

备份日志可通过以下命令查看：

bash
cat ~/.gobackup/gobackup.log

许可证

MIT 许可证