API: document the push service and client profile endpoints
Also brings the GET /settings sample back in line with what the server
returns — it was missing the agent settings and the Apprise keys added since
it was written — and records the fourth rule that now holds: values are
effective, so a setting never explicitly saved reads as the default actually
in use rather than 0/false.
9bd23ce
Add Client Profiles page
Covers what a profile holds, why failure handling belongs on it rather than
being server-wide, the distinction between editing a profile (which changes
nothing) and Apply to Clients (which overwrites), and a worked example.
Cross-linked from Managing Clients and Backup Plans, and added to the sidebar.
84e77b8
API reference: neutral example in the sign-in response too
d885523
API reference: neutral example in the sign-in request
The login example used a real name and a device brand. Neither adds
anything to the documentation, and both say more about who wrote it than
the endpoint does.
b74089e
API reference: client install and stats, repository maintenance, restore
Brings the page level with the server again — 16 endpoints had shipped
undocumented.
Clients: the install command (and why it is the one place an agent key is
returned), and the stats endpoint with the windows it averages over.
Repositories: the six maintenance actions, catalog rebuild, recovery-point
deletion, and what a restore point holds — including has_databases on
archive listings so only usable restore points need be offered.
Restore: catalog search, download with its 507 space response, database
connectors and the single restore endpoint.
Also health (both the unauthenticated probe and the detailed check, with
what raises each state), plugin configuration writes and their write-only
secret handling, registered push devices, catalog freshness on the file
browse, and the jobs status filter now taking a list.
Every /api/v1 route is documented except the hosted platform's own
token rotation, which is intentionally not customer-facing.
9396d43
API reference: document the full /api/v1 surface
Brings the page up to date with everything added since it was written —
89 endpoints were live and roughly half were undocumented.
- Two token kinds (admin vs session) and how scoping differs between them
- Job detail by job id, with logs, queue position, current file and prune
stats; queue history, slots and 24h stats; cancel and retry
- Schedules day view, including how occurrences are placed in the
viewer's timezone and what each state means
- Dashboard, notifications, catalog browse, restore
- Session API: discover, login, 2FA, brokered SSO, sessions, push
- My Profile: account, timezones, password, storage alerts, 2FA, reports
- Server settings, notification services, backup templates, API tokens,
updates (all marked unreleased)
- Monitoring: metrics snapshot and fleet summary
- Expanded the error table (403/404/409/410/422 now mean more than they did)
Endpoints are labelled with the release that introduced them; the
settings group is marked unreleased until it ships.
301319f
Add NixOS to supported agent distros; NixOS setup note
dc475fb
Managing Clients: replace unblurred real-client screenshots with fictional demo data
The client-list, client-detail, and per-tab screenshots on this page showed
real client hostnames (uploaded user-attachment images). Swap all of them for
the acme.internal demo screenshots. Also drop the redundant real-data dashboard
<img> on the Dashboard page (a clean hero was already added).
1a425de
Updated Dashboard (markdown)
b562d2d
Add comprehensive UI screenshots throughout the wiki
- Capture 26 screenshots of a populated demo deployment (dashboard, clients
and all client tabs, queue, schedules, log, storage, settings tabs, users,
notifications, repository/job detail, create-repo/plan forms, 2FA, SSO, API).
- Replace ~90 'Screenshot:' placeholders with real images; remove placeholders
that had no corresponding screen.
- Add hero images to Home, Dashboard, Repositories, Notifications, Remote
Storage, Storage Setup, SSO, and API pages.
- Fix broken internal links ([[Agent Setup]]/[[Agent-Setup]] -> Linux Agent
Setup, [[Restore]] -> Restoring Files, backwards Standard Installation anchor).
aeddef5
Docker agent: note that borg cache/config persist in the agent volume
519226d
Getting Started: fix agent install instructions (bash one-liner, --key flag); note agents can't run inside the BBS container
c71a0ea
Updated History of BBS (markdown)
867a381
Document Ubuntu 26.04 support (v2.66.0+)
cb6b87b
API docs: recovery point lock/unlock endpoints and delete guards (#314)
17fe7f0
Updated Repositories (markdown)
f548457
Updated Backup Plans (markdown)
8bad235
Updated Dashboard (markdown)
5a33749
Updated Installation (markdown)
eac0ca1
Updated System Requirements (markdown)
24295d1
Updated System Requirements (markdown)
e060599
updated screenshot for wake on lan
046ddb8
Document Recovery Point Locking (v2.64.0)
383b816
API docs: users, server log, and schedules endpoints
b9b8075
API docs: document POST and DELETE /s3-credentials
b6325e6
API docs: clarify that non-secret responses work without the capability
ed70954
API docs: s3-credentials now uses include_secrets flag for consistency
fbc9698
API docs: document Display Secrets token capability
f242ba1
API docs: GET /api/v1/repositories with optional include_secrets
e9e9026
API docs: add GET /api/v1/s3-credentials
8af91a7