djlactose/github_backup

GitHub备份Docker容器

本项目提供一个Docker容器，可在本地执行GitHub仓库的每日备份。该容器不使用cron，而是运行无限循环每小时检查当前时间，当与配置的备份时间（通过环境变量设置）匹配时，每日执行一次备份脚本。

注意：
若需备份私有仓库或获取更高API速率限制，请通过GITHUB_TOKEN环境变量提供GitHub令牌。仅备份公共仓库时，可省略此变量。

核心功能与特性

• 自动每日备份
  容器的入口脚本运行无限循环，每小时检查一次时间。当当前小时与配置的备份小时匹配时，执行备份脚本（每日仅一次）。

• 镜像克隆
  使用git clone --mirror执行仓库的完整备份，保留所有引用（分支、标签等）。

• GitHub API集成与分页处理
  备份脚本通过GitHub API获取所有仓库（若仓库数量超过100个，会处理分页）。

• 卷持久化
  备份存储在主机挂载的卷上，即使容器重启，备份数据也能保留。

• 可配置备份时间
  通过BACKUP_HOUR环境变量指定所需备份小时（24小时制，默认值为2，即凌晨2点）。

前提条件

• 系统已安装https://docs.docker.com/get-docker/%E3%80%82
• 拥有GitHub用户名。
• （可选）若需备份私有仓库或需要更高API速率限制，需具有适当权限的GitHub令牌。

项目结构

• Dockerfile
  基于Alpine Linux构建镜像，安装所需软件包（git、curl、jq），并复制备份脚本和入口脚本。

• backup.sh
  获取所有GitHub仓库（处理分页）并为每个仓库执行镜像克隆或更新备份的脚本。

• entrypoint.sh
  运行无限循环的脚本，每3600秒检查一次当前时间。若当前小时与配置的备份小时匹配（且当天尚未执行备份），则触发backup.sh。

环境变量

容器支持以下环境变量：

• GITHUB_USER（必填）
  您的GitHub用户名。用于获取公共仓库（若提供令牌，也可获取私有仓库）。

• GITHUB_TOKEN（可选）
  具有适当权限的GitHub令牌。提供后可访问私有仓库并提高API速率限制。

• BACKUP_HOUR（可选）
  备份执行的小时数（24小时制）。未指定时，默认值为2（即凌晨2点）。

卷

• /backup
  容器内存储备份的目录。建议将主机目录挂载到此路径，以在容器重启之间持久化备份数据。

Docker构建与运行说明

1. 克隆本仓库

将项目仓库克隆到本地机器：

bash
git clone https://github.com/yourusername/github-backup.git
cd github-backup