public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Arthur Bied-Charreton <a.bied-charreton@proxmox.com>
To: pbs-devel@lists.proxmox.com, pve-devel@lists.proxmox.com
Subject: [PATCH proxmox-backup v4 23/24] notifications: Add OAuth2 section to SMTP target docs
Date: Tue, 21 Apr 2026 13:59:56 +0200	[thread overview]
Message-ID: <20260421115957.402589-24-a.bied-charreton@proxmox.com> (raw)
In-Reply-To: <20260421115957.402589-1-a.bied-charreton@proxmox.com>

Document the new SMTP notification target option, especially that:

1. User intervention is required for initial setup, and

2. Microsoft OAuth2 apps *must not* be configured as SPAs by the user,
   since it would prevent PBS from automatically extending the refresh
   token's lifetime.

Signed-off-by: Arthur Bied-Charreton <a.bied-charreton@proxmox.com>
---
 docs/notifications.rst | 102 +++++++++++++++++++++++++++++++++++++++++
 www/OnlineHelpInfo.js  |  12 +++++
 2 files changed, 114 insertions(+)

diff --git a/docs/notifications.rst b/docs/notifications.rst
index 992ef152..935650bb 100644
--- a/docs/notifications.rst
+++ b/docs/notifications.rst
@@ -69,6 +69,108 @@ address will be used.
 
 See :ref:`notifications.cfg` for all configuration options.
 
+.. _notification_targets_smtp_oauth2:
+
+OAuth2 Authentication
+"""""""""""""""""""""
+
+Proxmox Backup Server supports OAuth2 authentication for SMTP targets via the
+XOAUTH2 mechanism. This is currently available for Google and Microsoft mail
+providers.
+
+Creating an OAuth2 Application
+''''''''''''''''''''''''''''''
+
+Before configuring OAuth2 in Proxmox Backup Server, you must register an OAuth2
+application with your mail provider:
+
+* `Google <https://developers.google.com/identity/protocols/oauth2/web-server>`_
+* `Microsoft Entra ID <https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app>`_
+
+Choose **Web application** as application type.
+
+During registration, add a redirect URI pointing to the Proxmox Backup Server
+web interface URL from which you will perform the authorization flow, for
+example:
+
+* ``https://pbs1.yourdomain.com:8007``
+* ``https://localhost:8007``
+
+You can add multiple redirect URIs to allow the authorization flow to work from
+any node.
+
+.. NOTE:: Google does not allow bare IP addresses as redirect URIs. See
+   :ref:`Google-specific setup <notification_targets_smtp_oauth2_google>` below
+   for a workaround.
+
+Configuring OAuth2 in Proxmox Backup Server
+'''''''''''''''''''''''''''''''''''''''''''
+
+In the web UI, open the notification target's edit panel and select
+``OAuth2 (Google)`` or ``OAuth2 (Microsoft)`` as the authentication method.
+Fill in the client ID and secret. For Microsoft, also fill in the tenant ID.
+
+Click **Authorize**. This opens a new window where you can sign in with your
+mail provider and grant the requested permissions. On success, a refresh token
+is obtained and stored.
+
+Token refresh happens automatically, at least once every 24 hours. If the token
+expires due to extended downtime or is revoked, you will need to re-authorize:
+open the notification target's edit panel, fill in your client secret, and
+click **Authorize** again.
+
+.. NOTE:: OAuth2 cannot be configured through direct configuration file
+   editing. Use the web interface, or alternatively ``proxmox-backup-manager``,
+   to configure OAuth2 targets. Note that when using ``proxmox-backup-manager``,
+   you are responsible for providing the initial refresh token.
+
+::
+
+    proxmox-backup-manager notification endpoint smtp create oauth2-smtp    \
+        --server smtp.example.com                                           \
+        --from-address from@gmail.com                                       \
+        --mailto-user root@pam                                              \
+        --auth-method google-oauth2                                         \
+        --oauth2-client-id <client ID>                                      \
+        --oauth2-client-secret <client secret>                              \
+        --oauth2-refresh-token <refresh token>
+
+For Microsoft, use ``--auth-method microsoft-oauth2`` and add
+``--oauth2-tenant-id <tenant ID>``.
+
+.. _notification_targets_smtp_oauth2_google:
+
+Google
+''''''
+
+Google does not allow bare IP addresses as redirect URIs. To work around this,
+add an entry to ``/etc/hosts`` **on the machine where your browser is
+running**, i.e., your local workstation.
+
+::
+
+    # Replace <IP> with the IP address of your Proxmox Backup Server node
+    <IP> local.oauth2-redirect.com
+
+You can now register ``https://local.oauth2-redirect.com:8007`` as a redirect
+URI in your Google OAuth2 application, and use that same URL in the browser
+when accessing the Proxmox Backup Server web interface to perform the
+authorization flow.
+
+.. _notification_targets_smtp_oauth2_microsoft:
+
+Microsoft
+'''''''''
+
+.. WARNING:: For Microsoft, the application must **not** be registered as a
+   Single-Page Application (SPA). Proxmox Backup Server requires long-lived
+   refresh tokens, and Microsoft does not allow extending the lifetime of
+   refresh tokens granted for SPAs.
+
+Register your OAuth2 application as a standard **Web** application in the
+Entra admin center. In addition to the client ID and secret, you will also
+need the **tenant ID** from your application registration.
+
 .. _notification_targets_gotify:
 
 Gotify
diff --git a/www/OnlineHelpInfo.js b/www/OnlineHelpInfo.js
index 89650cfb..95daed6f 100644
--- a/www/OnlineHelpInfo.js
+++ b/www/OnlineHelpInfo.js
@@ -251,6 +251,18 @@ const proxmoxOnlineHelpInfo = {
     "link": "/docs/notifications.html#notification-targets-smtp",
     "title": "SMTP"
   },
+  "notification-targets-smtp-oauth2": {
+    "link": "/docs/notifications.html#notification-targets-smtp-oauth2",
+    "title": "OAuth2 Authentication"
+  },
+  "notification-targets-smtp-oauth2-google": {
+    "link": "/docs/notifications.html#notification-targets-smtp-oauth2-google",
+    "title": "Google"
+  },
+  "notification-targets-smtp-oauth2-microsoft": {
+    "link": "/docs/notifications.html#notification-targets-smtp-oauth2-microsoft",
+    "title": "Microsoft"
+  },
   "notification-targets-gotify": {
     "link": "/docs/notifications.html#notification-targets-gotify",
     "title": "Gotify"
-- 
2.47.3




  parent reply	other threads:[~2026-04-21 12:04 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-21 11:59 [PATCH docs/manager/proxmox{,-perl-rs,-widget-toolkit,-backup} v4 00/24] fix #7238: Add XOAUTH2 authentication support for SMTP notification targets Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox v4 01/24] Add oauth2 and ureq to workspace dependencies Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox v4 02/24] notify: smtp: Introduce xoauth2 module Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox v4 03/24] notify: smtp: Introduce state management Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox v4 04/24] notify: smtp: Factor out transport building logic Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox v4 05/24] notify: smtp: Update API with OAuth2 parameters Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox v4 06/24] notify: smtp: Infer auth method for backwards compatibility Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox v4 07/24] notify: smtp: Add state handling logic Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox v4 08/24] notify: smtp: Add XOAUTH2 authentication support Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox-perl-rs v4 09/24] pve-rs: notify: smtp: add OAuth2 parameters to bindings Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox-perl-rs v4 10/24] pve-rs: notify: Add binding for triggering state refresh Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox-widget-toolkit v4 11/24] utils: Add OAuth2 flow handlers Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox-widget-toolkit v4 12/24] utils: oauth2: Add callback handler Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox-widget-toolkit v4 13/24] notifications: Add opt-in OAuth2 support for SMTP targets Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH pve-manager v4 14/24] notifications: smtp: api: Add XOAUTH2 parameters Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH pve-manager v4 15/24] notifications: Add trigger-state-refresh endpoint Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH pve-manager v4 16/24] notifications: Trigger notification target refresh in pveupdate Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH pve-manager v4 17/24] login: Handle OAuth2 callback Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH pve-manager v4 18/24] fix #7238: notifications: smtp: Add XOAUTH2 support Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox-backup v4 19/24] notifications: Add XOAUTH2 parameters to endpoints Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox-backup v4 20/24] login: Handle OAuth2 callback Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox-backup v4 21/24] fix #7238: notifications: smtp: Add XOAUTH2 support Arthur Bied-Charreton
2026-04-21 11:59 ` [PATCH proxmox-backup v4 22/24] daily-update: Refresh OAuth2 state for SMTP notification endpoints Arthur Bied-Charreton
2026-04-21 11:59 ` Arthur Bied-Charreton [this message]
2026-04-21 11:59 ` [PATCH pve-docs v4 24/24] notifications: Add OAuth2 section to SMTP targets docs Arthur Bied-Charreton

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260421115957.402589-24-a.bied-charreton@proxmox.com \
    --to=a.bied-charreton@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal