Immich: inspector shows why a request was refused; server.versionCheck documented
Inspect on a real Immich got data only from /server/about and /server/storage; the other four answered with a bare message, most likely a key without the permissions. The inspector now keeps the short message of any answer with HTTP 400 and up (never for a good answer) and shows it on the page and in the copied report. The permission list now includes server.versionCheck, and the docs say which endpoints have been seen live. Tests added. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
76d6bfa85e
commit
6052595dea
7 files changed
+41
-7
No files matched your search
+2
-2
@@ -408,7 +408,7 @@ osTicket's API cannot close a ticket, so this is the one place in the app that *
|
||||
### Immich
|
||||
|
||||
- **Config fields:** the **address** of Immich (`http://host:2283`), an **API key** (Immich → Account Settings → API Keys; stored encrypted) and, for an https address with a certificate you made yourself, *insecure*.
|
||||
- **Required access:** read only. Give the key just these permissions: `server.about`, `server.storage`, `server.statistics` and `job.read` (`queue.read` on newer versions) — statistics and jobs need an administrator's key. This app only ever sends GET requests; **nothing is changed, and no job is started, paused or cleared**.
|
||||
- **Required access:** read only. Give the key just these permissions: `server.about`, `server.storage`, `server.versionCheck`, `server.statistics` and `job.read` (`queue.read` on newer versions) — statistics and jobs need an administrator's key. Without one of them that part is left out (and **Inspect** shows the reason Immich gave, such as *Missing required permission: server.versionCheck*). This app only ever sends GET requests; **nothing is changed, and no job is started, paused or cleared**.
|
||||
If one of those is refused, that part is left out and the rest still works.
|
||||
- **What it does:** every **five minutes** Immich is read and stored — its version (and whether a newer one is out), how full the **disk under the library** is, how many **photos and videos** there are and what they take, and the **background job queues** with how many jobs **failed** in each.
|
||||
**Apps → Immich** shows it.
|
||||
@@ -416,7 +416,7 @@ osTicket's API cannot close a ticket, so this is the one place in the app that *
|
||||
Failed jobs stay counted until you run them again or clear them in Immich, so the alert stays until you do).
|
||||
- If Immich cannot be read for 20 minutes its alerts are neither raised nor cleared, the Alerts page says it could not check, and the integration is raised as failing like any other. A part that could not be asked is *unknown*, never *none*.
|
||||
- `/metrics` has `homelab_immich_photos`, `homelab_immich_videos`, `homelab_immich_library_bytes`, `homelab_immich_disk_used_percent` and `homelab_immich_failed_jobs` for each Immich that was read lately.
|
||||
- **Not verified against a live Immich** — the endpoints (`/api/server/about`, `/server/storage`, `/server/statistics`, `/server/version-check`, `/api/jobs`, and `/api/queues` on newer versions) and their fields are as Immich publishes them, and the reader is tried against a pretend server that answers both ways. Immich renames
|
||||
- **Partly checked against a live Immich** (Inspect): `/api/server/about` and `/api/server/storage` answered as the reader expects (version, disk size, used and percent). On the first check the other four (`/server/statistics`, `/server/version-check`, `/jobs`, `/queues`) were refused with a short message instead of data — most likely a key without those permissions or not an administrator's — so photos, videos, usage, the latest version and the job queues are **not yet seen with data**. The endpoints (`/api/server/about`, `/server/storage`, `/server/statistics`, `/server/version-check`, `/api/jobs`, and `/api/queues` on newer versions) and their fields are as Immich publishes them, and the reader is tried against a pretend server that answers both ways. Immich renames
|
||||
these now and then; the **Diagnostic Log** has what was asked and answered if something comes back empty. Whether a *waiting* backlog is a problem is not judged: a big import has one for days.
|
||||
|
||||
### Nextcloud
|
||||
|
||||
Reference in new issue
Block a user