jaedle/mirror-to-gitea

GitHub仓库自动镜像到Gitea服务器

镜像概述

该Docker镜像用于将GitHub用户或组织的公共仓库自动镜像到Gitea服务器。启动后，它会基于指定的Gitea用户令牌，在Gitea服务器上自动创建镜像仓库，并定期（默认每小时一次）同步GitHub仓库内容，确保Gitea中的镜像与GitHub源仓库保持一致。

核心功能与特性

• 自动创建镜像仓库：无需手动操作，自动在Gitea服务器上为GitHub仓库创建镜像仓库
• 定期同步：容器持续后台运行，每小时尝试同步一次GitHub仓库至Gitea
• 支持多场景：可镜像GitHub个人用户或组织的所有公共仓库
• 灵活配置：通过环境变量配置GitHub和Gitea参数，支持GitHub令牌（可选）以解决速率限制问题

使用场景与适用范围

• 个人开发者：需要将GitHub仓库备份到私有Gitea服务器，确保代码数据安全
• 团队协作：团队希望维护GitHub仓库的本地镜像，提升内部访问速度或满足合规要求
• 多平台同步：需定期将GitHub代码同步到内部Gitea实例的场景

前提条件

• 需镜像的GitHub用户或组织（拥有公共仓库）
• 已部署并正常运行的Gitea服务器实例
• Gitea用户的访问令牌（用于API操作，需具备创建仓库权限）
• 已安装Docker环境

部署与使用方法

Docker运行命令

通过以下命令启动容器，实现GitHub仓库到Gitea的自动镜像：

sh
docker container run \
  -d \
  --restart always \
  -e GITHUB_USERNAME=github-user \
  -e GITEA_URL=https://some-gitea.url \
  -e GITEA_TOKEN=please-exchange-with-token \
  jaedle/mirror-to-gitea:latest

说明：

• -d：后台运行容器
• --restart always：容器退出时自动重启，确保持续运行
• 容器将每小时尝试同步一次GitHub仓库至Gitea服务器

配置参数

通过环境变量配置容器参数，具体说明如下：

示例

若GitHub用户github-user拥有公共仓库dotfiles和zsh-config，使用Gitea用户gitea-user的令牌启动容器后，将在Gitea服务器上自动创建以下镜像仓库：

• github.com/github-user/dotfiles → some-gitea.url/gitea-user/dotfiles
• github.com/github-user/zsh-config → some-gitea.url/gitea-user/zsh-config

镜像配置遵循Gitea实例的默认镜像设置。