mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2026-04-04 09:11:34 -07:00
The key 'ordeable' in elementOptions was a long-standing typo for the correct English word 'orderable'. Since the JS check in settings_utils.js used the same misspelled key, the feature appeared to work — but it was relying on the consistent propagation of a typo across the entire codebase. Two pre-existing entries in front/plugins/ui_settings/config.json already used the correct spelling 'orderable', but these had no effect because the JavaScript check (option.ordeable === 'true') never matched them. As a result, orderable behavior was silently disabled for those two settings. Changes: - front/js/settings_utils.js: renamed option.ordeable → option.orderable and isOrdeable → isOrderable (6 occurrences, lines 792/823/824/880/1079/ 1192/1228). The JS key check is the authoritative definition of the elementOptions property name, so this must change atomically with all config files. - server/initialise.py:245: renamed "ordeable" → "orderable" in the hardcoded JSON string for LOADED_PLUGINS setting. This string is the source-of-truth for that setting's elementOptions and is not auto- generated from the plugin config files. - front/plugins/*/config.json (33 files, 90 occurrences): renamed all "ordeable": "true" entries to "orderable": "true" via sed. All plugins used the typo consistently; they must be updated in the same commit to avoid a broken intermediate state. The two formerly broken 'orderable' entries in ui_settings/config.json are now matched by the corrected JS check and work as intended. Fixes netalertx/NetAlertX#1584 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Notifications User Guide
Overview
This guide explains how the notification system works, including its dependencies, available notification types, and device-specific overrides.
Notification Dependencies
The notification system relies on event data from devices and plugins. For notifications to function correctly:
- Devices must have alerts enabled in their settings.
- The notification processor uses the
NTFPRCS_INCLUDED_SECTIONSsetting to determine which types of notifications to send. - Device-specific settings can override global notification rules.
Notification Types
The following notification types are available based on the NTFPRCS_INCLUDED_SECTIONS setting:
new_devices
- Notifies when a new device is detected on the network.
- Only sent if
new_devicesis enabled inNTFPRCS_INCLUDED_SECTIONS.
down_devices
- Notifies when a device goes offline.
- The device must have Alert Down enabled in its settings.
- The notification is only sent if the device has not reconnected within the configured time window of
NTFPRCS_alert_down_time.
down_reconnected
- Notifies when a device that was previously reported as down reconnects.
- The device must have Alert Down enabled.
events
- Notifies about specific events triggered by a device.
- The device must have Alert Events enabled in its settings.
- Includes events:
Connected,Down Reconnected,Disconnected,IP Changed
- you can exclude devices with a custom where condition via the
NTFPRCS_event_conditionsetting
plugins
- Notifies when an event is triggered by a plugin.
- These notifications depend on the plugin's configuration of the
watchedValue1-4values and the<plugin>_REPORT_ONsettings.
Device-Specific Overrides
Certain notifications can be disabled per device:
Alert Events Disabled
- If a device has Alert Events disabled, it will not receive notifications for general events (
eventssection). - This does not affect notifications for
down_devices,down_reconnected, ornew_devices.
Alert Down Disabled
- If a device has Alert Down disabled, it will not receive notifications when it goes offline (
down_devices) or reconnects (down_reconnected).
Usage
- Review the Settings page to configure which notification types should be enabled.
- Ensure that device-specific alert settings align with your requirements.
For additional details, check the Notifications Guide.