# PeaNUT

PeaNUT is a web-based, tiny dashboard application for monitoring Uninterruptible Power Supplies (UPS). It is open source and self-hosted, installable on Docker Hub, Proxmox, TrueNAS, ZimaOS and Unraid.

Canonical page: https://ourlocalhost.com/app/628/peanut

## Description

PeaNUT is a web-based, tiny dashboard application for monitoring Uninterruptible Power Supplies (UPS). It provides a user-friendly interface for real-time status, battery life, and power outage notifications to ensure system protection. It supports various UPS models, offers mobile-friendly access, and deploys via Docker.

## Platform availability

Available on 4 of 9 platforms: Unraid, TrueNAS, ZimaOS, Proxmox.

## Health score

81/100 (Excellent), based on 3 of 4 factors.
- Maintained: 98 (last commit 24 days ago)
- Popular: 65 (1,690 GitHub stars)
- Easy to install: 65 (4 install platforms, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/r/brandawg93/peanut
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=peanut
- TrueNAS: https://apps.truenas.com/catalog/peanut/
- ZimaOS: https://github.com/IceWhaleTech/CasaOS-AppStore/tree/main/Apps/Peanut
- Unraid: https://ca.unraid.net/apps/peanut-1fmxzjj06u9gtn?q=PeaNUT
- GitHub: https://github.com/Brandawg93/PeaNUT

## Common questions

### Can PeaNUT run behind a reverse proxy on a subpath?

Yes. Set the BASE_PATH environment variable to the path that the reverse proxy forwards to PeaNUT.

### Why would PeaNUT settings made in the web UI not persist after a restart?

The container runs as UID/GID 1000:1000, so the host directory mounted at /config must be writable by that user. You can fix EACCES errors by chowning the config directory to 1000:1000 or setting the container user to match the host directory owner, and PUID/PGID environment variables are not supported.

### How is the first PeaNUT user created?

Set WEB_USERNAME and WEB_PASSWORD before the first start, and they are used for auto-creation. You can also set AUTH_DISABLED=true to disable authentication.

### Can PeaNUT monitor more than one NUT server?

Yes, update 2 added multi-server support.

### Can PeaNUT export UPS metrics to InfluxDB or Prometheus?

Yes, it supports InfluxDB v2 integration for monitoring via Grafana and Prometheus support for monitoring and alerting.

---
Source: Our Local Host (https://ourlocalhost.com/app/628/peanut), the self-hosted and open-source app directory.
