https://github.com/katorlys/github-mirror-gitea
Mirror your GitHub repositories to your Gitea server.
https://github.com/katorlys/github-mirror-gitea
backup gitea github-mirror github-mirror-gitea mirror mirror-github mirror-repositories python
Last synced: 12 days ago
JSON representation
Mirror your GitHub repositories to your Gitea server.
- Host: GitHub
- URL: https://github.com/katorlys/github-mirror-gitea
- Owner: katorlys
- License: mpl-2.0
- Created: 2024-08-26T02:53:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-11T09:38:40.000Z (11 months ago)
- Last Synced: 2026-01-27T02:50:05.760Z (about 2 months ago)
- Topics: backup, gitea, github-mirror, github-mirror-gitea, mirror, mirror-github, mirror-repositories, python
- Language: Python
- Homepage:
- Size: 50.8 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
github-mirror-gitea
Mirror your GitHub repositories to your Gitea server.
[![Pull Requests][github-pr-badge]][github-pr-link]
[![Issues][github-issue-badge]][github-issue-link]
[![License][github-license-badge]](LICENSE)
## Introduction
A Python script to mirror all of your GitHub repositories to your Gitea server, with multiple options.
Repositories created are mirrors of the original repositories, and by default Gitea will automatically fetch them every 8 hours.
Using GitHub APIs and Gitea APIs -- especially the `migrate` function.
### Features
There are many options to choose from:
- Mirror, or not mirror repos:
- you own
- you forked
- you starred
- you have access to as a collaborator
- you have access to as an organization member
- Whether to remove existing repos in Gitea
- Whether to create new organizations in Gitea if `{username}` in `{username}/{repo_name}` doesn't match your GitHub username
Will also mirror your repository description and private status.
### Tech Stack
- Python3
## Getting Started
### Prerequisites
Add the following content in your Gitea server's `gitea/conf/app.ini` file:
```ini
[migrations]
ALLOWED_DOMAINS = github.com, *.github.com
```
### Configuration
All credentials are needed to be configured properly:
| Key | Description |
|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **GITHUB** | |
| USERNAME | Your GitHub username |
| PAT | Your GitHub personal access token, needed permissions:
- repo (Full control of private repositories)
If you only want to mirror public repositories, grant the following only:
- repo:public_repo |
| **GITEA** | |
| USERNAME | Your Gitea username |
| HOST | Your Gitea hostname, starts with `http://` or `https://` |
| PAT | Your Gitea personal access token, needed permissions:
- repository: Read and Write
If you set `REMOVE_EXISTING_REPO` in `options.toml` to true, you also need to grant:
- user: Read and Write
If you set `CREATE_ORG` in `options.toml` to true, you also need to grant:
- organization: Read and Write |
You can customize these options for mirroring:
| Key | Description |
|:---------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **CONFIG** | |
| CREATE_ORG | Create a new organization in Gitea when the repository username is different from your GitHub username. |
| REMOVE_INEXIST_REPO | Remove all repositories in Gitea owned by the user (including those in organizations) that do not exist in GitHub. |
| REMOVE_EXISTING_REPO | Remove existing repositories in Gitea. This will only remove the repositories that have the same name as the repositories in GitHub. You may not want to enable this option, since Gitea will automatically fetch the mirror repositories every 8 hours. |
| MIRROR_OWNED | Mirror the repositories you own. |
| MIRROR_PRIVATE | Mirror private repositories you own. |
| MIRROR_FORKED | Mirror the repositories you forked. |
| MIRROR_STARRED | Mirror the repositories you starred. |
| MIRROR_COLLABORATOR | Mirror the repositories that you have collaborator access. See: https://docs.github.com/zh/rest/repos/repos#list-repositories-for-the-authenticated-user |
| MIRROR_ORGANIZATION | Mirror the repositories in organizations that you are a member. |
| **RULE** | |
| MODE | `whitelist` or `blacklist` to only mirror or skip repositories that match the regex. |
| REGEX | Regex list. |
## Usage
### Python script
Configure [`credentials.toml`](config/credentials.toml), and [ `options.toml`](config/options.toml).
Clone the repository:
```bash
git clone https://github.com/katorlys/github-mirror-gitea
cd github-mirror-gitea
```
Install the required packages:
```bash
pip install -r requirements.txt
```
Run the script:
```bash
python main.py
```
### Docker
Make sure you've modified the `<>` placeholders and the options before running the following command:
```bash
docker run --rm \
-e GITHUB_USERNAME= \
-e GITHUB_PAT= \
-e GITEA_USERNAME= \
-e GITEA_HOST= \
-e GITEA_PAT= \
-e CREATE_ORG=true \
-e REMOVE_EXISTING_REPO=false \
-e MIRROR_OWNED=true \
-e MIRROR_PRIVATE=true \
-e MIRROR_FORKED=true \
-e MIRROR_STARRED=false \
-e MIRROR_COLLABORATOR=false \
-e MIRROR_ORGANIZATION=false \
-e RULE_MODE="blacklist" \
-e RULE_REGEX="EpicGames/.*,NVIDIAGameWorks/.*" \
katorlys/github-mirror-gitea:latest
```
### GitHub Actions
We've created a [GitHub Action](https://github.com/katorlys/gitea-mirror-action) for this script. Here's an example workflow file:
```yml
name: Mirror GitHub to Gitea
on:
workflow_dispatch:
schedule:
- cron: '0 0 * * *'
jobs:
mirror:
runs-on: ubuntu-latest
steps:
- name: GitHub mirror Gitea
uses: katorlys/gitea-mirror-action@v1
with:
GITHUB_USERNAME: ${{ secrets.GH_USERNAME }}
GITHUB_PAT: ${{ secrets.GH_PAT }}
GITEA_HOST: ${{ secrets.GITEA_HOST }}
GITEA_USERNAME: ${{ secrets.GITEA_USERNAME }}
GITEA_PAT: ${{ secrets.GITEA_PAT }}
CREATE_ORG: true
REMOVE_INEXIST_REPO: false
REMOVE_EXISTING_REPO: false
MIRROR_OWNED: true
MIRROR_PRIVATE: true
MIRROR_FORKED: true
MIRROR_STARRED: false
MIRROR_COLLABORATOR: false
MIRROR_ORGANIZATION: false
MODE: 'blacklist'
REGEX: 'EpicGames/.*,NVIDIAGameWorks/.*'
```
If you prefer to run our Docker image in GitHub Actions, you can use the following workflow file:
```yml
name: Mirror Github to Gitea
on:
workflow_dispatch:
schedule:
- cron: 0 0 * * *
jobs:
mirror:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run Docker container
run: |
docker run --rm \
-e GITHUB_USERNAME=${{ secrets.GH_USERNAME }} \
-e GITHUB_PAT=${{ secrets.GH_PAT }} \
-e GITEA_USERNAME=${{ secrets.GITEA_USERNAME }} \
-e GITEA_HOST=${{ secrets.GITEA_HOST }} \
-e GITEA_PAT=${{ secrets.GITEA_PAT }} \
-e CREATE_ORG=true \
-e REMOVE_EXISTING_REPO=false \
-e MIRROR_OWNED=true \
-e MIRROR_PRIVATE=true \
-e MIRROR_FORKED=true \
-e MIRROR_STARRED=false \
-e MIRROR_COLLABORATOR=false \
-e MIRROR_ORGANIZATION=false \
-e MODE="blacklist" \
-e RULE_REGEX="EpicGames/.*,NVIDIAGameWorks/.*" \
katorlys/github-mirror-gitea:latest
```
## Frequently Asked
| Error message | Solution |
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------|
| `403 b'{"message":"token does not have at least one of required scope(s):` | Follow the message's instruction to grant the required permissions to your PAT. |
| My repository doesn't exist on Gitea, but the script returns `Skip (exists)` | Please don't transfer the mirrored repository to another user or organization on Gitea. |
| `b'{"message":"Migration failed: clone error: exit status 128 - fatal: unable to access \'https://github.com/username/repo.git/\': Could not resolve host: github.com\\n."` | Make sure your Gitea host can access GitHub. |
[![BACK TO TOP][back-to-top-button]](#readme-top)
---
Copyright © 2024-present Katorly Lab
[![License][github-license-badge-bottom]](LICENSE)
[back-to-top-button]: https://img.shields.io/badge/BACK_TO_TOP-151515?style=flat-square
[github-pr-badge]: https://img.shields.io/github/issues-pr/katorlys/github-mirror-gitea?label=pulls&labelColor=151515&color=79E096&style=flat-square
[github-pr-link]: https://github.com/katorlys/github-mirror-gitea/pulls
[github-issue-badge]: https://img.shields.io/github/issues/katorlys/github-mirror-gitea?labelColor=151515&color=FFC868&style=flat-square
[github-issue-link]: https://github.com/katorlys/github-mirror-gitea/issues
[github-license-badge]: https://img.shields.io/github/license/katorlys/github-mirror-gitea?labelColor=151515&color=EFEFEF&style=flat-square
[github-license-badge-bottom]: https://img.shields.io/github/license/katorlys/github-mirror-gitea?labelColor=151515&color=EFEFEF&style=for-the-badge