From 6bf81bd730d37b2e4854300de6276878eb6b76de Mon Sep 17 00:00:00 2001 From: Ivo Oskamp Date: Mon, 23 Feb 2026 14:23:15 +0100 Subject: [PATCH] Add documentation page for Microsoft Entra SSO setup --- .../backend/app/main/routes_documentation.py | 1 + .../documentation/settings/entra-sso.html | 94 +++++++++++++++++++ 2 files changed, 95 insertions(+) create mode 100644 containers/backupchecks/src/templates/documentation/settings/entra-sso.html diff --git a/containers/backupchecks/src/backend/app/main/routes_documentation.py b/containers/backupchecks/src/backend/app/main/routes_documentation.py index 66c2f16..718f9b6 100644 --- a/containers/backupchecks/src/backend/app/main/routes_documentation.py +++ b/containers/backupchecks/src/backend/app/main/routes_documentation.py @@ -89,6 +89,7 @@ DOCUMENTATION_STRUCTURE = { {'slug': 'general', 'title': 'General Settings'}, {'slug': 'mail-configuration', 'title': 'Mail Configuration'}, {'slug': 'autotask-integration', 'title': 'Autotask Integration'}, + {'slug': 'entra-sso', 'title': 'Microsoft Entra SSO'}, {'slug': 'reporting-settings', 'title': 'Reporting Settings'}, {'slug': 'user-management', 'title': 'User Management'}, {'slug': 'maintenance', 'title': 'Maintenance'}, diff --git a/containers/backupchecks/src/templates/documentation/settings/entra-sso.html b/containers/backupchecks/src/templates/documentation/settings/entra-sso.html new file mode 100644 index 0000000..3f941bf --- /dev/null +++ b/containers/backupchecks/src/templates/documentation/settings/entra-sso.html @@ -0,0 +1,94 @@ +{% extends "documentation/base.html" %} + +{% block doc_content %} +

Microsoft Entra SSO

+

Use Microsoft Entra ID (Azure AD) to let users sign in with their Microsoft account.

+ +
+ Scope: this page explains the setup for Backupchecks and Microsoft Entra. + It does not replace your internal identity/security policies. +
+ +

Prerequisites

+ + +

Step 1: Register an app in Microsoft Entra

+
    +
  1. Open Microsoft Entra admin center → App registrations.
    2. +
  2. Create a new registration (single-tenant is typical for internal use).
    3. +
  3. Set a name, for example Backupchecks SSO.
    4. +
  4. After creation, copy: +
      +
    • Application (client) ID
      • +
    • Directory (tenant) ID
      • +
    +
    5. +
+ +

Step 2: Configure redirect URI

+
    +
  1. In the app registration, open Authentication.
    2. +
  2. Add a Web redirect URI: +
      +
    • https://your-backupchecks-domain/auth/entra/callback
      • +
    +
    3. +
  3. Save the authentication settings.
    4. +
+ +

Step 3: Create client secret

+
    +
  1. Open Certificates & secrets in the app registration.
    2. +
  2. Create a new client secret.
    3. +
  3. Copy the secret value immediately (it is shown only once).
    4. +
+ +

Step 4: Configure Backupchecks

+
    +
  1. Open Settings → Integrations → Microsoft Entra SSO.
    2. +
  2. Enable Microsoft sign-in.
    3. +
  3. Fill in: +
      +
    • Tenant ID
      • +
    • Client ID
      • +
    • Client Secret
      • +
    • Redirect URI (optional override, leave empty to auto-use callback URL)
      • +
    • Allowed domain/tenant (optional restriction)
      • +
    +
    4. +
  4. Optional: enable Auto-provision unknown users as Viewer.
    5. +
  5. Save settings.
    6. +
+ +

Step 5: Test sign-in

+
    +
  1. Open /auth/login in a private/incognito browser session.
    2. +
  2. Click Sign in with Microsoft.
    3. +
  3. Authenticate with an allowed account.
    4. +
  4. Confirm you are redirected back into Backupchecks.
    5. +
+ +

User mapping behavior

+ + +

Troubleshooting

+ +{% endblock %} +