Skip to content

Docs: cover the TrueNAS WebSocket API and system summary source - #127

Open
SandObserver wants to merge 1 commit into
mainfrom
docs/truenas-websocket
Open

SandObserver wants to merge 1 commit into
mainfrom
docs/truenas-websocket

Conversation

@SandObserver

Copy link
Copy Markdown
Owner

Summary

  • System summary: add the TrueNAS source with its fields, the REPORTING_READ, POOL_READ and DATASET_READ roles, the READONLY_ADMIN role for uptime, pool slots and no throughput mode.
  • Disk health: TrueNAS reads 25.04 and later over the WebSocket API and older versions over REST, needs POOL_READ, refuses an http:// address, and gains Allow Self-Signed Certificate.
  • Widgets index: list TrueNAS as a System summary source.
  • Security: the TrueNAS WebSocket connection passes the same SSRF check.
  • Describes Feature: TrueNAS WebSocket API for disk health and system summary Stackyard#546. Held for the next stable release.

Testing
npm run build and npm run check pass. Text only.

Checklist

  • npm run build and npm run check both pass.
  • Product UI is shown by running or capturing it, never recreated in CSS.
  • Any new preview or screenshot carries no private hostnames or real data.
  • Visual changes verified in both colour schemes and both docs themes.
  • Links to the app repo still resolve.

@SandObserver SandObserver added the content Documentation content: wording, structure, new pages label Oct 23, 2026
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying stackyard-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: ae3143a
Status: ✅  Deploy successful!
Preview URL: https://84a9e7d3.stackyard-docs.pages.dev
Branch Preview URL: https://docs-truenas-websocket.stackyard-docs.pages.dev

View logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content Documentation content: wording, structure, new pages

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant