arnaucube
arnaucube/gitviewPublic Self-hosted repository
main⌄
Switch branches
main
1 branches
History
Code⌄
Clone repository

Get a local copy of this repository.

Download tar.gz
aarnaucubeadd gitview codebase b54b4dbOct 19, 2026
cmdDirectorydrwxrwxrwxcontribDirectorydrwxrwxrwxinternalDirectorydrwxrwxrwxscriptsDirectorydrwxrwxrwxstaticDirectorydrwxrwxrwxtemplatesDirectorydrwxrwxrwx .dockerignore-rw-r--r--48 B.gitignore-rw-r--r--32 BLICENCE.txt-rw-r--r--35149 BREADME.md-rw-r--r--3243 Bconfig.yaml-rw-r--r--569 Bgo.mod-rw-r--r--2253 Bgo.sum-rw-r--r--20462 B
README

Gitview

A self-hosted Git repository browser written in Go, with a GitHub-inspired interface. Browse files, READMEs, history, diffs, branches, and tags; clone repositories or download archives. Language indicators and size-weighted breakdowns are computed locally using go-enry. Vendor, generated, binary, documentation, and data files are excluded; detection can differ from GitHub and does not apply .gitattributes overrides. HTTP push is disabled.

Run

Requires Go 1.23+ and Git.

go build -o bin/gitview ./cmd
./bin/gitview --config ./config.yaml

Open http://localhost:5555. In config.yaml, set repo.scanPath to your repository directory, meta.title to the browser tab title, and meta.username to the name shown in the top bar and on repository pages. Repositories must contain at least one commit.

Set meta.logo to an image path relative to dirs.static (for example branding/logo.png for static/branding/logo.png). The same image is used as the top-bar logo and favicon:

meta:
  title: git.website.com
  username: yourusername
  logo: favicon.svg

To show selected repositories first, list them in the desired order:

repo:
  pinned: [project-one, project-two]

Names may include the .git suffix. Other repositories follow by last updated; ignored or unlisted repositories stay hidden. Restart Gitview after configuration changes.

Or run with Docker:

docker compose -f contrib/docker-compose.yml up --build

Mirror GitHub repositories

Mirror all public repositories owned by a GitHub user (including forks and archived repositories):

./scripts/mirror-github.sh githubusername
# Custom directory: use the value of repo.scanPath.
./scripts/mirror-github.sh githubusername /opt/gitview/repos

Requires Bash, Git, curl, Python 3, and flock. Defaults to this project’s repos/ directory. Rerun to discover new repositories and update existing mirrors, descriptions, and default branches. An optional GITHUB_TOKEN environment variable increases the API rate limit.

The script uses git clone --mirror and fetches updates with pruning. Upstream updates overwrite mirrored refs; deleted upstream refs are removed. Keep development changes in a separate clone. Unrelated local repositories are skipped with an error; repositories removed from GitHub are kept locally. Gitview displays updates without restarting.

For automatic updates every five minutes, run crontab -e as the repository owner and add this line, replacing the paths and username:

*/5 * * * * /opt/gitview/scripts/mirror-github.sh githubusername /opt/gitview/repos >> /opt/gitview/mirror.log 2>&1

The script locks the destination to prevent overlapping updates. The owner must be able to write the repositories and log file. With Docker, run synchronization on the host; Compose mounts the repositories read-only into Gitview.

Mirrors copy Git data, not GitHub issues, pull requests, or release attachments. See the Git mirror documentation.

Checks

go test ./...
go vet ./...
python3 -B scripts/tests/test_mirror_github.py