Submitted for approval. Proxmox Dashboard is waiting for review on the Elgato Marketplace. This page will link to the listing as soon as it is approved.
What it shows
The overview
- Connections: each Proxmox VE server or cluster, Backup Server and Datacenter Manager, with a status dot, its host, nodes up, guests running, and CPU and RAM bars. A Backup Server shows its datastores, the space used and the newest backup.
- Attention: what needs you, most urgent first. A connection failing, no quorum, a node or remote down, a locked guest, storage nearly full or filling soon, a failed garbage collection or verify, a backup over a week old. When nothing does, it says All good.
- Nodes, guests, storage and backups at a glance, where the size allows.
The pages
- Nodes: CPU, RAM and disk bars, uptime, load, cores and version for every node, with the recent tasks beside them.
- Guests: every VM and container, running first, with CPU, RAM, uptime, tags, HA state and locks, and a summary with the busiest guests.
- Storage: Proxmox VE storage fullest first, and Backup Server datastores with the space used, when they will fill, garbage collection and verification.
- Backups: every backup group oldest first, coloured by age (green under 36 hours, amber under 7 days, red after), the guests with no backup at all, and the Backup Server's tasks.
- Datacenter Manager: every remote, answering or not, with its nodes up and guests running. This tab appears only while a Datacenter Manager connection is set up.
When something is missing
The widget says what is missing instead of going blank, and everything comes back by itself once the figures flow again.
- Waiting for Proxmox data: there is no file yet. It names what to start and where to get it. After a minute it says Still waiting for Proxmox data (see the FAQ).
- Stream Deck closed or Proxmox Link stopped: the program that writes the file was quit or paused.
- Stream Deck is not running or Proxmox Link is not running: no new figures for a minute, with the time of the last ones.
- The feed is off: the plugin's Feed the XENEON EDGE widget setting is unticked.
- No connections set up: the plugin or Proxmox Link has no server to read yet.
- When one connection stops answering, its dot turns red and it says why, such as Auth failed or Timeout, with the age of its last figures. Attention lists it too.
What you need
- A Corsair XENEON EDGE, on Windows.
- iCUE 5.51 or newer. Earlier versions cannot let a widget read a file.
- One of these on the same PC:
- Proxmox & PBS Control, our Stream Deck plugin, 2.1.0 or newer, from the Elgato Marketplace, with Feed the XENEON EDGE widget ticked (the default); or
- Proxmox Link, a small Windows program for people without a Stream Deck.
- Proxmox VE 7 or later, Proxmox Backup Server 2 or later and/or Proxmox Datacenter Manager 1.0 or later, reachable from your PC.
- An API token on each server. Read-only is enough: see how to make one for the plugin or for Proxmox Link.
Feeding it
A widget cannot read the Proxmox API itself: iCUE blocks a widget's requests to a server that does not allow
them, and Proxmox does not. So a program on your PC reads your servers with your own API tokens and writes the
figures to one file, %APPDATA%\, every few seconds. The widget
draws from that file. The file holds host names and figures only, never a token or secret.
Two programs can write it, in the same format:
- Proxmox & PBS Control 2.1.0 or newer, with its setting Feed the XENEON EDGE widget (any Proxmox key's settings, under Connections). It is on by default, and refreshes every 10 seconds unless you change it.
- Proxmox Link, which sits in the notification area and refreshes every 30 seconds unless you change it. Download it and set it up on the Proxmox page.
If both run, Proxmox Link writes the file and the plugin steps aside.
Start the plugin or Proxmox Link once before you add the widget in iCUE. That makes the folder the widget reads, and iCUE only watches a folder that existed when the widget was added. If you placed the widget first, remove it and add it again, or restart iCUE.
The permission prompt
The first time the widget runs, iCUE asks whether Proxmox Dashboard may access a folder. The
folder is %APPDATA%\, where the plugin or Proxmox Link writes its file, and it is
the only thing the widget asks for: one folder, read only, and no network at all. Your tokens are not in that
folder. Allow it and your servers appear. If you deny it, the widget keeps waiting.
Sizes and settings
You choose the size in iCUE when you place the widget: Small, Medium, Large or Extra Large, across or upright. Every page is laid out for every size. A list too long for its panel says how many rows it holds; tap it to see the next ones.
In the widget's settings in iCUE you can:
- Show the dashboard (the overview with page tabs) or one page (Nodes, Guests, Storage, Backups or Datacenter Manager remotes), so you can put one big dashboard on the Edge and smaller Proxmox Dashboard widgets beside it;
- switch the page tabs on the dashboard on or off. The Edge is a touchscreen, so a tap on a tab opens that page, and a red dot on a tab says something there needs you;
- show every connection, or just one of A, B or C per widget;
- filter the guests: all, running only, stopped only, virtual machines only or containers only;
- use a 12-hour or a 24-hour clock;
- set the text, accent and background colours, and the background transparency. The accent is orange until you change it.
What it can and cannot do
- It reads one file in one folder on your PC. No network, no account, nothing stored, and the widget writes nothing; nothing leaves your PC from the widget.
- It is read-only. It cannot start, stop, reboot or change anything on your servers. Taps only change what the widget shows.
- Your API tokens stay in the plugin or Proxmox Link. The file holds host names and figures only, never a token or secret.
Frequently asked
Do I need a Stream Deck?
No. Proxmox Link is a small Windows program that writes the same file as the Stream Deck plugin. It reads your servers with a read-only API token and needs no administrator rights to install.
Can I use it with the Stream Deck plugin at the same time?
Yes. The plugin's keys and the widget read the same servers. If you also run Proxmox Link, it writes the file and the plugin steps aside; quit or pause Proxmox Link and the plugin takes over again within a few seconds.
It says Still waiting for Proxmox data.
Start Stream Deck with Proxmox & PBS Control 2.1.0 or newer, or start Proxmox Link, and allow iCUE's permission prompt. iCUE can only watch a folder that already exists, so if you added the widget before either program had ever run, remove the widget and add it again, or restart iCUE.
Is this made by Proxmox or Corsair?
No. Proxmox Dashboard is an unofficial project made by TeaTime, not affiliated with or endorsed by Proxmox Server Solutions GmbH or Corsair. Proxmox is a registered trademark of Proxmox Server Solutions GmbH, and XENEON EDGE and iCUE are trademarks of Corsair. No Proxmox logo or artwork is used: every picture is drawn in code, with panels, bars, dots and simple glyphs.
Something is still wrong.
Email support@teatimeservers.ca and tell us what the widget says.