pve-gui-sensors-auto/README.md
2026-08-01 19:37:20 +01:00

94 lines
2.3 KiB
Markdown

# pve-gui-sensors-auto
A small Debian package that automatically reapplies the Meliox Proxmox VE GUI sensor modification after Proxmox package upgrades replace the patched files.
This repository does **not** redistribute the Meliox installer. When a refresh is required, it downloads the installer from the official [`Meliox/PVE-mods`](https://github.com/Meliox/PVE-mods) repository.
## Defaults
- Average temperature per CPU
- Show fans reporting zero RPM
- Celsius
- UPS information disabled
- System information layout `1`
Settings are stored in:
```text
/etc/pve-gui-sensors-auto/config
```
## Install from a release
Download the latest `.deb` from **Releases**, then run:
```bash
apt install ./pve-gui-sensors-auto_*_all.deb
```
To avoid APT's harmless `_apt` warning, place the file in `/tmp` rather than `/root`:
```bash
cp pve-gui-sensors-auto_*_all.deb /tmp/
apt install /tmp/pve-gui-sensors-auto_*_all.deb
```
## Commands
```bash
pve-gui-sensors-refresh --status
pve-gui-sensors-refresh
pve-gui-sensors-uninstall
```
Logs are written to:
```text
/var/log/pve-gui-sensors-auto.log
```
## How it works
The package installs an APT `DPkg::Post-Invoke` hook. After package operations it checks both Proxmox files modified by the upstream sensor script:
```text
/usr/share/pve-manager/js/pvemanagerlib.js
/usr/share/perl5/PVE/API2/Nodes.pm
```
- If both are patched, it exits without changes.
- If both are clean, it downloads the current upstream installer and reapplies the saved choices.
- If only one file appears patched, it refuses to proceed to avoid compounding a partial modification.
## Build locally
On Debian or Proxmox VE:
```bash
sudo apt install dpkg-dev
./build.sh
```
The package is written to `dist/`.
## Publish a release
1. Update `Version:` in `package/DEBIAN/control`.
2. Commit and push.
3. Create and push a matching tag:
```bash
git tag v1.1.0
git push origin v1.1.0
```
GitHub Actions will build the package and attach it to a GitHub Release.
## Important limitations
This package modifies files owned by Proxmox packages. A major Proxmox UI or API change may require an update to the upstream Meliox installer. Always keep normal Proxmox backups and verify the GUI after significant upgrades.
## Licence
The automation package is MIT licensed. The downloaded Meliox installer remains subject to its own licence and copyright terms.