{% extends "documentation/base.html" %} {% block doc_content %}

Login & Authentication

Learn how to log in to BackupChecks and manage your authentication session.

Logging In

BackupChecks supports local username/password authentication and, optionally, Microsoft Entra (Azure AD) Single Sign-On.

Login Steps

  1. Navigate to the BackupChecks URL in your web browser
  2. You will be automatically redirected to the login page if not authenticated
  3. Enter your username in the username field
  4. Enter your password in the password field
  5. If the login captcha is enabled, solve the simple math problem (e.g., "3 + 5 = ?")
  6. Click the Login button

If your credentials are correct (and the captcha, if shown, is solved), you will be redirected to the dashboard.

💡 Captcha is configurable:
The login captcha is controlled by the login_captcha_enabled setting in Settings → General. It is enabled by default; administrators can disable it for restricted internal deployments where the extra step is unnecessary.

First Login

When you log in for the first time:

  1. You will land on the Dashboard page
  2. Review any news announcements or system updates
  3. If you have multiple roles, select your preferred active role from the dropdown in the navigation bar
  4. Consider changing your password via Profile Settings
💡 Tip:
Bookmark the BackupChecks URL for quick access. The system will remember your last active role between sessions.

Authentication Methods

BackupChecks supports the following authentication methods:

⚠️ Entra SSO is implemented but not yet validated in production:
The integration is wired up end-to-end (login flow, token exchange, optional auto-provisioning, group filtering) but has not been tested against a live tenant in our deployment. Treat it as a preview feature until verified. Local username/password remains the recommended login method.
💡 Note:
User accounts are created and managed by administrators via Settings → User Management.

Login Failures

Common Login Issues

Issue Possible Cause Solution
Invalid credentials error Incorrect username or password Double-check username and password (case-sensitive). Contact your administrator if you've forgotten your credentials.
Page doesn't load after login Session or cookie issue Clear your browser cookies and cache, then try again.
Redirected back to login Session expired or browser issue Try a different browser or incognito/private mode to rule out browser-specific issues.
⚠️ Password Reset:
BackupChecks does not currently have a self-service password reset feature. If you forget your password, contact your system administrator to reset it.

Session Management

Session Duration

BackupChecks uses persistent sessions:

Automatic Redirects

If your session expires or becomes invalid:

  1. You will be automatically redirected to the login page
  2. After logging in again, you may be redirected to the page you were trying to access

Logging Out

To log out of BackupChecks:

  1. Click the Logout button in the top-right corner of the navigation bar
  2. Your session will be terminated immediately
  3. You will be redirected to the login page
💡 Best Practice:
Always log out when using a shared or public computer. This ensures your session is properly terminated and prevents unauthorized access.

Security Considerations

Password Security

Browser Security

💡 Deployment Context:
BackupChecks is typically deployed in restricted internal environments (accessed via IP address). For external access via a public domain, HTTPS should be configured using a reverse proxy or certificate.
⚠️ Security Alert:
If you suspect unauthorized access to your account, contact your administrator immediately to reset your password and review audit logs.

Role Selection After Login

If you have multiple roles assigned:

  1. After login, your last active role will be automatically selected
  2. If this is your first login or the role is no longer valid, your first assigned role will be activated
  3. You can switch roles at any time using the role dropdown in the navigation bar

See Users & Roles for more information about role switching.

Troubleshooting Login Issues

Can't Remember Username

Contact your system administrator. They can look up your username in Settings → User Management.

Can't Remember Password

Contact your system administrator. They can reset your password for you.

Account Locked or Disabled

BackupChecks does not currently implement account lockouts. If you cannot log in:

  1. Verify your username and password are correct
  2. Contact your administrator to verify your account exists and is active
  3. Ask your administrator to check the audit logs for any issues

Browser Compatibility

BackupChecks is designed to work with modern web browsers:

Browser Minimum Version Status
Mozilla Firefox 88+ Recommended - Most tested
Google Chrome 90+ Supported
Microsoft Edge 90+ Supported
Safari 14+ Supported
💡 Best Experience:
Mozilla Firefox is the most thoroughly tested browser for BackupChecks and provides the best experience. While other modern browsers are supported, Firefox is recommended for optimal compatibility.
⚠️ Not Supported:
Internet Explorer is not supported. Please use a modern browser (Firefox recommended).

Next Steps

{% endblock %}