-
Notifications
You must be signed in to change notification settings - Fork 28
System Settings Guide
This page documents the full System area in Nutify.
System view is for global administration and platform maintenance.
It is different from target-scoped settings (Notify, Reporter, PowerFlow).
Two scopes coexist in Nutify:
- System scope: global app/server behavior (this guide)
- Target scope: per-UPS behavior (TopBar-selected target)
If you apply a system change, it affects the whole instance. If you apply a target change, it affects the currently active UPS target.
From left sidebar, click System.

System tabs:
- Provider
- Advanced
- Admin
- Database
- Log
- Remapper
- Operations
- About
Recommended mental grouping:
- channel/admin maintenance: Provider, Admin
- runtime/NUT lifecycle: Advanced, Remapper, Operations
- observability/health: Log, Database
- reference: About
Provider is global.
You configure channels once, then attach them in target-scoped Notify or Reporter.

Use for:
- SMTP server identity and auth
- sender/delivery configuration
Typical operations:
- add mailbox config
- edit credentials
- enable/disable profile
- set default profile
- test delivery path

Use for:
- ntfy endpoint and topic management
Typical operations:
- add endpoint config
- validate endpoint with test message
- set default profile

Use for:
- bot token + destination chat profile management
Typical operations:
- add bot profile
- run test send
- set default profile

Use for:
- outbound integrations (automation, chatops, incident tools)
Typical operations:
- add endpoint and payload mode
- test callback delivery
- set default profile
Provider best practice:
- keep provider list clean and named clearly
- disable stale entries instead of keeping ambiguous duplicates
Advanced contains:
- Configuration
- NUT Manager
- System Diagnostics
- Clock

Purpose:
- low-level editing of NUT configuration files
Typical files:
ups.confnut.confupsmon.confupsd.usersupsd.conf
What you can do:
- open file editor
- apply precise changes
- save
- save and restart NUT services
Safe sequence:
- backup current known-good config
- change one section at a time
- save and revalidate target connectivity
- restart only after syntax sanity checks

Purpose:
- lifecycle management of UPS targets
What you can do:
- add or edit targets
- enable/disable targets
- mark default/primary target
- poll target now
- generate helper scripts
- remove removable targets
Use this tab for fleet inventory and target operations.

Purpose:
- diagnostics and metadata checks
What you can do:
- inspect/download raw UPS payload
- verify current server name
- inspect profile metadata context
Use case examples:
- troubleshooting mapping issues
- validating server identity and setup metadata

Purpose:
- topbar clock display preference
Available behavior:
- choose 24H or AM/PM format
Note:
- this is a UI preference behavior

Purpose:
- account and user administration
What you can do:
- view users/roles
- add user
- update user credentials (admin operation)
- update current account data
Best practices:
- keep at least one tested admin account
- avoid shared credentials between operators
- rotate passwords periodically

Purpose:
- inspect and maintain DB health
What you can do:
- view DB size and metadata
- run optimize/vacuum operations
- download backup
- inspect table stats
When to use:
- regular maintenance window
- pre-upgrade safety checks
- post-incident integrity checks

Purpose:
- runtime observability and log controls
What you can do:
- enable/disable logging areas
- set verbosity level
- include/exclude Werkzeug/JS logs
- filter/search/paginate
- download or clear logs intentionally
Operational advice:
- increase verbosity only while diagnosing
- capture logs before cleanup
- return to standard verbosity after incident

Purpose:
- map canonical Nutify variables to vendor/device-specific UPS keys
What you can do:
- inspect mapping rows
- refresh suggestions
- auto-fill suggestions
- edit and persist mappings
Why it matters:
- keeps dashboards and formulas consistent across heterogeneous UPS payloads

Purpose:
- configure runtime formulas and variable sources
Scope:
- target-scoped; uses active target from TopBar
What you can do:
- select source fields for computed metrics
- tune formula behavior
- switch guided/manual formula modes
- calibrate factors
- save/reset operations config
Use carefully:
- wrong formulas can create misleading analytics and costs

Purpose:
- project metadata and reference links
Use it to:
- confirm build/version context
- check release notes and project references
Weekly:
- review warnings/errors in Log
- verify target health in NUT Manager
- sanity-check Event growth and system behavior
Monthly:
- create DB backup export
- run DB optimize/vacuum as needed
- review provider catalog and clean stale entries
- review Operations formulas on critical targets
After infrastructure changes:
- revalidate NUT connectivity in NUT Manager
- check Remapper for new vendor key suggestions
- confirm notifications still route correctly
Mistake: editing raw NUT files without backup.
- prevention: backup first, one change at a time
Mistake: confusing Provider (global) with Notify/Reporter attachments (target).
- prevention: configure channel globally in Provider, attach per target in target view
Mistake: editing Operations while wrong target is active.
- prevention: verify TopBar target before save
Mistake: deleting logs before exporting evidence.
- prevention: download logs first, clean later
- confirm server identity and profile metadata
- confirm provider catalog integrity
- verify target list in NUT Manager
- verify log level and capture strategy
- verify DB backup path and download test
- verify topbar target switching reflects expected inventory