Nextcloud, NetBox and n8n integrations
Three read-only integrations, each with a monitoring page, alerts, maintenance silencing and held-when-unreadable handling. Nextcloud: database needing upgrade (critical), maintenance mode, and the data disk running low; users, files and app updates with an admin app password. NetBox: no background worker running, counts, and a list of the servers this app manages that have no address in NetBox (a list, not an alert). n8n: an active workflow whose last run failed, clearing when it next succeeds. Disk messages for Immich, Paperless and Nextcloud now use the same units as the pages that show them. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
a16996d975
commit
4ff0b44943
46 files changed
+10137
-10
No files matched your search
@@ -349,6 +349,43 @@ That works on every Duplicati version, needs no login handshake and leaves nothi
|
||||
- **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
|
||||
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
|
||||
|
||||
- **Config fields:** the **address** of Nextcloud (`https://cloud.example.lan`); optionally an **administrator's name and an app password** (Personal settings → Security → Devices & sessions → *Create new app password*; stored encrypted — never the account's own password); and, for an https address with a certificate you made
|
||||
yourself, *insecure*.
|
||||
- **Required access:** read only. Without a login only `/status.php` is read, which Nextcloud answers to anyone. With one, the *Monitoring* app (`serverinfo`, installed by default) is also asked, which needs an **administrator**; if it is refused or the app is off, the status is still read and the page says so. This
|
||||
app only ever sends GET requests, and **nothing is changed**.
|
||||
- **What it does:** every **five minutes** Nextcloud is read and stored — its version, whether it is in **maintenance mode**, whether it **needs its database upgrading**, and (with the login) the **room left where the data is kept**, the users, the files, who was active in the last day and how many **app updates** wait. **Monitoring → Nextcloud** shows it.
|
||||
- **Alerts** (source *Nextcloud*; held back by maintenance on the integration): **the database needs upgrading** (critical — nobody can use it until `occ upgrade`), **maintenance mode is on** (warning — nobody can sign in), and **less than 20 GB is left for the data** (warning; under **5 GB**, critical).
|
||||
- If Nextcloud 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.
|
||||
- `/metrics` has `homelab_nextcloud_maintenance_mode`, `homelab_nextcloud_free_bytes`, `homelab_nextcloud_active_users_24h` and `homelab_nextcloud_app_updates` for each Nextcloud that was read lately.
|
||||
- **Not verified against a live Nextcloud** — `/status.php` and the Monitoring app's `/ocs/v2.php/apps/serverinfo/api/v1/info` are as Nextcloud publishes them and the reader is tried against a pretend server. **Whether background jobs (cron) are running is not read**: the API used here does not say, so a cron that has
|
||||
stopped is not noticed. With **Nextcloud AIO** the admin pages are the mastercontainer's, but the Nextcloud behind it is an ordinary one and is read the same way (use its own address, not the AIO admin address).
|
||||
|
||||
### NetBox
|
||||
|
||||
- **Config fields:** the **address** of NetBox (`https://netbox.example.lan`), an **API token** (your profile → API Tokens; stored encrypted; **write enabled off** is enough — both the older `Token` tokens and NetBox 4.5's `nbt_…` tokens work) and, for an https address with a certificate you made yourself, *insecure*.
|
||||
- **Required access:** read only. `/api/status/`, and the counts and addresses of devices, virtual machines, prefixes and IP addresses. This app only ever sends GET requests; **nothing is changed**.
|
||||
- **What it does:** every **five minutes** NetBox is read and stored — its version, **how many background workers are running** (they run its webhooks, scripts, jobs and reports; in the Docker image they are a separate container that can be down while the pages still load), how many devices, VMs, prefixes and addresses it holds, and the addresses
|
||||
themselves (up to 5000). **Monitoring → NetBox** shows it.
|
||||
- **Alert** (source *NetBox*; held back by maintenance on the integration): **no background worker is running** (warning).
|
||||
- **Not in NetBox**: the page lists the servers this app manages **none of whose addresses are in NetBox** (an address that is the same on every host, like Docker's bridge, is left out as on the Consistency page; loopback and link-local addresses say nothing). That is a **list, not an alert** — documentation that is behind is not an outage. If NetBox
|
||||
holds more than 5000 addresses the page says what is missing may be in the part that was not read.
|
||||
- If NetBox cannot be read for 20 minutes its alert is neither raised nor cleared, and the Alerts page says it could not check.
|
||||
- `/metrics` has `homelab_netbox_workers`, `homelab_netbox_devices` and `homelab_netbox_ip_addresses` for each NetBox that was read lately.
|
||||
- **Not verified against a live NetBox** — the endpoints and fields are as NetBox publishes them and the reader is tried against a pretend server that answers the addresses in pages. The **Diagnostic Log** has what was asked and answered.
|
||||
|
||||
### n8n
|
||||
|
||||
- **Config fields:** the **address** of n8n (`http://host:5678`), an **API key** (Settings → n8n API → *Create an API key*; stored encrypted) and, for an https address with a certificate you made yourself, *insecure*.
|
||||
- **Required access:** read only. `GET /api/v1/workflows` and `GET /api/v1/executions` — the public API has to be switched on (it is on by default in current versions). This app only ever sends GET requests: **no workflow is started, changed or switched off**.
|
||||
- **What it does:** every **five minutes** n8n is read and stored — the workflows and whether each is switched on, and, from the **newest 250 runs**, each workflow's **last outcome** and how many of its runs failed in the last day. **Monitoring → n8n** shows it.
|
||||
- **Alert** (source *n8n*, category *Automation*; held back by maintenance on the integration): **a workflow that is switched on failed on its last run** (warning; one alert for each workflow, saying when and, if more than one run failed, how many in the last day). It **clears by itself** when the workflow next succeeds. A workflow that is switched off, or
|
||||
whose failure is more than a week old, is not raised.
|
||||
- If n8n cannot be read for 20 minutes its alerts are neither raised nor cleared, and the Alerts page says it could not check. If the runs could not be read (but the workflows could), the last outcomes are *unknown* and nothing is claimed.
|
||||
- `/metrics` has `homelab_n8n_workflows`, `homelab_n8n_workflows_active` and `homelab_n8n_workflows_failing` for each n8n that was read lately.
|
||||
- **Not verified against a live n8n** — the endpoints and fields are as n8n documents them and the reader is tried against a pretend server that pages with a cursor. A workflow that runs less often than 250 other runs go by may show no run (and so no alert); the page says it is judged from the newest 250.
|
||||
|
||||
### Paperless-ngx
|
||||
|
||||
- **Config fields:** the **address** of Paperless-ngx (`http://host:8000`), an **API token** (your profile → *API Auth Token*, or Auth Tokens in the admin pages; stored encrypted) and, for an https address with a certificate you made yourself, *insecure*.
|
||||
|
||||
Reference in new issue
Block a user