Documentation
Documentation
Getting it running
| Guide | What it covers |
|---|---|
| GitLab-side setup | The group, the two credentials, the webhook secret, reachability. Read this first, whichever target you pick |
| Quick start | Docker Compose on one host, in a few minutes |
| Configuration | Every flag and environment variable, the DSN formats, the subcommands |
| Kubernetes | Helm chart, secrets, probes, ingress, running the backfill as a Job |
| Docker Compose | App plus PostgreSQL on one host, TLS in front, backups, scheduled jobs |
| Bare binary | systemd unit against a database you manage, plus timers |
| Helm chart values | Every value of the chart, generated from values.yaml |
| The frontend | The built-in web frontend, working on it, and serving a different one |
| Metrics | What is exported for Prometheus, and what to alert on |
| Uninstalling | Taking the webhooks and achievements back off your instance |
Understanding it
| Guide | What it covers |
|---|---|
| How it works | The lifecycle from bootstrap to steady state, the two tokens, where state lives |
| Who takes part | Bot exclusion, excluding accounts by name or pattern, opting out |
| Achievements and EXP | The catalog, the curves, how EXP is derived, what reaches GitLab |
| The API | Endpoints, response shapes, authentication |
| CLI reference | The generated --help of every command |
| Webhooks | Which hooks get registered and why, the hourly sweep, event coverage |
| Historical backfill | Awarding for activity that predates the bot |
| Reconciliation | Catching activity whose webhook delivery was lost |
| GitLab achievements API behavior | What GitLab’s achievement mutations actually do, verified on a live instance |
| End-to-end catalog check | The suite that drives every criteria through a real GitLab, and the CI job that runs it |
New here? Start with the Quick start.