Streamline Profile Settings documentation to reflect actual functionality
- Updated page description: only password change available in User Settings - Added screenshot reference for user-settings.png - Clarified theme selector location: navigation bar (between username and logout) - Clarified role selector location: navigation bar (not in settings page) - Simplified profile information: username and assigned roles (read-only) - Removed non-existent Notification Preferences section - Removed Session Information section (not displayed) - Enhanced troubleshooting section with specific password change issues - Maintained Data Privacy and Password sections Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
a4d9c4f312
commit
3f75ab87cd
@ -4,14 +4,9 @@
|
||||
<h1>Profile Settings</h1>
|
||||
|
||||
<p class="lead">
|
||||
Customize your user profile, change your password, and configure personal preferences.
|
||||
View your profile information and change your password.
|
||||
</p>
|
||||
|
||||
<div class="doc-callout doc-callout-info">
|
||||
<strong>📝 Coming Soon:</strong><br>
|
||||
This page is under construction. Screenshots will be added in a future update.
|
||||
</div>
|
||||
|
||||
<h2>Accessing Profile Settings</h2>
|
||||
|
||||
<p>To access your profile settings:</p>
|
||||
@ -21,16 +16,19 @@
|
||||
<li>This will open the User Settings page</li>
|
||||
</ol>
|
||||
|
||||
<p>Alternatively, navigate directly to the User Settings page via the menu (if your role has access).</p>
|
||||
<figure>
|
||||
<img src="{{ url_for('static', filename='images/documentation/user-settings.png') }}"
|
||||
alt="User Settings Interface" />
|
||||
<figcaption>Figure 1: User Settings page showing profile information and password change form</figcaption>
|
||||
</figure>
|
||||
|
||||
<h2>Profile Information</h2>
|
||||
|
||||
<p>Your profile displays the following information:</p>
|
||||
<p>Your profile displays the following read-only information:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>Username:</strong> Your login username (cannot be changed by users)</li>
|
||||
<li><strong>Assigned Roles:</strong> The roles you have been granted</li>
|
||||
<li><strong>Active Role:</strong> Your currently selected role</li>
|
||||
<li><strong>Assigned Roles:</strong> The roles you have been granted by administrators</li>
|
||||
</ul>
|
||||
|
||||
<div class="doc-callout doc-callout-info">
|
||||
@ -75,9 +73,9 @@
|
||||
If you forget your new password, you will need to contact your administrator for a password reset. There is no self-service password recovery.
|
||||
</div>
|
||||
|
||||
<h2>Theme Preference</h2>
|
||||
<h2>Theme Selection</h2>
|
||||
|
||||
<p>BackupChecks supports multiple visual themes to match your preference and reduce eye strain.</p>
|
||||
<p>While not part of the User Settings page itself, you can change your visual theme at any time using the theme selector in the navigation bar.</p>
|
||||
|
||||
<h3>Available Themes</h3>
|
||||
|
||||
@ -110,93 +108,38 @@
|
||||
|
||||
<h3>Changing Your Theme</h3>
|
||||
|
||||
<p>You can change your theme in two ways:</p>
|
||||
|
||||
<h4>Method 1: Navigation Bar (Quick Change)</h4>
|
||||
|
||||
<ol>
|
||||
<li>Locate the <strong>theme selector dropdown</strong> in the top-right corner of the navigation bar (next to your username)</li>
|
||||
<li>Locate the <strong>theme selector dropdown</strong> in the top-right corner of the navigation bar</li>
|
||||
<li>Position: between your username and the logout button (or between role selector and logout if you have multiple roles)</li>
|
||||
<li>Click the dropdown to see available themes</li>
|
||||
<li>Select <strong>Light</strong>, <strong>Dark</strong>, or <strong>Auto</strong></li>
|
||||
<li>The page will reload and apply your selected theme immediately</li>
|
||||
</ol>
|
||||
|
||||
<h4>Method 2: Profile Settings</h4>
|
||||
|
||||
<ol>
|
||||
<li>Navigate to your profile settings (click your username)</li>
|
||||
<li>Locate the <strong>Theme Preference</strong> setting</li>
|
||||
<li>Select your preferred theme</li>
|
||||
<li>Save your changes</li>
|
||||
</ol>
|
||||
|
||||
<p>Your theme preference is saved and will persist across all devices where you log in.</p>
|
||||
<p>Your theme preference is saved to your profile and will persist across sessions.</p>
|
||||
|
||||
<div class="doc-callout doc-callout-tip">
|
||||
<strong>💡 Tip:</strong><br>
|
||||
The <strong>Auto</strong> 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.
|
||||
</div>
|
||||
|
||||
<h2>Role Selection</h2>
|
||||
<h2>Role Switching</h2>
|
||||
|
||||
<p>If you have multiple roles assigned, you can view and switch between them from your profile.</p>
|
||||
<p>If you have multiple roles assigned, you can switch between them using the role selector in the navigation bar (not in User Settings).</p>
|
||||
|
||||
<h3>Viewing Your Roles</h3>
|
||||
|
||||
<p>Your assigned roles are displayed in your profile settings. This is a read-only view showing all roles granted by your administrator.</p>
|
||||
|
||||
<h3>Switching Active Role</h3>
|
||||
|
||||
<p>To switch your active role:</p>
|
||||
|
||||
<ol>
|
||||
<li>Use the <strong>role selector dropdown</strong> in the top-right corner of the navigation bar</li>
|
||||
<li>Select the role you want to activate</li>
|
||||
<li>The page will reload with the appropriate permissions and menu items for that role</li>
|
||||
</ol>
|
||||
<p>The role selector appears in the top-right corner between your username and the logout button. Click it to select your active role.</p>
|
||||
|
||||
<p>See <a href="{{ url_for('documentation.page', section='users', page='users-and-roles') }}">Users & Roles</a> for detailed information about role permissions and switching.</p>
|
||||
|
||||
<h2>Session Information</h2>
|
||||
|
||||
<p>Some profile pages may display session information:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>Last Login:</strong> When you last successfully logged in</li>
|
||||
<li><strong>Active Sessions:</strong> Your current browser sessions (if implemented)</li>
|
||||
<li><strong>Login History:</strong> Recent login attempts (if audit logging is enabled)</li>
|
||||
</ul>
|
||||
|
||||
<div class="doc-callout doc-callout-info">
|
||||
<strong>💡 Note:</strong><br>
|
||||
Session information availability depends on your system configuration and may not be visible to all users.
|
||||
</div>
|
||||
|
||||
<h2>Notification Preferences</h2>
|
||||
|
||||
<p>Future versions of BackupChecks may include notification preferences such as:</p>
|
||||
|
||||
<ul>
|
||||
<li>Email notifications for failed backups</li>
|
||||
<li>Daily digest emails</li>
|
||||
<li>Alert thresholds</li>
|
||||
<li>Report delivery preferences</li>
|
||||
</ul>
|
||||
|
||||
<div class="doc-callout doc-callout-info">
|
||||
<strong>📝 Future Feature:</strong><br>
|
||||
Notification preferences are not currently implemented. Check back in future updates.
|
||||
</div>
|
||||
|
||||
<h2>Data Privacy</h2>
|
||||
|
||||
<h3>What Data is Stored?</h3>
|
||||
|
||||
<p>BackupChecks stores the following personal information:</p>
|
||||
<p>BackupChecks stores the following user information:</p>
|
||||
|
||||
<ul>
|
||||
<li>Username (required for login)</li>
|
||||
<li>Password hash (securely encrypted)</li>
|
||||
<li>Password hash (securely encrypted, never stored in plain text)</li>
|
||||
<li>Assigned roles</li>
|
||||
<li>Theme preference</li>
|
||||
<li>Last active role</li>
|
||||
@ -205,8 +148,8 @@
|
||||
<h3>Who Can See Your Information?</h3>
|
||||
|
||||
<ul>
|
||||
<li><strong>You:</strong> Can view your own profile information</li>
|
||||
<li><strong>Administrators:</strong> Can view and edit all user profiles</li>
|
||||
<li><strong>You:</strong> Can view your own username and assigned roles</li>
|
||||
<li><strong>Administrators:</strong> Can view and edit all user profiles via Settings → User Management</li>
|
||||
<li><strong>Other Users:</strong> Cannot view your profile or personal information</li>
|
||||
</ul>
|
||||
|
||||
@ -220,35 +163,33 @@
|
||||
|
||||
<p><strong>Possible causes:</strong></p>
|
||||
<ul>
|
||||
<li>Current password is incorrect - verify you're entering your current password correctly</li>
|
||||
<li>New password doesn't meet requirements - ensure password meets minimum length</li>
|
||||
<li>Browser autofill issue - try typing passwords manually instead of using autofill</li>
|
||||
<li><strong>Current password is incorrect:</strong> Verify you're entering your current password correctly (passwords are case-sensitive)</li>
|
||||
<li><strong>New password doesn't meet requirements:</strong> Ensure password meets minimum length (check with your administrator)</li>
|
||||
<li><strong>New passwords don't match:</strong> Verify both new password fields contain the exact same password</li>
|
||||
<li><strong>Browser autofill issue:</strong> Try typing passwords manually instead of using autofill</li>
|
||||
</ul>
|
||||
|
||||
<h3>Theme Doesn't Change</h3>
|
||||
<div class="doc-callout doc-callout-warning">
|
||||
<strong>⚠️ Forgot Your Password?</strong><br>
|
||||
If you cannot remember your current password, contact your administrator. They can reset your password via Settings → User Management.
|
||||
</div>
|
||||
|
||||
<h3>Can't Access User Settings</h3>
|
||||
|
||||
<p><strong>Possible causes:</strong></p>
|
||||
<ul>
|
||||
<li>Browser cache - clear your browser cache and reload the page</li>
|
||||
<li>Browser compatibility - try a different browser</li>
|
||||
<li>Auto theme not working - ensure your OS has a dark mode preference set</li>
|
||||
</ul>
|
||||
|
||||
<h3>Can't Access Profile Settings</h3>
|
||||
|
||||
<p><strong>Possible causes:</strong></p>
|
||||
<ul>
|
||||
<li>Session expired - log out and log back in</li>
|
||||
<li>Permission issue - contact your administrator</li>
|
||||
<li>Browser issue - try incognito/private mode</li>
|
||||
<li><strong>Session expired:</strong> Log out and log back in to refresh your session</li>
|
||||
<li><strong>Browser issue:</strong> Try a different browser or incognito/private mode</li>
|
||||
<li><strong>Username not clickable:</strong> Ensure you're clicking directly on your username text in the top-right corner</li>
|
||||
</ul>
|
||||
|
||||
<h2>Next Steps</h2>
|
||||
|
||||
<ul>
|
||||
<li><a href="{{ url_for('documentation.page', section='users', page='users-and-roles') }}">Users & Roles</a> - Learn about user roles and permissions</li>
|
||||
<li><a href="{{ url_for('documentation.page', section='users', page='login-authentication') }}">Login & Authentication</a> - Understand login and session management</li>
|
||||
<li><a href="{{ url_for('documentation.page', section='users', page='users-and-roles') }}">Users & Roles</a> - Learn about user roles, permissions, and role switching</li>
|
||||
<li><a href="{{ url_for('documentation.page', section='users', page='login-authentication') }}">Login & Authentication</a> - Understand login process and session management</li>
|
||||
<li><a href="{{ url_for('documentation.page', section='getting-started', page='first-login') }}">First Login & Dashboard</a> - Navigate the dashboard interface</li>
|
||||
<li><a href="{{ url_for('documentation.page', section='settings', page='user-management') }}">User Management Settings</a> - Admin guide for managing user accounts (Admin only)</li>
|
||||
</ul>
|
||||
|
||||
{% endblock %}
|
||||
|
||||
@ -37,6 +37,13 @@ This file documents all changes made to this project via Claude Code.
|
||||
- **Login & Authentication page**: Added captcha requirement explanation (simple math problem), noted future plan to make it optional via Settings
|
||||
- **Browser Security section**: Clarified HTTPS context - only relevant for external access via domain name, not for internal IP-based deployments (typical use case)
|
||||
- **Browser Compatibility**: Marked Mozilla Firefox as "Recommended - Most tested" browser for optimal experience
|
||||
- **Profile Settings page**: Streamlined to reflect actual functionality - only password change available in User Settings page, theme and role selectors located in navigation bar
|
||||
|
||||
### Removed
|
||||
- Removed non-existent features from Profile Settings documentation:
|
||||
- Notification Preferences section (no plans for implementation)
|
||||
- Session Information section (not displayed in User Settings)
|
||||
- Redundant theme/role configuration sections (these are in navbar, not settings page)
|
||||
|
||||
## [2026-02-07]
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user