shithub Public

Watch 1 Fork 0 Star 0
markdown · 1328 bytes Raw Blame History

Introduction

shithub is a self-hosted git forge that aims to look and feel like GitHub. The project is AGPLv3, written in Go, and built around a small operational footprint — one binary, Postgres, an S3-compatible object store, and Caddy at the edge.

This site is the public documentation. It is split into three sections:

  • Using shithub — for end users of an instance: how to push code, file issues, manage tokens, configure webhooks.
  • API reference — for integrators writing against the REST surface.
  • Self-hosting — for operators standing up an instance.

The internal architecture and operator runbooks live in the repository under docs/internal/. Some of that material is mirrored here in operator-friendly form; the in-repo originals are the source of truth for the people running the site.

Project status

shithub is post-launch but young. The core forge loop (auth, repos, git over HTTPS, issues, PRs with reviews, webhooks, notifications, search, orgs/teams) works end-to-end. There are gaps — SSH git transport, an Actions-equivalent CI runner, a GraphQL API, and parts of the visual polish are still in flight or planned. The Changelog lists what shipped when.

If you're new, start with the Quickstart.

View source
1 # Introduction
2
3 shithub is a self-hosted git forge that aims to look and feel like
4 GitHub. The project is AGPLv3, written in Go, and built around a
5 small operational footprint — one binary, Postgres, an S3-compatible
6 object store, and Caddy at the edge.
7
8 This site is the public documentation. It is split into three
9 sections:
10
11 - **Using shithub** — for end users of an instance: how to push
12 code, file issues, manage tokens, configure webhooks.
13 - **API reference** — for integrators writing against the REST
14 surface.
15 - **Self-hosting** — for operators standing up an instance.
16
17 The internal architecture and operator runbooks live in the
18 [repository](https://github.com/tenseleyFlow/shithub) under
19 `docs/internal/`. Some of that material is mirrored here in
20 operator-friendly form; the in-repo originals are the source of
21 truth for the people running the site.
22
23 ## Project status
24
25 shithub is **post-launch but young**. The core forge loop (auth,
26 repos, git over HTTPS, issues, PRs with reviews, webhooks,
27 notifications, search, orgs/teams) works end-to-end. There are
28 gaps — SSH git transport, an Actions-equivalent CI runner, a
29 GraphQL API, and parts of the visual polish are still in flight
30 or planned. The `Changelog` lists what shipped when.
31
32 If you're new, start with the [Quickstart](./user/quickstart.md).