diff --git a/containers/backupchecks/src/templates/documentation/users/login-authentication.html b/containers/backupchecks/src/templates/documentation/users/login-authentication.html index d3d325d..820502d 100644 --- a/containers/backupchecks/src/templates/documentation/users/login-authentication.html +++ b/containers/backupchecks/src/templates/documentation/users/login-authentication.html @@ -4,16 +4,239 @@

Login & Authentication

- Learn about login procedures and authentication in BackupChecks. + Learn how to log in to BackupChecks and manage your authentication session.

- 📝 Coming Soon: - This page is under construction. Full content will be added in a future update. + 📝 Coming Soon:
+ This page is under construction. Screenshots will be added in a future update.
-

Authentication

+

Logging In

-

Content coming soon...

+

BackupChecks uses a traditional username and password authentication system.

+ +

Login Steps

+ +
    +
  1. Navigate to the BackupChecks URL in your web browser
    2. +
  2. You will be automatically redirected to the login page if not authenticated
    3. +
  3. Enter your username in the username field
    4. +
  4. Enter your password in the password field
    5. +
  5. Click the Login button
    6. +
+ +

If your credentials are correct, you will be redirected to the dashboard.

+ +

First Login

+ +

When you log in for the first time:

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

Authentication Method

+ +

BackupChecks uses local database authentication:

+ + + +
+ 💡 Note:
+ User accounts are created and managed by administrators via Settings → User Management. +
+ +

Login Failures

+ +

Common Login Issues

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
IssuePossible CauseSolution
Invalid credentials errorIncorrect username or passwordDouble-check username and password (case-sensitive). Contact your administrator if you've forgotten your credentials.
Page doesn't load after loginSession or cookie issueClear your browser cookies and cache, then try again.
Redirected back to loginSession expired or browser issueTry 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. +
  2. After logging in again, you may be redirected to the page you were trying to access
    3. +
+ +

Logging Out

+ +

To log out of BackupChecks:

+ +
    +
  1. Click the Logout button in the top-right corner of the navigation bar
    2. +
  2. Your session will be terminated immediately
    3. +
  3. You will be redirected to the login page
    4. +
+ +
+ 💡 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

+ + + +
+ ⚠️ 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. +
  2. If this is your first login or the role is no longer valid, your first assigned role will be activated
    3. +
  3. You can switch roles at any time using the role dropdown in the navigation bar
    4. +
+ +

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. +
  2. Contact your administrator to verify your account exists and is active
    3. +
  3. Ask your administrator to check the audit logs for any issues
    4. +
+ +

Browser Compatibility

+ +

BackupChecks is designed to work with modern web browsers:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BrowserMinimum VersionRecommended
Google Chrome90+Latest stable
Mozilla Firefox88+Latest stable
Microsoft Edge90+Latest stable
Safari14+Latest stable
+ +
+ 💡 Note:
+ Internet Explorer is not supported. Please use a modern browser for the best experience. +
+ +

Next Steps

+ + {% endblock %} diff --git a/containers/backupchecks/src/templates/documentation/users/profile-settings.html b/containers/backupchecks/src/templates/documentation/users/profile-settings.html index 5711718..0f597af 100644 --- a/containers/backupchecks/src/templates/documentation/users/profile-settings.html +++ b/containers/backupchecks/src/templates/documentation/users/profile-settings.html @@ -4,16 +4,253 @@

Profile Settings

- Customize your profile settings and preferences. + Customize your user profile, change your password, and configure personal preferences.

- 📝 Coming Soon: - This page is under construction. Full content will be added in a future update. + 📝 Coming Soon:
+ This page is under construction. Screenshots will be added in a future update.
-

Profile

+

Accessing Profile Settings

-

Content coming soon...

+

To access your profile settings:

+ +
    +
  1. Click on your username in the top-right corner of the navigation bar
    2. +
  2. This will open the User Settings page
    3. +
+ +

Alternatively, navigate directly to the User Settings page via the menu (if your role has access).

+ +

Profile Information

+ +

Your profile displays the following information:

+ + + +
+ 💡 Note:
+ Only administrators can modify usernames, email addresses, and role assignments via Settings → User Management. +
+ +

Changing Your Password

+ +

You can change your password at any time from the profile settings page.

+ +

Password Change Steps

+ +
    +
  1. Navigate to your profile settings (click your username)
    2. +
  2. Locate the Change Password section
    3. +
  3. Enter your current password
    4. +
  4. Enter your new password
    5. +
  5. Re-enter your new password to confirm
    6. +
  6. Click Change Password or Save
    7. +
+ +

If successful, you will see a confirmation message. Your password is updated immediately.

+ +
+ 💡 Password Best Practices:
+ Use a strong password with at least 8 characters, including uppercase, lowercase, numbers, and symbols. Avoid common words or easily guessable information. +
+ +

Password Requirements

+ +

BackupChecks password requirements:

+ + + +
+ ⚠️ Important:
+ If you forget your new password, you will need to contact your administrator for a password reset. There is no self-service password recovery. +
+ +

Theme Preference

+ +

BackupChecks supports multiple visual themes to match your preference and reduce eye strain.

+ +

Available Themes

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
ThemeDescriptionWhen to Use
LightLight backgrounds with dark textWell-lit environments, daytime use
DarkDark backgrounds with light textLow-light environments, reduce eye strain
AutoAutomatically matches your system preferenceAdapts to your OS dark mode setting
+ +

Changing Your Theme

+ +

You can change your theme in two ways:

+ +

Method 1: Navigation Bar (Quick Change)

+ +
    +
  1. Locate the theme selector dropdown in the top-right corner of the navigation bar (next to your username)
    2. +
  2. Click the dropdown to see available themes
    3. +
  3. Select Light, Dark, or Auto
    4. +
  4. The page will reload and apply your selected theme immediately
    5. +
+ +

Method 2: Profile Settings

+ +
    +
  1. Navigate to your profile settings (click your username)
    2. +
  2. Locate the Theme Preference setting
    3. +
  3. Select your preferred theme
    4. +
  4. Save your changes
    5. +
+ +

Your theme preference is saved and will persist across all devices where you log in.

+ +
+ 💡 Tip:
+ The Auto theme is recommended if your operating system already has a dark mode schedule. BackupChecks will automatically switch between light and dark themes based on your OS setting. +
+ +

Role Selection

+ +

If you have multiple roles assigned, you can view and switch between them from your profile.

+ +

Viewing Your Roles

+ +

Your assigned roles are displayed in your profile settings. This is a read-only view showing all roles granted by your administrator.

+ +

Switching Active Role

+ +

To switch your active role:

+ +
    +
  1. Use the role selector dropdown in the top-right corner of the navigation bar
    2. +
  2. Select the role you want to activate
    3. +
  3. The page will reload with the appropriate permissions and menu items for that role
    4. +
+ +

See Users & Roles for detailed information about role permissions and switching.

+ +

Session Information

+ +

Some profile pages may display session information:

+ + + +
+ 💡 Note:
+ Session information availability depends on your system configuration and may not be visible to all users. +
+ +

Notification Preferences

+ +

Future versions of BackupChecks may include notification preferences such as:

+ + + +
+ 📝 Future Feature:
+ Notification preferences are not currently implemented. Check back in future updates. +
+ +

Data Privacy

+ +

What Data is Stored?

+ +

BackupChecks stores the following personal information:

+ + + +

Who Can See Your Information?

+ + + +

Data Retention

+ +

Your profile data is retained as long as your account exists. If your account is deleted by an administrator, all associated profile data is removed.

+ +

Troubleshooting

+ +

Can't Change Password

+ +

Possible causes:

+ + +

Theme Doesn't Change

+ +

Possible causes:

+ + +

Can't Access Profile Settings

+ +

Possible causes:

+ + +

Next Steps

+ + {% endblock %} diff --git a/containers/backupchecks/src/templates/documentation/users/users-and-roles.html b/containers/backupchecks/src/templates/documentation/users/users-and-roles.html index ad1d6c1..c400fe0 100644 --- a/containers/backupchecks/src/templates/documentation/users/users-and-roles.html +++ b/containers/backupchecks/src/templates/documentation/users/users-and-roles.html @@ -4,16 +4,243 @@

Users & Roles

- Learn how to manage users and assign roles in BackupChecks. + BackupChecks uses a role-based access control system to manage user permissions and access levels.

- 📝 Coming Soon: - This page is under construction. Full content will be added in a future update. + 📝 Coming Soon:
+ This page is under construction. Screenshots will be added in a future update.
-

User Management

+

User Roles Overview

-

Content coming soon...

+

BackupChecks supports four distinct user roles, each with specific permissions and access levels:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RolePrimary PurposeKey Permissions
AdminFull system administrationComplete access to all features, settings, user management, and system configuration
OperatorDaily backup operationsReview backups, manage customers/jobs, create tickets, view reports (no system settings)
ReporterReporting and analyticsView and generate reports only (no access to operational features)
ViewerRead-only monitoringView customers, jobs, and reports (cannot make changes)
+ +

Detailed Role Permissions

+ +

Admin Role

+ +

Administrators have unrestricted access to BackupChecks:

+ + + +
+ ⚠️ Security Note:
+ Admin access should be limited to trusted personnel only. Admins can modify critical system settings and access all data. +
+ +

Operator Role

+ +

Operators handle day-to-day backup monitoring and validation:

+ + + +

Operators cannot: Access system settings, manage users, view audit logs, or access deleted mails.

+ +

Reporter Role

+ +

Reporters focus exclusively on reporting and analytics:

+ + + +

Reporters cannot: Access operational features like inbox, customers, jobs, run checks, or tickets. The navigation menu shows only report-related items.

+ +
+ 💡 Use Case:
+ The Reporter role is ideal for management or stakeholders who need visibility into backup compliance without operational access. +
+ +

Viewer Role

+ +

Viewers have read-only access to monitor backup status:

+ + + +

Viewers cannot: Make any changes, create tickets, review backups, or access system settings.

+ +

Multiple Role Assignment

+ +

Users can be assigned multiple roles simultaneously. This provides flexibility for users who need different access levels at different times.

+ +

How Multiple Roles Work

+ +
    +
  1. A user can be assigned any combination of roles (e.g., "operator, reporter")
    2. +
  2. When logged in, the user selects their active role from a dropdown in the navigation bar
    3. +
  3. The interface and available features adapt based on the selected active role
    4. +
  4. Users can switch between their assigned roles at any time
    5. +
+ +
+ 💡 Example:
+ A user assigned both "operator" and "reporter" roles can switch between reviewing backups (operator) and generating executive reports (reporter) without logging out. +
+ +

Managing Users

+ +

User management is performed by administrators through the Settings page.

+ +

Creating a New User

+ +
    +
  1. Navigate to Settings → User Management (Admin only)
    2. +
  2. Click New User
    3. +
  3. Enter username, email, and password
    4. +
  4. Assign one or more roles (comma-separated: e.g., "admin,operator")
    5. +
  5. Save the user
    6. +
+ +

Editing User Roles

+ +
    +
  1. Navigate to Settings → User Management
    2. +
  2. Click the edit icon next to the user
    3. +
  3. Modify the roles field (comma-separated list)
    4. +
  4. Save changes
    5. +
+ +
+ ⚠️ Important:
+ Role changes take effect immediately. If you remove a user's current active role, they will be switched to their first remaining role automatically. +
+ +

Role Switching

+ +

Users with multiple roles can switch between them using the role selector in the navigation bar (top-right corner, next to the username).

+ +

How to Switch Roles

+ +
    +
  1. Locate the role dropdown in the top-right corner of the navigation bar
    2. +
  2. Click the dropdown to see your assigned roles
    3. +
  3. Select the role you want to activate
    4. +
  4. The page will reload and the interface will adapt to the selected role
    5. +
+ +

The navigation menu, available features, and permissions update immediately to match your active role.

+ +

Best Practices

+ + + +

Common Role Assignment Scenarios

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
User TypeRecommended Role(s)Rationale
System AdministratoradminNeeds full access to configure and maintain the system
Backup Team LeadoperatorReviews backups daily, manages customers and jobs
Junior Backup Technicianoperator or viewerAssists with reviews or monitors status (depending on trust level)
Management/StakeholderreporterNeeds reports and metrics, not operational access
Auditor/ComplianceviewerNeeds to verify backup status without making changes
Dual-Function Useroperator, reporterPerforms daily reviews and also generates reports
+ +

Next Steps

+ + {% endblock %}