5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-08-24 17:49:24 +03:00

23 Commits

Author SHA1 Message Date
2b0173ef55 notifications: adapt to latest notification system UI changes
The latest updates to the backup-job UI completely drop the term
"Notification System" from the UI, instead we now use "Global
notification settings", which should be hopefully a bit clearer to users
with regards to what this actually means.

Furthermore, the 'auto' notification mode is not exposed anymore in the
UI, hence we also drop it from the documentation to avoid confusion. It
is still listed in the backup job option reference section, for any user
who might still be using it.

Some of the touched sections were slightly rephrased to improve clarity.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Reviewed-by: Michael Köppl <m.koeppl@proxmox.com>
Link: https://lore.proxmox.com/20250725082046.51199-1-l.wagner@proxmox.com
2025-07-25 12:00:57 +02:00
fbb84a2b4c notifications: reflow to 80 cc text-width and indent points in lists
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2025-04-09 10:09:21 +02:00
56f3d84b75 notifications: add section about how to use custom templates
This section is meant to give a basic overview on how to use
custom templates for notifications. It will be expanded in the
future, providing a more detailed view on how templates are resolved,
existing fallback mechanisms, available templates, template
variables and helpers.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Reviewed-by: Alexander Zeidler <a.zeidler@proxmox.com>
Link: https://lore.proxmox.com/20250409074713.55474-1-l.wagner@proxmox.com
2025-04-09 10:02:36 +02:00
90e74e8557 notification: source style fixes
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-11-11 22:30:44 +01:00
daf06000ff notification: add documentation for webhook target endpoints.
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
 [ TL: reflow some content and fix trailing whitespace ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-11-11 22:28:02 +01:00
6942acb508 fix some typos
found with:

    typos *.adoc

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
2024-10-14 10:21:29 +02:00
fe4a583789 notifications: add note regarding when 'job-id' is set for backups
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Reviewed-by: Max Carrara <m.carrara@proxmox.com>
2024-09-23 17:09:15 +02:00
4931726c4e notifications: match-field 'exact'-mode can now match multiple values
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Reviewed-by: Max Carrara <m.carrara@proxmox.com>
2024-09-23 17:09:15 +02:00
3b55c73fc2 notifications: describe new notification metadata fields
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Reviewed-by: Max Carrara <m.carrara@proxmox.com>
2024-09-23 17:09:15 +02:00
456b17fa59 docs: fix typos
Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
2024-09-06 20:26:17 +02:00
413219c01a notifications: backport some rephrased parts from PBS docs
Most of the changes were done when adapting the PVE docs to
the new PBS notification system, so now we 'backport' those
improvements.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2024-07-04 15:11:27 +02:00
054583a418 notifications: fix typo in 'notification'
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
[FG: adapted context for partial application]
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-07-04 15:10:57 +02:00
23c057837a notification: clarify that 'hostname' does not include the domain
This was a bit inconsistent between the different notification types:
  - APT/VZDump included the domain part
  - fence notifications did not

A decision has been made to unify this by removing the domain part
from APT/VZDump notifications.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2024-07-04 14:00:15 +02:00
4a6bd57a54 notifications: fix typos and improve reading flow
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2024-01-10 15:54:17 +01:00
617fd56e45 notifications: add screenshots for the new notification UI
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-22 12:43:29 +01:00
24451e5d60 notification: document 'unknown' severity
This is the severity used for forwarded mails, since we cannot
reasonably infer a priority here.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-21 17:36:45 +01:00
f5f316bddb notification: add anchors for target types/matchers
This enables us to directly link to the appropriate section from the
UI.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-21 17:34:58 +01:00
b4c816f4a4 notifications: change to simplified ACL structure.
For now, we use a less deeply nested structure. We can always extend
it if we need to.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-17 17:54:16 +01:00
7b293b5d9a notifications: add documentation for system mail forwarding
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-17 17:54:16 +01:00
e39dfad987 notifications: document 'comment' option for targets/matchers
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-17 17:54:16 +01:00
7a20522e0e notifications: document SMTP endpoints
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-17 17:54:16 +01:00
c877f0aa6d notifications: update docs to for matcher-based notifications
Target groups and filters have been replaced by notification matchers.
The matcher can match on certain notification properties and route
the notification to a target in case of a match.

This patch updates the docs to reflect these changes.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-17 17:54:16 +01:00
1ba1e95244 add documentation for the new notification system
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-08-16 12:01:17 +02:00