GitBack

本项目主仓库托管在 cnb.cool/mmdjiji/GitBack，请在该平台提交 Issue 和 Pull Request。GitHub 仅为只读镜像。

English | 简体中文

基于 Git 的代码备份系统，支持定时自动备份 GitHub、GitLab、CNB 及任意 Git 仓库，并通过 CGit 提供 Web 浏览界面。

功能特性

支持 GitHub / GitHub Enterprise
支持 GitLab / GitLab 自部署
支持 CNB.cool
支持任意 Git 仓库地址
定时自动备份（cron 表达式）
无状态，Docker 一键拉起
内置 CGit Web 界面浏览备份仓库

快速开始

1. 克隆仓库

git clone https://cnb.cool/mmdjiji/GitBack
cd GitBack

2. 创建配置文件

cp config.yaml.example config.yaml

3. 编辑配置文件

根据需要编辑 config.yaml，填入你的访问令牌并配置备份源。注意，此处的 yaml 最顶层的名称，对应文件夹的名称。

# 触发器
on:
  cron: 0 0 * * *  # 每天凌晨执行备份

# GitHub 备份配置
github:
  type: github
  access_token: your_github_token  # 需要 read:org, repo 权限（如果是 Fine-granted tokens 就至少包含 Contents 和 Metadata 的只读权限）
  owned: true          # 备份自己拥有的仓库
  starred: true        # 备份加星标的仓库
  collaborator: true   # 备份作为协作者的仓库
  org_member: true     # 备份所属组织的仓库

# GitLab 备份配置
gitlab:
  type: gitlab
  access_token: your_gitlab_token  # 需要 api 权限
  owned: true          # 备份自己拥有的仓库
  starred: true        # 备份加星标的仓库
  member: true         # 备份所属团队的仓库

# CNB 备份配置
cnb:
  type: cnb
  access_token: your_cnb_token  # 需要 repo-code:r, repo-basic-info:r, account-engage:r 权限
  owned: true          # 备份自己拥有的仓库
  starred: true        # 备份加星标的仓库
  member: true         # 备份所属团队的仓库

# 直接指定仓库地址
repo:
  type: repo
  include:
    - https://example.com/some-repo.git

各平台令牌创建地址：

4. 启动服务

docker compose up -d

启动后：

gitback 容器将按照 cron 表达式定时备份仓库到 ./repos 目录
cgit 容器提供 Web 界面，访问 http://localhost:8787 浏览备份的仓库

限流机制

为避免触发平台的限制（如 GitHub 的 CPU 限额：60 秒内消耗超过 90 秒 CPU 时间会断开连接），GitBack 内置了两级限流策略：

请求间隔限流

每次 git 操作之间强制等待一个最小间隔，避免短时间内发起过多请求：

域名	最大并发数	最小间隔
github.com	1	10 秒
gitlab.com	1	8 秒
cnb.cool	1	8 秒
自建实例/其他域名	3	2 秒

滑动窗口限流

在请求间隔的基础上，还有一个分钟级的滑动窗口限制，防止仓库数量多时整体请求过于密集：

域名	窗口时长	窗口内最大操作数
github.com	60 秒	5 次
gitlab.com	60 秒	6 次
cnb.cool	60 秒	6 次
自建实例/其他域名	60 秒	20 次

当滑动窗口内的操作次数达到上限时，后续任务会自动排队等待窗口过期后再继续执行。

限流为内置行为，无需额外配置。

CGit Web 界面

通过 compose.yaml 中的环境变量配置 CGit：

environment:
  - CGIT_TITLE=GitBack           # 页面标题
  - CGIT_DESC=描述信息            # 页面描述
  # - BASIC_AUTH_USER=admin      # 基本认证用户名（可选）
  # - BASIC_AUTH_PASS=12345678   # 基本认证密码（可选）

许可证

MIT

35/F,Tencent Building,Kejizhongyi Avenue,Nanshan District,Shenzhen

京ICP备11018762号-111