gitlin/README.md

# GotHub

Alternative front-end for GitHub written with Go. (WIP)
[Matrix](https://matrix.to/#/%23gothub%3Atrygve.me?via=projectsegfau.lt&via=vern.cc&via=matrix.org&via=trygve.me)

## 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
### Master Branch
These instances run the ``master`` branch of GotHub. This means that the version of GotHub they're running has been tested and approved by at least two GotHub maintainers.

| Link | Cloudflare | Country | ISP |
| -------- | ---------- | ----------- | ----- |
| [gh.odyssey346.dev (official)](https://gh.odyssey346.dev) | No | 🇫🇷 | OVHcloud (Trolling Solutions) |
| [gh.riverside.rocks](https://gh.riverside.rocks) | No | 🇺🇸 | Comcast |
| [gh.vern.cc](https://gh.vern.cc)[^1]     |    No       | 🇺🇸  | Hetzner |
| [gh.akisblack.dev](https://gh.akisblack.dev) | No | 🇩🇪 | OVHcloud |
| [gothub.lunar.icu](https://gothub.lunar.icu) | Yes | 🇩🇪 | Unesty |
| [gh.phreedom.club](https://gh.phreedom.club) | No | 🇸🇨 | Flokinet |

### Dev Branch
These instances run the ``dev`` branch of GotHub. While this might mean they are always up to date, they might not be. However, this does mean that you can get the latest and greatest, but could potentially have bugs and other nasty stuff.
| Link | Cloudflare | Country | ISP |
| -------- | ---------- | ----------- | ----- |
| [gh.dev.odyssey346.dev (official)](https://gh.dev.odyssey346.dev) | No | 🇫🇷 | OVHcloud (Trolling Solutions) |  
| [gothub.esmailelbob.xyz](https://gothub.esmailelbob.xyz) | No | 🇨🇦 | OVHcloud | 
| [dev.gh.akisblack.dev](https://dev.gh.akisblack.dev) | No | 🇩🇪 | OVHcloud |  

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

[^1]: Has some modifications: https://git.vern.cc/vern/modifications/src/branch/master/gothub

## Setup
### Docker
We recommend Docker as it is easy to update GotHub that way and it is easy to setup.
[Packages page](https://codeberg.org/gothub/-/packages/container/gothub/latest)
```
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.
```bash
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.


## 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.