Giternity is a tool to mirror git repositories from GitHub. You can specify a username/organization to mirror all their repositories, or just individual repos. It retrieves some repo metadata so they can be nicely served with cgit. Run giternity periodically to update the mirrors.
An example result is git.cpu.re. Follow the tutorial to host your own.
Install giternity:
sudo pip3 install giternity
You also need to have git installed.
The configuration file is at /etc/giternity.toml
:
# path for the git mirrors
git_data_path = "/srv/git/"
# path for checkouts of the git mirrors (optional)
# checkout_path = "/srv/git_checkout/"
# public URL of your cgit instance (optional)
# cgit_url = "https://git.cpu.re/"
[github]
repositories = [
"rahiel",
"sunsistemo",
"TeMPOraL/nyan-mode",
]
# Include arbitrary repositories with this pattern (1 [[repos]] block
# each):
#
# [[repos]]
# name = "repo-name"
# owner = "owner"
# description = "description"
# homepage = "https://example.local"
# clone_url = "https://git.example.local/owner/repo-name.git"
[[repos]]
name = "giternity"
owner = "rahiel"
description = "Mirror git repositories and retrieve metadata for cgit "
homepage = "https://www.rahielkasim.com/mirror-git-repositories-and-serve-them-with-cgit/"
clone_url = "https://github.com/rahiel/giternity.git"
Set git_data_path
to the path where you want to store the git repositories. It
will contain bare git repositories: the data you usually see in the .git
directory in your projects. To also have the actual working files of the repos,
set checkout_path
to where to keep them. If you'll be hosting the repos with
cgit, set cgit_url
to the public URL.
In the [github]
section you specify which repositories to mirror. You list a
username ("rahiel"
) or an organization ("sunsistemo"
) to mirror all of their
non-fork repositories. For individual repos ("TeMPOraL/nyan-mode"
) you specify
them like owner/repo
.
With the configuration in place you simply run giternity
.
For convenience there is an automatic configuration that sets up a separate
system user, gives this user permissions to git_data_path
(and to
checkout_path
if specified) and creates a cron job at /etc/cron.d/giternity
to update the mirrors every hour. Apply these defaults with:
sudo giternity --configure
Your git mirrors are now suitable to serve with cgit. Customize your
/etc/cgitrc
as you like and add the following to the bottom:
agefile=info/web/last-modified
section-from-path=1
scan-path=/srv/git/
where you replace /srv/git/
with the git_data_path
from your
/etc/giternity.toml
.