Wizard Setup Guide

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.

1) Goal of the Wizard

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

2) Before You Start

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)

3) Wizard Step Overview

The wizard has six steps:

1. Admin Setup
2. Server Identity
3. Profile & Topology
4. Configuration
5. Review
6. Complete

4) Step 1 - Admin Setup

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

5) Step 2 - Server Identity

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

6) Step 3 - Profile and Topology

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

7) Decision Matrix (Choose the Right Scenario)

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)

8) Critical Naming Rule (Read Carefully)

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 (usually ups before @host).

Do not use the same mental meaning for both fields.

9) Step 4 - Configuration by Scenario

9.1 Single Monitor + Standalone

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

9.2 Single Monitor + Network Server

Manual:

Auto-detect:

Note:

• admin credentials in this mode refer to NUT server administration context (upsd.users)

9.3 Single Monitor + Network Client

Remote client form:

Use when:

• UPS is hosted on another machine
• this Nutify instance should only consume remote data

9.4 Multi Monitor Topology Selector

9.5 Multi + Remote NUT Only

Use when all targets are remote and no local USB/serial target is needed.

9.6 Multi + Local Targets Only

Topology options:

Standalone + Manual:

Standalone + Auto-detect:

Network Server + Manual:

Network Server + Auto-detect:

9.7 Multi + Mixed Local + Remote

Topology options:

Standalone primary local + Manual:

Standalone primary local + Auto-detect:

Network Server primary local + Manual:

Network Server primary local + Auto-detect:

10) Primary-Then-Additional Flow (Multi Scenarios)

In multi workflows setup is staged:

1. configure/test/save primary target first
2. move to additional target form
3. 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

11) Field-Level Reference (What Each Field Means)

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/Device: auto for USB or a local device path for serial drivers
• UPS Host/IP: replaces Port/Device when a network driver is selected; enter the UPS network management hostname/IP and never auto
• Local NUT Server Address: address of Nutify's local NUT service, normally 127.0.0.1; this is not the SNMP UPS address

SNMP fields when snmp-ups is selected:

• SNMPv1/v2c: community
• SNMPv3: security level and security name
• authNoPriv: authentication protocol and password
• authPriv: authentication plus privacy protocol and password

Only fields required by the selected SNMP version/security level are rendered into ups.conf. The UPS Host/IP is rendered as port because this is how NUT network drivers define their endpoint. Do not enter placeholder credentials for an unused mode.

12) Auto-Detect Behavior (How to Use It Correctly)

When choosing auto-detect:

1. scan and select one detected UPS device
2. review selected device details
3. confirm identity fields and polling/timezone/currency
4. continue only after test/save passes

If no device appears:

• check host visibility and the scoped device/host-NUT deployment described in the Docker Compose guide
• confirm no other service is exclusively owning the device
• switch to manual configuration if needed

13) Step 5 - Review and Validation

Review page:

After successful validation:

Review checklist:

• all required target tests passed
• topology matches physical/remote architecture
• naming is correct (display vs identifier)
• hosts/ports/credentials are verified

The final test validates the complete configuration, not only the form fields. Nutify temporarily starts configured local drivers, queries remote targets, and waits for every target to report a usable ups.status. Startup states such as WAIT or NOCOMM are retried and are never accepted as success. If a ready UPS does not expose ups.realpower.nominal, the Wizard asks for its rated Watts; the prompt is not shown while the driver is still initializing.

14) Step 6 - Complete and Restart

Before restart:

Countdown:

After restart:

15) Post-Restart Validation (Do Not Skip)

After wizard completes:

1. log in successfully
2. verify target appears in topbar
3. open System -> Advanced -> NUT Manager
4. confirm target list is complete
5. switch target in topbar (multi profile)
6. verify Energy/Power/Battery pages show data for expected target

16) Common Mistakes and Recovery

Mistake: wrong remote host/port.

• symptom: test target fails
• fix: verify NUT server reachability and ups@host:port correctness

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

17) Final Success Checklist

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