selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

GotHub logo

Self-host GotHub

1.0.0

JavaScript-free, privacy-minded GitHub front-end

BetaOpen Source
docker run -d --name gothub -p 3000:3000 codeberg.org/gothub/gothub:dev
Updated3 years ago
Setup difficultyEasy
Port
3000 (GotHub's own HTTP server, exposed to the reverse proxy in front of it)
Docker
codeberg.org/gothub/gothub

What is GotHub?

GotHub is a web front-end for GitHub that instance operators run themselves: you replace github.com with the instance's domain and browse repositories, gists and user pages without code executing in your browser. Written in Go, it pulls GitHub data through a Colly-powered scraper and renders plain HTML and CSS, which keeps pages tiny — the README's PageSpeed comparison of one repository measured 3 requests and 8kb of resources against GitHub's 88 requests and 629kb. Operators can choose whether avatars, repository archives and raw files are proxied through the instance, and the outgoing user agent is configurable. Hosting is documented as a container image on the Codeberg registry (docker run or the project's compose.yml) or as a manual build from source with Go, followed by a setup wizard that writes a .env file and a built-in update command. The project has no expenses of its own and asks donors to give to whichever instance host they prefer, while official public instances are barred from ads and web analytics. GotHub is still marked as work in progress, seeks volunteers to take over maintenance, and publishes no tagged releases.

GotHub alternatives

All self-hosted alternatives to GitHub →

Should you self-host GotHub?

GotHub scores 53/100 on selfhost.directory (how scoring works) and ranks #70 of 167 in Developer Tools.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is easy: most people get it running in one sitting. An official Docker image is available.

Its closest alternative on selfhost.directory is RhodeCode (64/100). It scores higher overall, so compare the two before you pick. See GotHub vs RhodeCode side by side.

Features

  • Built-in update command
  • Configurable User-Agent
  • Explore pageGitHub's own explore content is not covered by the scraper.
  • Gist support
  • GitHub scraping with Colly
  • Lightweight pages
  • No-JavaScript UI
  • Optional asset proxying
  • Public instance directory
  • Setup Wizard
  • Stable and development branches
  • Tor access on some instancesOffered per instance, not by the software itself.
  • Upstream requests proxied by the instance

How to install GotHub

Install GotHub with Docker

Docker (duh) - A web server (we recommend Caddy)
Environment variables
GOTHUB_PORT, GOTHUB_USER_AGENT, GOTHUB_PROXYING_ENABLED, GOTHUB_INSTANCE_COUNTRY, GOTHUB_INSTANCE_PROVIDER, GOTHUB_INSTANCE_PRIVACY_POLICY, GOTHUB_INSTANCE_CLOUDFLARE, GOTHUB_SETUP_COMPLETE, GOTHUB_CACHE_MAX_SIZE_MB, DOCKER
docker run -d --name gothub -p 3000:3000 codeberg.org/gothub/gothub:dev

Image lives on the Codeberg registry; use the latest tag for the master branch. An automatic container update tool such as Watchtower is recommended.

How to configure GotHub

  • GOTHUB_SETUP_COMPLETEMarks the instance setup as finished; the setup wizard sets it and an empty value shows a setup banner on the main page.

    values: true/false

  • GOTHUB_PROXYING_ENABLEDWhether non-essential items such as avatars, repository archives and raw files are proxied through the instance.

    values: true/false

  • GOTHUB_IP_LOGGEDDeclare whether the instance logs IP addresses.

    values: true/false

  • GOTHUB_REQUEST_URL_LOGGEDDeclare whether the instance logs request URLs.

    values: true/false

  • GOTHUB_USER_AGENT_LOGGEDDeclare whether the instance logs user agents.

    values: true/false

More in Developer Tools

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…