ファイルへ移動
Midou36O 8b031cb205 Merge pull request 'Merge Docker build fix.' (#100) from build-fix into master
Reviewed-on: https://codeberg.org/gothub/gothub/pulls/100
2023-04-23 13:35:09 +00:00
.gitea/ISSUE_TEMPLATE
.woodpecker Looks like somebody forgot to add brackets. 2023-04-23 14:23:43 +01:00
cmd/gothub
pages add pin or popular variable for frontend to use 2023-03-07 17:56:12 +05:30
public
serve
utils
views fix html errors for index page 2023-02-15 17:29:19 +05:30
.editorconfig
.gitignore
Dockerfile
LICENSE
README.md update scraping section of readme 2023-03-07 18:05:57 +05:30
compose.yml
go.mod
go.sum
main.go

README.md

GotHub

Alternative front-end for GitHub written with Go. (WIP)

Matrix

Features

  • Lightweight - for both you and the instance host
  • No JavaScript - pure HTML and CSS goodness
  • No requests made to Micro$oft - they won't even know you made a request!
  • Open source - for peer review & trustworthiness
  • Save bandwidth - no JavaScript/tracking bloat loaded!

Instances

Difference between branches

The master branch runs on the master branch of GotHub. This means that the instance is running a stable, tested version of GotHub that doesn't get updated as much as dev. Doesn't mean they're not bad though!

dev instances run on the dev branch of GotHub. This might mean they are more up-to-date than other instances, but at the same time, they might not be (instance admin might not always update their instance, no auto-updates etc.). You can get the latest and greatest straight out of Git, but you could meet on bugs and other nasty things.

Link Cloudflare Country ISP Branch
gh.odyssey346.dev No 🇫🇷 OVHcloud (Trolling Solutions) master
gh.riverside.rocks No 🇺🇸 Comcast master
gh.vern.cc1 No 🇺🇸 Hetzner master
gh.akisblack.dev No 🇩🇪 OVHcloud master
gothub.lunar.icu Yes 🇩🇪 Unesty master
gh.phreedom.club No 🇮🇸 Flokinet master
gh.dev.odyssey346.dev No 🇫🇷 OVHcloud (Trolling Solutions) dev
gothub.esmailelbob.xyz No 🇨🇦 OVHcloud dev
dev.gh.akisblack.dev No 🇩🇪 OVHcloud dev

Have an instance you want on the list? Make an issue or PR!

You can find a json-list of the same in gothub/gothub-instances.

Setup

Docker

We recommend Docker as it is easy to update GotHub that way and it is easy to setup. Packages page

docker run -d -p 3000:3000 --name gothub codeberg.org/gothub/gothub

If you are using Portainer or Podman, you know how to create the GotHub container.

Manual

You will need an installation of Go 1.19+ installed on your system.

We recommend setting the GO_TELEMETRY environment variable to off. In the future, the Go CLI will send telemetry to Google, which you might not want.

git clone https://codeberg.org/gothub/gothub.git
cd gothub
go build -o gothub
./gothub serve

If you don't want to use port 3000 for GotHub, set the GOTHUB_PORT environment variable to the port you want to use.

Web server configuration (Caddy)

We recommend Caddy for the web server, as it provides automatic HTTPS, HTTP/3 and is easy to setup.

gothub.example.com {
    reverse_proxy localhost:(the port for GotHub)
}

Scraping

Other than for the explore page, gothub uses scraping in order to retrieve the information.

This makes it hard for gothub to get ratelimited.

You can also set the GOTHUB_USER_AGENT envvar in order to set the user agent with which GotHub makes requests to Github.

By default, we use the user agent of Chrome 110 on Windows 10.

DMCA/Legal notice

All content shown on a GotHub instance is from GitHub. Any issues with content shown on a GotHub instance needs to be reported to GitHub, not the instance host's internet or domain provider.

GitHub is a registered trademark of GitHub, Inc. GotHub is not affiliated with GitHub, Inc.