Newer
Older
gnexus-book / 10-systems / applications / gnexus-handbook.md

owner: gmikcon status: active last_reviewed: 2026-10-04 review_interval: 90d confidence: high

source_of_truth: gitbucket-repository

Gnexus Handbook

Gnexus Handbook is the canonical repository of platform policy, conventions, and instructions for all Gnexus services. It answers "how should a new service be built"; gnexus-book answers "what exists and where".

Repository

  • Git URL: https://git.gnexus.space/git/root/gnexus-handbook.git
  • Web: https://git.gnexus.space/root/gnexus-handbook
  • Default branch: master
  • Initial commit: e10b4c3 (2026-10-04, 14 files); latest: 1a4a888 (2026-10-04, health self-report layer).
  • Local path (navi rei): /home/ubuntu/workspace/gnexus-handbook (read access; push requires a GitBucket token — currently pushed via navi instance pilar on the gitbucket VM).

Role

  • The owner references this repository instead of repeating conventions in every task or chat.
  • Agents must read the handbook README before creating a new service.
  • Raw file links for services and docs: https://git.gnexus.space/root/gnexus-handbook/raw/master/<path>

Structure

  • 00-principles.md — platform principles (self-hosted, open-source, budget-first, secrets, safety-first, documentation)
  • 10-platform/ — conventions: auth (gnexus-auth SSO), ui (gnexus-ui-kit), notifications (Gnexus Synapse), secrets (gnexus-creds), git (GitBucket), health, i18n, mcp
  • 20-deployment/ — informational reference for developing agents (hosting, domains, backups): describes how things are arranged, not prescriptions
  • 30-operations/ — conventions: monitoring (hard-panel, Synapse alerts), documentation rules (gnexus-book)
  • 90-templates/ — new service checklist, service documentation template

Boundaries

  • Rules and references only. Facts (IPs, versions, state, routes) belong in gnexus-book.
  • No secrets in the repository.