System Settings Guide

System Settings Complete 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).

1) System vs Target Scope (Read First)

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.

2) How to Open System

From left sidebar, click System.

3) Tabs Overview

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

4) Provider Tab (Global Notification Catalog)

Provider is global. You configure channels once, then attach them in target-scoped Notify or Reporter.

Provider -> Mail

Use for:

• SMTP server identity and auth
• sender/delivery configuration

Auth-less relays are supported: leave both Username and Password blank. Nutify uses auth off, and From Email remains independent from Username. Supplying only one credential is rejected. No-auth configs remain selectable in Notify and Reporter using recipient, sender, or SMTP server as their display label.

Typical operations:

• add mailbox config
• edit credentials
• enable/disable profile
• set default profile

Event routing does not live in the webhook provider record. Select the provider and enable the channel for each event in target-scoped Notify/Event Matrix. Saved API responses mask passwords and Bearer tokens; tests and runtime dispatch use the encrypted secret internally.

• test delivery path

Provider -> Ntfy

Use for:

• ntfy endpoint and topic management

Typical operations:

• add endpoint config
• validate endpoint with test message
• set default profile

Provider -> Telegram

Use for:

• bot token + destination chat profile management

Typical operations:

• add bot profile
• run test send
• set default profile

Provider -> Webhook

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

5) Advanced Tab

Advanced contains:

• Configuration
• NUT Manager
• System Diagnostics
• Clock

5.1 Advanced -> Configuration

Purpose:

• low-level editing of NUT configuration files

Typical files:

• ups.conf
• nut.conf
• upsmon.conf
• upsd.users
• upsd.conf

What you can do:

• open file editor
• apply precise changes
• save
• save and restart NUT services

Safe sequence:

1. backup current known-good config
2. change one section at a time
3. save and revalidate target connectivity
4. restart only after syntax sanity checks

5.2 Advanced -> NUT Manager

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

Editing polling, timezone, currency, retention, display metadata, location, or enablement does not require a new connection test. A test is required for new targets and when UPS identifier, host, port, or NUT mode changes.

For snmp-ups, NUT Manager/setup supports SNMPv1/v2c community auth and all SNMPv3 security levels: noAuthNoPriv, authNoPriv, and authPriv.

Use this tab for fleet inventory and target operations.

5.3 Advanced -> System Diagnostics

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

5.4 Advanced -> Clock

Purpose:

• topbar clock display preference

Available behavior:

• choose 24H or AM/PM format

Note:

• this is a UI preference behavior

6) Admin Tab

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

If the administrator password is lost, use Forgot Password on the login screen. Recovery requires the administrator username, a new password, and the same runtime SECRET_KEY stored in .env. Attempts are rate-limited and only administrator accounts can be recovered.

The administrator-only Authentication tab configures UI-managed OpenID Connect through Save, Discover, Browser Test, and Enable stages. Environment- managed deployments display masked read-only state. OIDC-only accounts show oidc as authentication source. Their local password and role cannot be edited: provider groups control role at each login, while an administrator can still disable or delete the account. Keep one tested local administrator. See OpenID Connect SSO Guide and OIDC Guided Setup.

7) Database Tab

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

8) Log Tab

Purpose:

• runtime observability and log controls

What you can do:

• enable/disable logging areas
• set verbosity level
• include/exclude HTTP Access Logs and 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

9) Remapper Tab

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
• rejects automatic mappings with incompatible metric dimensions, such as a runtime threshold being mapped as a battery charge threshold

10) Operations Tab

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

11) About Tab

Purpose:

• project metadata and reference links

Use it to:

• confirm build/version context
• check release notes and project references

12) Weekly / Monthly Maintenance Routine

Weekly:

1. review warnings/errors in Log
2. verify target health in NUT Manager
3. sanity-check Event growth and system behavior

Monthly:

1. create DB backup export
2. run DB optimize/vacuum as needed
3. review provider catalog and clean stale entries
4. review Operations formulas on critical targets

After infrastructure changes:

1. revalidate NUT connectivity in NUT Manager
2. check Remapper for new vendor key suggestions
3. confirm notifications still route correctly

13) Common Mistakes and Prevention

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

14) New Admin First-Day Checklist

1. confirm server identity and profile metadata
2. confirm provider catalog integrity
3. verify target list in NUT Manager
4. verify log level and capture strategy
5. verify DB backup path and download test
6. verify topbar target switching reflects expected inventory