NUT Web GUI

Lightweight web interface for Network UPS Tools.

Quickstart

Docker/Podman:

docker run -p 9000:9000 \
  -e UPSD_ADDR=10.0.0.1 \
  -e UPSD_USER=test \
  -e UPSD_PASS=strongpass \
  ghcr.io/superioone/nut_webgui:latest

Container image registries:

• Codeberg: codeberg.org/superiorone
• GitHub: ghcr.io/superioone

Features

• Monitors UPS variables with auto-refresh.
• Supports INSTCMD, SET VAR, and FSD calls from the GUI.
• Potato PC friendly. Small footprint in both resource usage and disk size.
• Basic JSON API.
• Supports RISC-V and older ARM devices.

Documentation

For HTML version, see https://nwg.smdd.dev

• Introduction
• Binary installation
• Container images
  • Docker/Podman
  • Compose files
  • Kubernetes: Basic
  • Kubernetes: Endpoint slices
• Configuration
  • CLI args
  • Environment variables
  • config.toml
• Connecting multiple NUT servers
• Authentication
• Path-based routing with reverse proxy
• Enabling TLS on NUT connection
• Accessing host's localhost in container
• UniFi NUT
• Building from source
• Debugging
• Data API specification
• WebSocket EventsAPI
• OpenMetrics
• Probes

Config Templates

• Config.toml file template
• Users.toml file template