tenseleyflow/shithub / 88222cc

+# Summary

+

+[Introduction](./introduction.md)

+

+# Using shithub

+

+- [Quickstart](./user/quickstart.md)

+- [Cloning over SSH](./user/ssh.md)

+- [Cloning over HTTPS with a PAT](./user/https.md)

+- [Personal access tokens](./user/personal-access-tokens.md)

+- [Account settings](./user/account.md)

+  - [Two-factor authentication](./user/2fa.md)

+- [Issues](./user/issues.md)

+- [Pull requests](./user/pull-requests.md)

+  - [Branch protection & reviews](./user/branch-protection.md)

+- [Notifications](./user/notifications.md)

+- [Webhooks](./user/webhooks.md)

+- [Search](./user/search.md)

+- [Organizations & teams](./user/orgs.md)

+- [Markdown reference](./user/markdown.md)

+

+# API reference

+

+- [Overview & conventions](./api/overview.md)

+- [Authentication](./api/auth.md)

+- [Users](./api/users.md)

+- [Repositories](./api/repos.md)

+- [Issues](./api/issues.md)

+- [Pull requests](./api/pulls.md)

+- [Status checks](./api/checks.md)

+- [Webhooks](./api/webhooks.md)

+- [Search](./api/search.md)

+- [Admin (site-admin only)](./api/admin.md)

+

+# Self-hosting

+

+- [Prerequisites](./self-host/prerequisites.md)

+- [Deploying with Ansible](./self-host/deploy.md)

+- [Configuration reference](./self-host/configuration.md)

+- [Backup & restore](./self-host/backup-restore.md)

+- [Upgrades & migrations](./self-host/upgrades.md)

+- [Troubleshooting](./self-host/troubleshooting.md)

+- [Capacity planning](./self-host/capacity.md)

+

+---

+

+[Contributing](./contributing.md)

+[Security policy](./security.md)

+[Changelog](./changelog.md)

+# mdBook configuration for the public docs site at docs.shithub.tld.

+# Built by `make docs` and synced into Spaces; Caddy serves from there

+# (see deploy/docs-site/Caddyfile.snippet).

+

+[book]

+title       = "shithub docs"

+authors     = ["the shithub project"]

+description = "User, API, and self-host documentation for shithub."

+language    = "en"

+src         = "."

+multilingual = false

+

+[build]

+build-dir = "../../build/docs"

+create-missing = false

+

+[output.html]

+default-theme = "shithub"

+preferred-dark-theme = "shithub-dark"

+git-repository-url = "https://github.com/tenseleyFlow/shithub"

+git-repository-icon = "fa-github"

+edit-url-template = "https://github.com/tenseleyFlow/shithub/edit/main/docs/public/{path}"

+no-section-label = false

+additional-css = ["theme/shithub.css"]

+

+[output.html.search]

+enable = true

+limit-results = 30

+use-boolean-and = true

+boost-title = 2

+boost-hierarchy = 1

+boost-paragraph = 1

+expand = true

+heading-split-level = 3

+copy-js = true

+

+[output.html.fold]

+enable = true

+level = 1

+# 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](https://github.com/tenseleyFlow/shithub) 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](./user/quickstart.md).

+/* Minimal mdBook theme overrides — keep the default chrome and just

+   align colors and a couple of spacings with the shithub app's

+   Primer-ish palette so the docs site doesn't feel disconnected. */

+

+:root {

+    --shithub-accent:        #1f6feb;

+    --shithub-accent-subtle: #ddf4ff;

+}

+

+.shithub {

+    --bg:        #ffffff;

+    --fg:        #1f2328;

+    --sidebar-bg:        #f6f8fa;

+    --sidebar-fg:        #1f2328;

+    --sidebar-non-existant: #a0a0a0;

+    --sidebar-active:    var(--shithub-accent);

+    --sidebar-spacer:    #d0d7de;

+    --scrollbar:         #d0d7de;

+    --icons:             #57606a;

+    --icons-hover:       #1f2328;

+    --links:             var(--shithub-accent);

+    --inline-code-color: #cf222e;

+    --theme-popup-bg:    #ffffff;

+    --theme-popup-border:#d0d7de;

+    --theme-hover:       #f3f4f6;

+    --quote-bg:          #f6f8fa;

+    --quote-border:      #d0d7de;

+    --table-border-color:#d0d7de;

+    --table-header-bg:   #f6f8fa;

+    --table-alternate-bg:#f6f8fa;

+    --searchbar-border-color: #d0d7de;

+    --searchbar-bg:      #ffffff;

+    --searchbar-fg:      #1f2328;

+    --searchbar-shadow-color: rgba(0,0,0,0.05);

+    --searchresults-header-fg: #57606a;

+    --searchresults-border-color: #d0d7de;

+    --searchresults-li-bg: #f6f8fa;

+    --search-mark-bg:    var(--shithub-accent-subtle);

+}

+

+.shithub-dark {

+    --bg:        #0d1117;

+    --fg:        #c9d1d9;

+    --sidebar-bg:        #161b22;

+    --sidebar-fg:        #c9d1d9;

+    --sidebar-non-existant: #6e7681;

+    --sidebar-active:    #58a6ff;

+    --sidebar-spacer:    #30363d;

+    --scrollbar:         #30363d;

+    --icons:             #8b949e;

+    --icons-hover:       #c9d1d9;

+    --links:             #58a6ff;

+    --inline-code-color: #ff7b72;

+    --theme-popup-bg:    #161b22;

+    --theme-popup-border:#30363d;

+    --theme-hover:       #1f242c;

+    --quote-bg:          #161b22;

+    --quote-border:      #30363d;

+    --table-border-color:#30363d;

+    --table-header-bg:   #161b22;

+    --table-alternate-bg:#161b22;

+    --searchbar-border-color: #30363d;

+    --searchbar-bg:      #0d1117;

+    --searchbar-fg:      #c9d1d9;

+    --searchbar-shadow-color: rgba(0,0,0,0.3);

+    --searchresults-header-fg: #8b949e;

+    --searchresults-border-color: #30363d;

+    --searchresults-li-bg: #161b22;

+    --search-mark-bg:    #1f6feb33;

+}

+

+.content code {

+    font-size: 0.9em;

+}

+

+.content pre code {

+    font-size: 0.85em;

+    line-height: 1.45;

+}