Skip to content

Public Status Page

Cluster health dashboard for monitoring screens

The Status Page plugin provides a public, read-only view of your cluster health - designed for IT monitoring screens and NOC dashboards. It requires no login; instead, access is controlled via a URL auth key (similar to PRTG status pages).

No Login Required

Access via /status?key=your_auth_key. The auth key is generated in the plugin settings and validated using timing-safe comparison to prevent brute-force attacks.

Cluster Overview

Shows all connected clusters with online/offline status, node health (CPU, RAM, uptime), VM counts (running/stopped/VMs/containers), and storage usage.

Auto-Refresh

The page auto-refreshes at a configurable interval (default 30s) with a visible countdown timer. Perfect for always-on monitoring displays.

Overall Status Badge

A prominent badge shows "All Systems Operational", "Partial Outage", or "All Systems Down" based on cluster and node connectivity.

Setup

Enable the Plugin

Go to Settings → Server → Plugins and enable "Public Status Page".

Generate Auth Key

Click the Edit icon on the plugin to open its config. Set or note the auth_key value. You can also generate one via the plugin's API.

Access the Page

Open https://your-server:5000/status?key=your_auth_key in a browser. Bookmark this URL for your monitoring screen.

Configuration

Edit plugins/status_page/config.json via Settings → Plugins → Edit (the file is in the plugin folder of your install; from 1.4.0 an update keeps it):

Setting Default Description
auth_key "" Required. The URL key for accessing the status page.
page_title "System Status" Title shown on the page
refresh_interval 30 Auto-refresh interval in seconds
show_node_details true Show per-node CPU/RAM/uptime cards
show_vm_summary true Show VM count summary (running/stopped/VMs/LXC)
show_storage true Show storage usage bars
show_cluster_name true Show real cluster names (disable for privacy)
theme_color "#e57000" Accent color
custom_logo_url "" Optional URL of a logo shown in the page header

API

Method Endpoint Description
GET /status?key=xxx Status page HTML (public)
GET /api/public/status-page?key=xxx Status data as JSON (public)
GET /api/plugins/status_page/api/config Full config including auth key (admin only)
POST /api/plugins/status_page/api/generate-key Generate new auth key (admin only)