Wizard Setup Guide
This guide documents the Nutify Setup Wizard end-to-end using live screenshots. It is written for first-time users and operators who need consistent, repeatable setup outcomes.
The wizard initializes three things:
- access control (admin credentials)
- server identity and monitoring profile metadata
- NUT target configuration (single or multi target topology)
A correct wizard run should end with:
- successful save and restart
- setup mode closed
- login page shown
- dashboard showing expected target inventory
Prepare these items before opening the wizard:
- local UPS details (driver/port) if UPS is directly attached
- remote NUT details (host, port, ups identifier, username/password) if monitoring remote devices
- a naming plan:
- friendly display name for UI/reports
- technical UPS identifier for
upsc
- expected topology (single, remote-only multi, local-only multi, mixed multi)
The wizard has six steps:
- Admin Setup
- Server Identity
- Profile & Topology
- Configuration
- Review
- Complete
Create the initial Nutify login account.
What to do:
- choose secure admin username/password
- confirm password exactly
- proceed only after validation is green
Why it matters:
- this account controls all system-level operations
Set the global server name.
What this value is used for:
- server metadata in diagnostics
- references in logs and operational context
- identity context for reports and notifications
Choose monitoring profile and topology.
Profile meaning:
- Single Monitor: one UPS target
- Multi Monitor: multiple UPS targets with target switching
Topology meaning in multi profile:
- Remote NUT Only: all targets are remote
- Local Targets Only: all targets are physically connected to this server
- Mixed Local + Remote: local primary target plus remote additional targets
| Profile | Topology/Mode | Configuration Method(s) |
|---|---|---|
| Single Monitor | Standalone | Manual, Auto-detect |
| Single Monitor | Network Server | Manual, Auto-detect |
| Single Monitor | Network Client | Remote form |
| Multi Monitor | Remote NUT Only | Remote form |
| Multi Monitor | Local Targets Only + Standalone | Manual, Auto-detect |
| Multi Monitor | Local Targets Only + Network Server | Manual, Auto-detect |
| Multi Monitor | Mixed Local + Remote + Standalone | Manual, Auto-detect (primary local) |
| Multi Monitor | Mixed Local + Remote + Network Server | Manual, Auto-detect (primary local) |
You will see two identity fields in setup forms:
- Target Display Name (UI label)
- UPS Identifier (upsc key)
Use them this way:
- Display Name: friendly label shown in UI, reports, and lists.
- UPS Identifier: technical NUT UPS name used by
upsc(usuallyupsbefore@host).
Do not use the same mental meaning for both fields.
Method choice:
Manual:
Auto-detect:
Recommended:
- use auto-detect when USB UPS is found correctly
- use manual when scanner does not find device or driver tuning is needed
Manual:
Auto-detect:
Note:
- admin credentials in this mode refer to NUT server administration context (
upsd.users)
Remote client form:
Use when:
- UPS is hosted on another machine
- this Nutify instance should only consume remote data
Use when all targets are remote and no local USB/serial target is needed.
Topology options:
Standalone + Manual:
Standalone + Auto-detect:
Network Server + Manual:
Network Server + Auto-detect:
Topology options:
Standalone primary local + Manual:
Standalone primary local + Auto-detect:
Network Server primary local + Manual:
Network Server primary local + Auto-detect:
In multi workflows setup is staged:
- configure/test/save primary target first
- move to additional target form
- test/save each additional target one by one
Button behavior:
- Test & Save Primary Target: validates and stores primary target
- Continue with Next UPS: opens additional target configuration flow
- Test Target then Save Target: required for each additional target
Common target fields:
- Target Display Name: friendly UI label
-
UPS Identifier: NUT key used by
upsc - Target Timezone: rendering/report timezone for target analytics
- Target Currency: cost rendering context
- Polling Interval: target refresh cadence (seconds)
Remote connection fields:
- Remote Server: NUT host/IP
-
Remote Port: usually
3493 - Username / Password: remote monitor credentials
Local/manual fields:
- UPS Driver: NUT driver binding
-
Port: local port (
autofor USB in common setups) - Server Address: local server address context
When choosing auto-detect:
- scan and select one detected UPS device
- review selected device details
- confirm identity fields and polling/timezone/currency
- continue only after test/save passes
If no device appears:
- check USB permissions and host visibility
- confirm no other service is exclusively owning the device
- switch to manual configuration if needed
Review page:
After successful validation:
Review checklist:
- all required target tests passed
- topology matches physical/remote architecture
- naming is correct (
displayvsidentifier) - hosts/ports/credentials are verified
Before restart:
Countdown:
After restart:
After wizard completes:
- log in successfully
- verify target appears in topbar
- open
System -> Advanced -> NUT Manager - confirm target list is complete
- switch target in topbar (multi profile)
- verify Energy/Power/Battery pages show data for expected target
Mistake: wrong remote host/port.
- symptom: test target fails
- fix: verify NUT server reachability and
ups@host:portcorrectness
Mistake: display name and identifier confusion.
- symptom: wrong label or missing data routing
- fix: keep display name user-friendly, identifier NUT-compatible
Mistake: skipping target test.
- symptom: save blocked or inconsistent runtime behavior
- fix: always pass test before save
Mistake: wrong topology selected.
- symptom: fields feel inconsistent with real environment
- fix: go back to step 3 and choose actual topology
Wizard is complete when all are true:
- restart finishes successfully
- setup mode is closed
- login works
- expected target inventory is visible
- target-scoped pages follow topbar target correctly