steve
89537d417a
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.
1.4 KiB
1.4 KiB
License
restic-manager is licensed under
PolyForm Noncommercial 1.0.0.
The full text lives at
LICENSE
in the repository root.
What this means
- Personal, hobbyist, educational, charitable, and similar noncommercial use is fully permitted, including modification and redistribution.
- Commercial use is not permitted without a separate license. The maintainer is not currently offering one — if you need commercial rights, open an issue to start the conversation.
- The license is permissive about everything except commercial use: you can fork, modify, deploy in your home/lab, and contribute back.
Why this license
The PolyForm Noncommercial license was chosen because:
- It's a real, legal, plainly-worded license (not a custom half-written variant).
- It permits the realistic uses for a hobby project (the maintainer's homelab, a friend's fleet, a charity's IT closet) without inviting commercial vendors to repackage the work.
- It's compatible with the project staying small and maintainable — the maintainer doesn't want to be on the hook for SLA-grade commercial support.
Contributions
By contributing, you agree your contributions are licensed under the same PolyForm Noncommercial 1.0.0 license.