Homelab
@me__zlxp/homelabv2026.10.24.1
01README
Homelab health as swamp data: TrueNAS SCALE pools, apps and alerts over its JSON-RPC API with certificate pinning, Immich library and job queues, and go2rtc camera streams checked frame by frame.
02Release Notes
First release: TrueNAS SCALE (JSON-RPC over pinned TLS) system, pools, apps, alerts and app start/stop; Immich library, disk, queues and albums; go2rtc streams and per-camera frame health; parallel homelab-health workflow.
03Behaviors
@me__zlxp/truenasv2026.10.24.1truenas.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| host | string | Hostname or IP address of the NAS, e.g. nas.example.com or 192.0.2.10 |
| port? | number | HTTPS port of the web UI |
| username? | string | User the API key belongs to |
| apiKey | string | API key (Credentials → API Keys). Supply it from a vault |
| certificatePem? | string | PEM of the NAS's own certificate to pin. Needed for the default self-signed certificate; |
| timeoutSeconds? | number | Per-call timeout |
fn info()
Write the system resource: version, hostname, model, cores, memory, uptime
fn pools()
Write one pool resource per ZFS pool (status, health, capacity, last scrub)
fn apps()
Write one app resource per installed app (state, version, updates)
fn alerts()
Write the alerts resource: counts by severity and every undismissed alert
fn startApp(name: string, timeoutSeconds?: number)
Start an app and wait for the start job to finish; writes the app's new state
| Argument | Type | Description |
|---|---|---|
| name | string | App name as shown in Apps, e.g. immich |
| timeoutSeconds? | number | How long to wait for the job |
fn stopApp(name: string, timeoutSeconds?: number)
Stop an app and wait for the stop job to finish; writes the app's new state
| Argument | Type | Description |
|---|---|---|
| name | string | App name as shown in Apps, e.g. immich |
| timeoutSeconds? | number | How long to wait for the job |
Resources
system(infinite)— Version, hardware and uptime
pool(infinite)— One ZFS pool's health and capacity
app(infinite)— One app's state and available updates
alerts(infinite)— Active (undismissed) alerts
@me__zlxp/immichv2026.10.24.1immich.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| url | string | Base URL of the Immich server, e.g. http://nas.example.com:2283 (without /api) |
| apiKey | string | Immich API key (Account Settings → API Keys). Supply it from a vault |
| timeoutSeconds? | number | Per-request timeout |
fn library()
Write the library resource: version and photo, video and storage totals (admin key)
fn disk()
Write the disk resource: capacity of the upload volume
fn queues()
Write one queue resource per background queue, plus a queues summary
fn albums()
Write one album resource per album the key's user can see
Resources
library(infinite)— Server version and library totals
disk(infinite)— Upload volume capacity
queue(infinite)— One background queue's job counts
queues(infinite)— Which queues are busy, failing or paused
album(infinite)— One album's size and activity
@me__zlxp/go2rtcv2026.10.24.1go2rtc.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| url | string | Base URL of go2rtc's API, e.g. http://nas.example.com:1984 |
| username? | string | Basic-auth user, when go2rtc's api.username is set |
| password? | string | Basic-auth password. Supply it from a vault |
| timeoutSeconds? | number | Per-request timeout |
fn streams()
Write one stream resource per configured stream (sources, producers, viewers)
fn health(streams?: array)
Fetch a fresh JPEG frame from each stream; write per-stream health and a summary
| Argument | Type | Description |
|---|---|---|
| streams? | array | Streams to check; all of them when omitted |
Resources
stream(infinite)— One configured stream and who is using it
health(infinite)— Whether one stream produced a frame
healthSummary(infinite)— Which streams are online and offline
04Workflows
@me__zlxp/homelab-healthcb77abc0-4b8c-42ae-8812-0a8c9f63683c
Check the whole homelab in one run. Every check is independent, so they run in parallel and one failure does not hide the others.
healthRead NAS, photo library and camera health into swamp data
1.nas-poolsnas.pools— ZFS pool status and capacity
2.nas-alertsnas.alerts— Active TrueNAS alerts by severity
3.nas-appsnas.apps— Which apps are running and which have updates
4.photo-queuesphotos.queues— Immich background queue backlog and failures
5.camera-healthcameras.health— Fetch a live frame from every camera
05Stats
B
87 / 100
Downloads
7
Archive size
28.0 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository0/2missing
06Platforms
07Labels