![Nutify]()
Nutify
Stack
Nutify is a comprehensive monitoring system designed to track the health and performance of your Uninterruptible Power Supply (UPS) devices.
Image details
Configuration
TypeComposelinuxdartsteven/nutify:amd64-0.1.03493:34935050:5050/var/run/nut : /portainer/Files/AppData/Config/nutify/nut_data/app/nutify/logs : /portainer/Files/AppData/Config/nutify/logs/logs/app/nutify/instance : /portainer/Files/AppData/Config/nutify/instanceSERVER_NAME=SERVER_PORT=5050SERVER_HOST=0.0.0.0TIMEZONE=ENCRYPTION_KEY=UPS_HOST=UPS_NAME=upsUPS_DRIVER=usbhid-upsUPS_PORT=autoUPS_REALPOWER_NOMINAL=1000UPS_USER=adminUPS_PASSWORD=hunter2UPSCMD_USER=adminUPSCMD_PASSWORD=hunter2LOG=falseLOG_LEVEL=DEBUGLOG_WERKZEUG=falseENABLE_LOG_STARTUP=NalwaysStandalone Install
Select an install method, to see config/commands for deploying Nutify
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Nutify, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
Original stackfile
The compose file this template deploys, straight from its repo:
services:
nut:
image: dartsteven/nutify:amd64-0.1.0 # Official Nutify image for AMD64 architecture (supported architectures: amd64, arm64, armv7)
# build: . # Or build from source # Uncomment to build from source instead of using pre-built image
container_name: Nutify-Server # Name of the container in Docker
privileged: true # Grants extended privileges to the container for hardware access
cap_add: # Additional Linux capabilities for the container
- SYS_ADMIN # Allows administrative operations
- SYS_RAWIO # Allows direct I/O access
- MKNOD # Allows creation of special files
devices: # Device mapping from host to container
- /dev/bus/usb:/dev/bus/usb:rwm # Maps USB devices for UPS detection (read-write-mknod)
device_cgroup_rules: # Control group rules for device access
- 'c 189:* rwm' # USB device access rule (character device 189)
environment: # Environment variables for container configuration
# ===== SERVER CONFIGURATION =====
- SERVER_NAME= # Name of the server (displayed in UI)
- SERVER_PORT=5050 # Port for web interface
- SERVER_HOST=0.0.0.0 # Host address to bind web server (0.0.0.0 = all interfaces)
- TIMEZONE= # Timezone for date/time display (e.g., Europe/Rome)
- ENCRYPTION_KEY= # Secret key for data encryption (MUST be set)
# ===== UPS CONNECTION SETTINGS =====
- UPS_HOST= # IP/hostname of UPS (leave empty for local USB connection)
- UPS_NAME=ups # Name of the UPS in NUT configuration
- UPS_DRIVER=usbhid-ups # NUT driver for UPS (usbhid-ups for USB connected UPS)
- UPS_PORT=auto # Port for UPS connection (auto = automatic detection)
- UPS_REALPOWER_NOMINAL=1000 # Nominal power of UPS in watts
# ===== UPS AUTHENTICATION =====
- UPS_USER=admin # Username for UPS authentication
- UPS_PASSWORD=hunter2 # Password for UPS authentication
# ===== UPS COMMAND SETTINGS =====
- UPSCMD_USER=admin # Username for sending commands to UPS
- UPSCMD_PASSWORD=hunter2 # Password for sending commands to UPS
# ===== LOGGING CONFIGURATION =====
- LOG=false # Enable/disable logging (true/false)
- LOG_LEVEL=DEBUG # Log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
- LOG_WERKZEUG=false # Enable/disable Flask's Werkzeug logs
- ENABLE_LOG_STARTUP=N # Set to Y to enable essential startup logs
ports: # Port mapping from host to container
- 3493:3493 # NUT server port
- 5050:5050 # Web interface port
volumes: # Volume mapping for persistent data
- /portainer/Files/AppData/Config/nutify/nut_data:/var/run/nut # NUT runtime data
- /portainer/Files/AppData/Config/nutify/logs/logs:/app/nutify/logs # Log files
- /portainer/Files/AppData/Config/nutify/instance:/app/nutify/instance # Application data including SQLite database
restart: always # Restart policy (always restart on failure)
user: root # Run container as root user for hardware access
Or deploy it directly from the source:
git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/nutify.yml up -dMore install options in our documentation, or see dartsteven/nutify for app-specific guidance.
Features:
• Dockerized implementation of Network UPS Tools (NUT).
• Real-time UPS monitoring and event detection.
• Email alerts for UPS status changes, power failures, and recoveries.
• Configurable SMTP settings to suit your preferred email provider.
• Easy deployment and integration with Docker environments.
• Minimal resource usage, optimized for lightweight operations.Serve Nutify on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.
Proxying nutify.example.com to http://nut:3493
Add this to your Caddyfile
nutify.example.com {
reverse_proxy http://nut:3493
}Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs <container> - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:3493 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :3493 - Stop the other service, or pick a different host port. In
3493:3493only the left number is yours to change, the right one belongs to the app.
Running but the page won't load
The container is up but nothing appears in your browser.
- Use your server's real IP:
http://your-server-ip:3493. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, nut can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 3493
Permission denied on volumes
If the logs show "permission denied", the app can't write to its data folder on the host.
- Fix the ownership:
sudo chown -R 1000:1000 /portainer/Files/AppData/Config/nutify/nut_data(and the same for the other mapped folders)
Image won't pull
Test the pull directly on the host: docker pull dartsteven/nutify:amd64-0.1.0
- "manifest unknown" means the tag no longer exists.
- "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- This image supports:
amd64, arm64, arm/v7 - Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The always restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect <container> --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Required settings are blank
SERVER_NAME, TIMEZONE, ENCRYPTION_KEY, UPS_HOST have no default value, and nut may crash or misbehave if left empty.
- Fill them in on the deploy screen before hitting deploy.
Stack won't deploy
Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.
- YAML only accepts spaces for indentation, a single tab breaks the whole file.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue on dartsteven/nutify
- Template not working: Open an issue on xneo1/portainer_templates
- This website not working: Open an issue on lissy93/portainer-templates
A Compose stack
Nutify is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.
The app image
An image is the app packed up ready to go, everything Nutify needs bundled into one download. This template pulls dartsteven/nutify:amd64-0.1.0, which Docker fetches once (about 288 MB) and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. Nutify's comes from Docker Hub, published by dartsteven.
Version tags
The bit after the colon in the image name is the version tag. This one pins amd64-0.1.0, so every redeploy gives you that exact build until you bump it yourself.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.
Ports
A port is the door the app answers on. A mapping like 3493:3493 means it's reachable on port 3493 of your server, where the left number is yours to change and the right one belongs to the app. It opens:
3493:34935050:5050
Volumes
A volume is where Nutify keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:
/var/run/nutfrom/portainer/Files/AppData/Config/nutify/nut_dataon the host/app/nutify/logsfrom/portainer/Files/AppData/Config/nutify/logs/logson the host/app/nutify/instancefrom/portainer/Files/AppData/Config/nutify/instanceon the host
Environment variables
Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Nutify takes 18 of them, and 4 need a value before it'll start properly:
SERVER_NAME, needs a valueSERVER_PORT, defaults to5050SERVER_HOST, defaults to0.0.0.0TIMEZONE, needs a valueENCRYPTION_KEY, needs a valueUPS_HOST, needs a valueUPS_NAME, defaults toupsUPS_DRIVER, defaults tousbhid-upsUPS_PORT, defaults toautoUPS_REALPOWER_NOMINAL, defaults to1000UPS_USER, defaults toadminUPS_PASSWORD, defaults tohunter2UPSCMD_USER, defaults toadminUPSCMD_PASSWORD, defaults tohunter2LOG, defaults tofalseLOG_LEVEL, defaults toDEBUGLOG_WERKZEUG, defaults tofalseENABLE_LOG_STARTUP, defaults toN
Restart policy
The restart policy here is always, so Docker brings Nutify back up after a crash and again when the server reboots. Good for anything you want running around the clock. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Devices
Devices pass a piece of the host's hardware straight through to the container, like a graphics chip for transcoding or a USB adapter. This one gets:
/dev/bus/usb:/dev/bus/usb:rwm
Networking
Nothing custom is set, so Nutify sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.
Container name
Once it's deployed, Portainer names the container nut. That's what you'll spot in the containers list and use in commands like docker logs nut.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Nutify up. Add the template list to Portainer once, then deploying Nutify is a click rather than a wall of config.