Home

Nutify Wiki

Welcome to the Nutify documentation wiki.

This wiki is designed for beginners first. If you are new to NUT, UPS monitoring, or Nutify, start here and follow the recommended reading order.

What Nutify Is

Nutify is a UPS monitoring platform built on top of NUT (Network UPS Tools).

It helps you:

• monitor one UPS (single profile) or multiple UPS targets (multi profile)
• read real-time status and historical trends
• manage notifications and report delivery
• tune formulas and business metrics for power/energy analysis
• manage NUT and target inventory from a guided UI

Who This Wiki Is For

• first-time users installing Nutify
• home lab users running one or more UPS devices
• operators who maintain alerts, reports, and target health
• contributors who need a clear mental model of runtime behavior

Read This Once: Core Concepts

These definitions remove 90% of confusion in daily use.

• Server: the Nutify instance you are using.
• Target: one UPS endpoint, local or remote.
• Active target: the UPS currently selected in the TopBar selector.
• Provider: global notification/report channel config (Mail, Ntfy, Telegram, Webhook).
• Notify / Reporter / PowerFlow: target-scoped settings bound to the active target.
• System view: global administration area for platform-level settings.
• Target view: UPS-specific settings area.

How the Product Is Organized

Nutify has two working dimensions:

1. Operational pages for daily monitoring and control (left sidebar).
2. Configuration pages for setup, target lifecycle, notifications, reports, and formulas.

The most important rule:

• always confirm the active target in TopBar before reading data or saving settings

Suggested Reading Order

1. Installation Complete Guide
2. Docker Compose Guide
3. Wizard Setup Guide
4. Main + Topbar + Multi-UPS Guide
5. Multi-UPS Monitoring Guide
6. Sidebar Data Pages Guide
7. Reports and Notifications End-to-End Guide
8. System Settings Complete Guide
9. Troubleshooting Guide (By Symptom)
10. API Quick Reference

Beginner Learning Paths

Path A: First Installation (Single UPS)

1. Read Docker Compose guide.
2. Start stack.
3. Complete wizard using a single profile.
4. Verify login, dashboard, and one healthy target.

Path B: Multi-UPS Operations

1. Read wizard multi scenarios.
2. Read topbar active-target workflow.
3. Read sidebar monitoring pages.
4. Read system guide for NUT Manager and providers.

Path C: Administration and Maintenance

1. Read system guide deeply.
2. Focus on Provider, NUT Manager, Database, Log, and Operations.
3. Build a monthly maintenance routine and backup discipline.

Practical “First 15 Minutes” Checklist

If you are completely new, do this in order:

1. Confirm container is running and web UI opens.
2. Complete wizard to exit setup mode.
3. Log in with admin account.
4. Confirm one target is visible in TopBar.
5. Open Energy, Power, Battery, Voltage once each.
6. Open System -> Advanced -> NUT Manager and verify target inventory.

Common Beginner Mistakes

• changing settings on the wrong target because TopBar selection was not checked
• confusing Target Display Name with UPS Identifier
• treating Provider as target-scoped instead of global
• skipping target test before save in wizard flows
• editing low-level NUT configuration without a backup

Quick Links

• Installation Complete Guide
• Wizard Setup Guide
• Main + Topbar + Multi-UPS Guide
• Multi-UPS Monitoring Guide
• Sidebar Data Pages Guide
• Reports and Notifications End-to-End Guide
• System Settings Complete Guide
• Troubleshooting Guide (By Symptom)
• API Quick Reference
• Docker Compose Guide