Urpagin/github-mirror-user
1
0
Fork 0
mirror of https://github.com/Urpagin/github-mirror-user.git synced 2025-08-21 19:08:01 +02:00
Code Issues Projects Packages Wiki Activity
Mirrors all GitHub repositories of a user and exposes them using a performant git frontend (Forgejo).
7 commits 1 branch 0 tags 49 KiB
Find a file
Exact
Urpagin 0aad869267 update readme
2025-07-22 00:18:12 +02:00
.env.example small tweaks in env and script 2025-07-21 23:54:41 +02:00
.gitignore Initial commit 2025-07-21 22:05:48 +02:00
crontab_script.sh small tweaks in env and script 2025-07-21 23:54:41 +02:00
dc Initial commit 2025-07-21 22:05:48 +02:00
docker-compose.yml update readme 2025-07-22 00:18:12 +02:00
LICENSE add license 2025-07-21 22:14:54 +02:00
README.md update readme 2025-07-22 00:18:12 +02:00

README.md

github-mirror-user 🚀

A small Docker Compose setup to periodically mirror all repositories, public & private, of your GitHub account and make them available with a high-performance git frontend, Forgejo.

Note

This project can only be installed with Docker Compose. You may use Docker alone, but you'll have to manually create the commands.

Features ✨

  • Periodic mirroring of all repositories, public and private of a GitHub account you have access.
  • Nice and lightweight git frontend.
  • Optional simple Discord webhook error logging.

Installation 🛠️

Tip

Please follow the instructions carefully. They may feel out of order, but the .env file needs to be populated with both a GitHub token and a Forgejo token.

  1. Clone the repository 📂
git clone https://github.com/Urpagin/github-mirror-user.git
cd github-mirror-user
  1. Initialize the frontend 🌐

2.1 Launch the frontend

sudo docker compose up -d server

2.2 Create the admin account

Visit http://127.0.0.1:64175 (replace with your machine's IP) and follow the instructions.

2.3 Create your Forgejo token

Generate your Forgejo token (see instructions in the .env file) and place it in the .env file.

  1. Populate fully the .env file 📄

Read and follow the instructions contained inside the .env file carefully.

  1. Start the containers 🐳
sudo docker compose up -d
  1. Verify & Enjoy 🎉

Wait for the cronjob to run (you can modify the cron interval by changing the startup command of the cron container in the docker-compose.yml file; make sure to force recreate the containers afterward).

You can check the logs of all the containers interactively using this command:

docker compose up -d --force-recreate

sudo docker compose logs -f

Containers 📦

Forgejo

Forgejo is similar to GitLab, Gitea, or Gogs. It's written in Go and designed to be lightweight.

Forgejo is a self-hosted lightweight software forge. Easy to install and low maintenance—it just does the job.

Alpine (cron)

We run the cron daemon in a small Alpine Linux container to periodically execute the mirroring script (crontab_script.sh). ⏰

Small Behaviour Explanation

If you receive a code 55 from the Discord webhook, it means the crontab_script.sh script is running, and it is run once more, almost making them overlap, if not for the lockfile logic on top of the script.

Security 🔒

Important

Ensure logs remain secure and private, as some logging includes sensitive tokens for GitHub and Forgejo!

The script doesn't account for deleted repositories, yet. Maybe Forgejo accounts for this, since all repos are of the "mirror" type, they might get deleted as upstream is deleted.