Administration Manual¶
This manual is aimed at operators and self-hosters who deploy, configure and maintain a gitrust instance in production. It covers the entire lifecycle of an instance: first start, production, backup, update and troubleshooting. It assumes knowledge of Linux administration, networking, and TLS — it does not explain these prerequisites.
Learning path¶
The administrator course is structured into 4 tutorials which represent approximately 3 hours in total. The support is degressive: the first tutorial provides everything turnkey, the last requires you to compose it yourself from the available recipes.
graph LR
A[VM prête
Docker installé] --> B[01-installation-docker
30 min]
B --> C[02-installation-systemd
45 min]
C --> D[03-premier-demarrage
20 min]
D --> E[04-mise-en-production
90 min]
E --> F[Admin opérationnel]
Checkpoint de parcours : avant de passer au tutoriel 02, vous devez avoir une instance gitrust accessible sur
http://localhost:4000avec un compte administrateur fonctionnel. Si ce n'est pas le cas, relisez le tutoriel 01.Checkpoint de parcours : avant le tutoriel 04, vous devez avoir une instance démarrée avec une configuration SMTP et un reverse-proxy TLS opérationnel. Si ce n'est pas le cas, relisez le tutoriel 03.
Tutorials — learn by doing¶
The tutorials are guided step-by-step with expected verbatim output. Follow them in order — each assumes the previous one completed.
- 01 — Docker installation: complete docker-compose stack — ~30 min
- 02 — Systemd installation: native binary + service — ~45 min
- 03 — First start: admin bootstrap, migrations — ~20 min
- 04 — Put into production — ~90 min
How-to — recipes for common tasks¶
How-tos answer “how to do X” without any substantive explanation. View them in any order as needed.
- Backup and Restore
- Update the instance
- Configure SMTP
- Configure OAuth (Google, GitHub)
- Configure a remote CI runner
- Integrate Dependency-Track (SBOM)
- Hardening with Fail2ban
- Tuner rate limiting
- Force 2FA globally
- Troubleshoot SSH
- Troubleshoot the CI
- Manage users from /admin
- Audit Instance
Reference — exact technical information¶
The reference comprehensively documents parameters, patterns and behaviors. It is intended for occasional consultation.
- Environment variables (.env)
- Dynamic settings (app_settings)
- Database schema
- Ports and services (4000 HTTP, 2222 SSH, 5432 PG)
- ANSSI PA-074 compliance
Explanation — understand the why¶
Explanations build the mental models needed to make good operating decisions. Read them when you want to understand architectural choices, not just apply them.