From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <pbs-devel-bounces@lists.proxmox.com> Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id 51A5A20EC88 for <inbox@lore.proxmox.com>; Thu, 25 Apr 2024 14:41:27 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id A62DE31D94; Thu, 25 Apr 2024 14:41:33 +0200 (CEST) Mime-Version: 1.0 Date: Thu, 25 Apr 2024 14:41:30 +0200 Message-Id: <D0T7MDMBWQ8L.IKK9SSFW8HW3@proxmox.com> From: "Gabriel Goller" <g.goller@proxmox.com> To: "Proxmox Backup Server development discussion" <pbs-devel@lists.proxmox.com> X-Mailer: aerc 0.17.0-91-g65332c233880-dirty References: <20240425123025.310887-1-l.wagner@proxmox.com> In-Reply-To: <20240425123025.310887-1-l.wagner@proxmox.com> X-SPAM-LEVEL: Spam detection results: 0 AWL -0.078 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: Re: [pbs-devel] [PATCH proxmox-backup 1/2] docs: document notification-mode and merge old notification section X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion <pbs-devel.lists.proxmox.com> List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>, <mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe> List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/> List-Post: <mailto:pbs-devel@lists.proxmox.com> List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help> List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>, <mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe> Reply-To: Proxmox Backup Server development discussion <pbs-devel@lists.proxmox.com> Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" <pbs-devel-bounces@lists.proxmox.com> On Thu Apr 25, 2024 at 2:30 PM CEST, Lukas Wagner wrote: > diff --git a/docs/notifications.rst b/docs/notifications.rst > index 4f9b01b7..e5ec74b7 100644 > --- a/docs/notifications.rst > +++ b/docs/notifications.rst > @@ -211,3 +211,45 @@ Permissions > In order to modify/view the configuration for notification targets, > the ``Sys.Modify/Sys.Audit`` permissions are required for the > ``/system/notifications`` ACL node. > + > +.. _notification_mode: > + > +Notification Mode > +----------------- > + > +To ensure a smooth transition from the old, purely email based system to > +the new configurable notification system introduced in Proxmox Backup Server 3.2, > +datastore options, tape backup jobs and tape restore jobs gain a new option: > +``notification-mode``. This option must be set to ``notification-system`` > +to opt in to the new notification system. If the option is not set, or > +set to ``legacy-sendmail``, Proxmox Backup Server will use the old > +system. > + > +Starting with Proxmox Backup Server 3.2, a datastore created in the UI will > +automatically opt in to the new notification system. If the datastore is created > +via the API or the ``proxmox-backup-manager`` CLI, the ``notification-system`` > +option has to be set explicitly. > + > +The ``legacy-sendmail`` mode will be deprecated and removed in a later > +release of Proxmox Backup Server. > + > +Settings for ``legacy-sendmail`` notification mode > +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ > + > +If ``notification-mode`` is set to ``legacy-sendmail``, Proxmox Backup Server > +will send notification emails via the system's ``sendmail`` command to the email > +address configured for the user set in the ``notify-user`` option > +(falling back to ``root@pam`` if not set) A period is missing in the last sentence above. > + > +For datastores, you can also change the level of notification received per task 'notification' -> 'notifications' > +type via the ``notify`` option. > + > +* Always: send a notification for any scheduled task, independent of the > + outcome > + > +* Errors: send a notification for any scheduled task that results in an error > + > +* Never: do not send any notification at all > + > +The ``notify-user`` and ``notify`` options are ignored if ``notification-mode`` > +is set to ``notification-system``. > diff --git a/docs/storage.rst b/docs/storage.rst > index 4444c423..f1e15d52 100644 > --- a/docs/storage.rst > +++ b/docs/storage.rst > @@ -314,7 +314,7 @@ Options > > There are a few per-datastore options: > > -* :ref:`Notifications <maintenance_notification>` > +* :ref:`Notification mode and legacy notification settings <notification_mode>` > * :ref:`Maintenance Mode <maintenance_mode>` > * Verification of incoming backups > > @@ -419,7 +419,7 @@ remote-source to avoid that an attacker that took over the source can cause > deletions of backups on the target hosts. > If the source-host became victim of a ransomware attack, there is a good chance > that sync jobs will fail, triggering an :ref:`error notification > -<maintenance_notification>`. > +<Notification Events>`. > > It is also possible to create :ref:`tape backups <tape_backup>` as a second > storage medium. This way, you get an additional copy of your data on a Otherwise this looks good! Reviewed-by: Gabriel Goller <g.goller@proxmox.com> _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel