diff --git a/containers/backupchecks/src/static/images/documentation/user-management.png b/containers/backupchecks/src/static/images/documentation/user-management.png new file mode 100644 index 0000000..d838f26 Binary files /dev/null and b/containers/backupchecks/src/static/images/documentation/user-management.png differ 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 f48cbab..bf0efca 100644 --- a/containers/backupchecks/src/templates/documentation/users/users-and-roles.html +++ b/containers/backupchecks/src/templates/documentation/users/users-and-roles.html @@ -127,15 +127,15 @@

How Multiple Roles Work

    -
  1. A user can be assigned any combination of roles (e.g., "admin, operator")
    2. +
  2. A user can be assigned any combination of roles using checkboxes
  3. When logged in, the user selects their active role from a dropdown in the navigation bar
  4. The interface and available features adapt based on the selected active role
  5. Users can switch between their assigned roles at any time
-
- 💡 Example:
- A user assigned both "admin" and "operator" roles can switch between system administration tasks (admin) and daily backup reviews (operator) without logging out. +
+ 💡 When to Use Multiple Roles:
+ Multiple roles are useful when a user occasionally needs different access levels. However, use sparingly - most users should have a single role that matches their primary responsibility.

Managing Users

@@ -146,12 +146,26 @@
  1. Navigate to Settings → User Management (Admin only)
    2. -
  2. Click New User
    3. -
  3. Enter username and password
    4. -
  4. Assign one or more roles (comma-separated: e.g., "admin,operator")
    5. -
  5. Save the user
    6. +
  6. Scroll down to the Create new user section
    7. +
  7. Enter a Username in the username field
    8. +
  8. Enter a Password in the password field
    9. +
  9. Select one or more roles by checking the appropriate checkboxes: +
      +
    • Admin
      • +
    • Operator
      • +
    • Reporter
      • +
    • Viewer
      • +
    +
    10. +
  10. Click the Create button
+
+ User Management Interface +
Figure 1: User Management interface showing role checkboxes and user creation
+
+
📝 Future Feature:
Email address configuration for users is planned for a future update. The database field exists but is not yet available in the user interface. @@ -161,9 +175,10 @@
  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. +
  5. Find the user you want to edit in the list
    6. +
  6. Check or uncheck the role checkboxes to modify their assigned roles
    7. +
  7. The Current: line below the checkboxes shows the currently assigned roles
    8. +
  8. Click the Save button to apply the changes
@@ -171,6 +186,18 @@ Role changes take effect immediately. If you remove a user's current active role, they will be switched to their first remaining role automatically.
+

Resetting User Passwords

+ +
    +
  1. Navigate to Settings → User Management
    2. +
  2. Find the user whose password you want to reset
    3. +
  3. Click the New password button
    4. +
  4. Enter the new password in the dialog
    5. +
  5. Confirm the password change
    6. +
+ +

The user can immediately log in with their new password.

+

Deleting Users

Administrators can delete user accounts via Settings → User Management.