tirbofish/kitgit · commit

4fd30a250e6c0de729b272981029a0968cc76a78

docs: further docs

Verified

Thribhu K <4tkbytes@pm.me> · 2026-07-28 11:47

diff --git a/README.md b/README.md
index 65abac4..164cd03 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,8 @@
 # kitgit
 
-Self-hosted git. Templates, not a product page.
+a minimalistic git frontend built in Rust and pure HTML templates.
 
-Authentication is **Authentik OIDC only** — there is no local/dev password bypass.
-
-## Docker Compose
+## Deployment
 
 ```bash
 cd deploy
@@ -19,72 +17,12 @@ docker compose up -d --build
 | kitgit SSH | localhost:2222 |
 | Authentik | http://localhost:9000 |
 
-### Authentik bootstrap
-
-Compose sets:
-
-- user: `akadmin`
-- password: value of `AUTHENTIK_BOOTSTRAP_PASSWORD` (default `kitgit-admin-change-me`)
-
-A blueprint at `deploy/authentik/blueprints/kitgit-oidc.yaml` creates the **kitgit** OAuth2 application (client id `kitgit`, redirect `http://localhost:8080/auth/callback`).
-
-After Authentik is up, apply/confirm the blueprint if needed:
-
-```bash
-docker compose exec authentik-worker ak apply_blueprint /blueprints/custom/kitgit-oidc.yaml
-```
-
-Then open http://localhost:8080/auth/login → Authentik → kitgit.
-
-### Site admins
-
-- The **first** successful OIDC login becomes a site admin automatically.
-- Site admins open **/admin** and can grant/revoke admin for any user.
-
-## Environment
-
-| Variable | Purpose |
-|----------|---------|
-| `KITGIT_DATABASE_URL` | Postgres |
-| `KITGIT_DATA_DIR` | Repos, avatars, SSH host key, releases |
-| `KITGIT_HTTP_BIND` / `KITGIT_SSH_BIND` | Listen addresses |

Large diffs are not rendered by default. Showing the first 50 of 203 lines. Show full diff