Files
restic-manager/docs/book/src/roadmap.md
T
steve 89537d417a P5: OSS readiness — docs site, contributor onboarding, e2e harness
P5-01 — Documentation site under docs/book/ rendered with mdBook
(downloaded via Makefile, same static-binary pattern as Tailwind).
Structured chapters: getting started, concepts, operations,
security, reference. `make docs` / `make docs-watch`. Generated
output gitignored.

P5-02 — CONTRIBUTING.md rewritten from placeholder to a full
guide. CODE_OF_CONDUCT.md adapted from Contributor Covenant for a
single-maintainer project. .gitea/issue_template/{bug,feature}.md
and PULL_REQUEST_TEMPLATE.md.

P5-04 — Six README screenshots captured live from a fresh server
bootstrap (login, empty dashboard, add-host, alerts, settings,
audit log). README rewritten to centre the screenshot grid and
link out to the docs site.

P5-05 — SECURITY.md with disclosure policy (3-day ack, 30-day
default window), scope in/out, threat-model summary, operator
hardening checklist. Mirrored as a docs-site chapter.

P5-06 — End-to-end test harness. e2e/compose.e2e.yml brings up
server + sibling Linux agent (alpine + restic) + restic/rest-server.
Agent uses announce-and-approve so Playwright can drive the full
operator flow: bootstrap → login → accept pending → backup →
verify terminal status. Second spec scrapes /metrics to assert
the P6-04 endpoint surface. .gitea/workflows/e2e.yml runs on every
PR; local how-to in docs/e2e.md.
2026-05-08 20:08:23 +01:00

1.4 KiB

Roadmap

The live roadmap is in tasks.md. Phases ship in order; items inside a phase ship as the opportunity arises.

Status snapshot

Phase Theme Status
0 Project bootstrap done
1 MVP: enrolment, visibility, on-demand backup done
2 Scheduling, retention, repo operations done
3 Restore, alerts, audit done
4 RBAC, OIDC, host tags done
5 OSS readiness 🚧 in flight (this docs site is part of it)
6 Update delivery + observability polish done

What's not on the roadmap

The non-goals list in spec.md §2:

  • Replacing restic itself or providing custom repo formats
  • Managing non-restic backup tools
  • Multi-tenancy / SaaS deployment
  • High availability of the control plane (SQLite, single-instance)
  • Mobile-native apps (responsive web only)

If something there is critical to your use case, restic-manager isn't the right tool. That's not a closed door — it's a deliberate scope decision so the project stays maintainable.