Skip to content

Rewrite the Notifications documentation - #208

Draft
DexterIA wants to merge 2 commits into
cloudlinux:masterfrom
DexterIA:DEF-32258-notifications-docs
Draft

Rewrite the Notifications documentation#208
DexterIA wants to merge 2 commits into
cloudlinux:masterfrom
DexterIA:DEF-32258-notifications-docs

Conversation

@DexterIA

@DexterIA DexterIA commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Explain the three notification channels (event notifications, panel notifications, admin contacts), where each one is configured, and the behaviour the current pages left out:

  • features: full rewrite of "Notifications" — event/target matrix per product, scan type → event family mapping, how cleanup and restore-from-backup affect the malware-found event, delivery mechanics of imunify-notifier, troubleshooting table
  • panel_notifications: the seven message types with cooldown and scope, the "Panel email notifications" dialog (DEF-38751), DASHBOARD.notifications keys, Plesk hook caveats, verification steps
  • dashboard: "Notifications" section under Settings so the tab shows up in the sidebar; complete the tab list
  • imunifyav: move "Notifications" out of the deprecated Hooks section, describe the two channels and the six script-only events
  • CLI (both products): hooks.yaml location and default-off state, period is in seconds (was documented as minutes), admin.locale, default keyword rules, email regex, _imunify permissions
  • config_file_description (both products): add the DASHBOARD section
  • new screenshots from cPanel and Plesk test servers, all at one scale

@DexterIA DexterIA changed the title DEF-32258: rewrite the Notifications documentation Rewrite the Notifications documentation Sep 8, 2026
abushkov-cl and others added 2 commits September 8, 2026 18:59
Explain the three notification channels (event notifications, panel
notifications, admin contacts), where each one is configured, and the
behaviour the current pages left out:

- features: full rewrite of "Notifications" — event/target matrix per
  product, scan type → event family mapping, how cleanup and
  restore-from-backup affect the malware-found event, delivery
  mechanics of imunify-notifier, troubleshooting table
- panel_notifications: the seven message types with cooldown and scope,
  the "Panel email notifications" dialog (DEF-38751),
  DASHBOARD.notifications keys, Plesk hook caveats, verification steps
- dashboard: "Notifications" section under Settings so the tab shows up
  in the sidebar; complete the tab list
- imunifyav: move "Notifications" out of the deprecated Hooks section,
  describe the two channels and the six script-only events
- CLI (both products): hooks.yaml location and default-off state,
  `period` is in seconds (was documented as minutes), admin.locale,
  `default` keyword rules, email regex, _imunify permissions
- config_file_description (both products): add the DASHBOARD section
- new screenshots from cPanel and Plesk test servers, all at one scale

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
- event notifications are off by default except the malware hook the
  agent enables on Plesk; say so wherever the default was stated
- aggregated events: the notifier collects only events older than five
  minutes before the cron interval applies
- per-event script payload table instead of one generic field list
- panel notifications: the seven switches are the configurable subset,
  not the whole set; scan_not_scheduled also needs 30 days without a
  scan; drop the internal cloud query and flag-file recipe; drop the
  48-hour figure
- Plesk: an invalid customer email is reported in /var/log/plesk/panel.log;
  console.log lines record hand-over to the panel, not delivery
- minimum versions for the dialog (ui-8.13.1) and its keys (av-8.8.2)
- "four events" -> six; remove editorialising

Type descriptions and product scope of the individual message types are
left for after DEF-54860.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@DexterIA
DexterIA force-pushed the DEF-32258-notifications-docs branch from 7d8b029 to ccc3229 Compare September 8, 2026 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants