docs: correct admin-credentials help text (fixes #34) #35

Merged

steve merged 2 commits from docs/admin-creds-help-text into main 2026-08-21 22:39:04 +01:00

Conversation 2 Commits 2 Files Changed 1

+8 -4

steve commented 2026-08-21 21:01:47 +01:00

Owner

Copy Link

Copy Source

Four-line text fix for #34.

What changed:

• prune / forget → prune, plus an explicit note that forget runs with the everyday repo credentials and so needs delete authority on them.
• Replaced "leave this blank — the everyday repo credentials handle prune too" with a warning that prune is skipped entirely when unset, on any backend.

Evidence and full trace in #34. Verified against main @ 6c6b962; <strong> usage matches the surrounding templates (add_host.html, source_group_edit.html).

Docs only — no behaviour change. The underlying limitation (forget can't work against an append-only everyday user) is noted in #34 as a separate question.

Four-line text fix for #34. **What changed:** - `prune / forget` → `prune`, plus an explicit note that forget runs with the everyday repo credentials and so needs delete authority on them. - Replaced *"leave this blank — the everyday repo credentials handle prune too"* with a warning that prune is **skipped entirely** when unset, on any backend. Evidence and full trace in #34. Verified against `main` @ `6c6b962`; `<strong>` usage matches the surrounding templates (`add_host.html`, `source_group_edit.html`). Docs only — no behaviour change. The underlying limitation (forget can't work against an append-only everyday user) is noted in #34 as a separate question.

steve added 1 commit 2026-08-21 21:01:47 +01:00

docs: correct admin-credentials help text ... e9df802478

Forget does not use admin credentials. Only JobPrune builds a runner
against the admin slot (cmd/agent/main.go:622-645); JobForget runs on
the everyday runner, as the comment at main.go:517-524 states.

Also corrects the claim that leaving this blank lets everyday creds
handle prune: maintenance_dispatch.go:52-56 skips prune entirely with
'prune skipped — no admin creds' on any backend, with no fallback.

Refs #34

steve commented 2026-08-21 21:12:23 +01:00

Author

Owner

Copy Link

Copy Source

One wording issue before accepting: the S3 / B2 / SFTP / local guidance is contradictory. It says to “leave this blank”, but the implementation skips both scheduled and manual prune whenever the admin credential slot is unset, regardless of backend.

Suggested replacement:

For S3 / B2 / SFTP / local, enter the same delete-capable repository credentials here if you want prune enabled. Prune is skipped when admin credentials are unset, on any backend.

One wording issue before accepting: the S3 / B2 / SFTP / local guidance is contradictory. It says to “leave this blank”, but the implementation skips both scheduled and manual prune whenever the admin credential slot is unset, regardless of backend. Suggested replacement: > For S3 / B2 / SFTP / local, enter the same delete-capable repository credentials here if you want prune enabled. Prune is skipped when admin credentials are unset, on any backend.

steve added 1 commit 2026-08-21 22:36:16 +01:00

docs: address review — make S3/B2/SFTP/local guidance actionable ... a8a6fdfab5

The previous wording told operators to leave the slot blank and then
warned that doing so disables prune, which is contradictory. Prune is
gated on the admin slot for every backend, on both paths:
scheduled (maintenance_dispatch.go:52) skips silently, manual
(repo_ops.go:39) returns 400 admin_creds_required.

Also reworded the opening line, which still said 'only needed for
rest-server repos' while the new text asks other backends to fill it in.

steve commented 2026-08-21 22:36:25 +01:00

Author

Owner

Copy Link

Copy Source

Adopted your wording in a8a6fdf, thanks — the previous version was contradictory as you say.

I confirmed the claim about manual prune before writing it in, since I had only traced the scheduled path originally. Both are gated, though they differ in how loudly:

• Scheduled — maintenance_dispatch.go:52-56 logs prune skipped — no admin creds and continues. Silent: no job row, no alert.
• Manual — repo_ops.go:39-44 returns 400 admin_creds_required with "set admin credentials on the Repo page before running prune". Visible.

So the text is accurate for both backends and both paths.

One extra change beyond your suggestion: the paragraph still opened with "Only needed for rest-server repos...", which contradicted the new sentence asking S3/B2/SFTP/local users to fill it in. Reworded to "Required for prune. On rest-server repos this is the delete-capable user, as distinct from the append-only user used for everyday backups." Happy to drop that if you would rather keep the diff minimal.

Prose only — no Go code touched. Structural counts identical to baseline (6 <p>/</p>, 141/141 template delimiters).

Adopted your wording in a8a6fdf, thanks — the previous version was contradictory as you say. I confirmed the claim about manual prune before writing it in, since I had only traced the scheduled path originally. Both are gated, though they differ in how loudly: - **Scheduled** — `maintenance_dispatch.go:52-56` logs `prune skipped — no admin creds` and `continue`s. Silent: no job row, no alert. - **Manual** — `repo_ops.go:39-44` returns `400 admin_creds_required` with *"set admin credentials on the Repo page before running prune"*. Visible. So the text is accurate for both backends and both paths. One extra change beyond your suggestion: the paragraph still opened with *"Only needed for rest-server repos..."*, which contradicted the new sentence asking S3/B2/SFTP/local users to fill it in. Reworded to *"Required for prune. On rest-server repos this is the delete-capable user, as distinct from the append-only user used for everyday backups."* Happy to drop that if you would rather keep the diff minimal. Prose only — no Go code touched. Structural counts identical to baseline (6 `<p>`/`</p>`, 141/141 template delimiters).

steve merged commit 27be28ee9c into main 2026-08-21 22:39:04 +01:00

steve deleted branch docs/admin-creds-help-text 2026-08-21 22:39:04 +01:00

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

enhancement

New feature or improvement to existing functionality

No Label

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

steve

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: steve/restic-manager#35