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>
19 lines
1.2 KiB
Markdown
19 lines
1.2 KiB
Markdown
# 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](0001-single-host-docker-compose.md) | Single bare-metal host, Docker Compose per customer | Accepted |
|
|
| [0002](0002-traefik-as-edge.md) | Traefik as the edge router | Accepted |
|
|
| [0003](0003-nginx-fpm-per-site.md) | Per-site nginx + php-fpm behind Traefik | Accepted |
|
|
| [0004](0004-shared-mariadb.md) | Shared MariaDB instance, per-site DB + user | Accepted |
|
|
| [0005](0005-zfs-per-customer.md) | ZFS dataset per customer | Accepted |
|
|
| [0006](0006-decoupled-backup-streams.md) | Decoupled backup streams (files vs DB vs logs) | Accepted |
|
|
| [0007](0007-forgejo-over-gitlab.md) | Forgejo (lightweight) over GitLab | Accepted |
|
|
| [0008](0008-cli-first-panel-later.md) | CLI/templating first, customer panel later | Accepted |
|
|
| [0009](0009-sftp-only.md) | 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.
|