bart/platform
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
platform/docs/adr
History
Bart Van Geyt 9f819df4d9 Phase 0: architecture docs, ADRs, and repo scaffold 
Establish the design foundation for the heleosv2 multi-tenant hosting
platform before any implementation code:

- Monorepo skeleton: docs/, platform-infra/, site-templates/,
  deployments/, control-panel/ with orientation READMEs.
- docs/: roadmap index, architecture + threat model, naming conventions,
  site profiles, provisioning workflow, backup & DR runbook, repo/GitOps
  layout, and the approved architecture plan.
- docs/adr/: 9 ADRs recording the rationale for single-host Compose,
  Traefik edge, nginx+fpm split, shared MariaDB, ZFS-per-customer,
  decoupled backup streams, Forgejo, CLI-first, and SFTP-only.
- Secrets hygiene: .gitignore (only *.enc.* committed) and .gitattributes
  (LF for scripts/Dockerfiles/YAML run on the Linux host).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-07 12:26:00 +02:00
..
0001-single-host-docker-compose.md Phase 0: architecture docs, ADRs, and repo scaffold 2026-07-07 12:26:00 +02:00
0002-traefik-as-edge.md Phase 0: architecture docs, ADRs, and repo scaffold 2026-07-07 12:26:00 +02:00
0003-nginx-fpm-per-site.md Phase 0: architecture docs, ADRs, and repo scaffold 2026-07-07 12:26:00 +02:00
0004-shared-mariadb.md Phase 0: architecture docs, ADRs, and repo scaffold 2026-07-07 12:26:00 +02:00
0005-zfs-per-customer.md Phase 0: architecture docs, ADRs, and repo scaffold 2026-07-07 12:26:00 +02:00
0006-decoupled-backup-streams.md Phase 0: architecture docs, ADRs, and repo scaffold 2026-07-07 12:26:00 +02:00
0007-forgejo-over-gitlab.md Phase 0: architecture docs, ADRs, and repo scaffold 2026-07-07 12:26:00 +02:00
0008-cli-first-panel-later.md Phase 0: architecture docs, ADRs, and repo scaffold 2026-07-07 12:26:00 +02:00
0009-sftp-only.md Phase 0: architecture docs, ADRs, and repo scaffold 2026-07-07 12:26:00 +02:00
README.md Phase 0: architecture docs, ADRs, and repo scaffold 2026-07-07 12:26:00 +02:00

README.md

Architecture Decision Records

Short records capturing why each major choice was made. Format: Context → Decision → Consequences. Status is one of Proposed / Accepted / Superseded.

ADR Decision Status
0001 Single bare-metal host, Docker Compose per customer Accepted
0002 Traefik as the edge router Accepted
0003 Per-site nginx + php-fpm behind Traefik Accepted
0004 Shared MariaDB instance, per-site DB + user Accepted
0005 ZFS dataset per customer Accepted
0006 Decoupled backup streams (files vs DB vs logs) Accepted
0007 Forgejo (lightweight) over GitLab Accepted
0008 CLI/templating first, customer panel later Accepted
0009 SFTP only (no FTP) Accepted

New ADRs are additive and numbered sequentially. To reverse a decision, add a new ADR that supersedes the old one rather than editing history.