Add password change doc (#563)

This commit is contained in:
Misha Bragin
2026-01-20 16:50:16 +01:00
committed by GitHub
parent 8b04229096
commit 32611fae25
3 changed files with 31 additions and 0 deletions

View File

@@ -107,6 +107,37 @@ After creation, a modal displays with:
The generated password is only shown once at creation time. It cannot be retrieved later. Make sure to copy it and share it securely with the user.
</Note>
### Changing User Passwords
The Change Password feature allows local users on self-hosted NetBird deployments to update their account password directly from the dashboard.
<p>
<img src="/docs-static/img/selfhosted/identity-providers/local/change-password-modal.png" alt="Change Password" className="imagewrapper"/>
</p>
This feature is available when:
- The deployment is self-hosted (not NetBird's hosted platform)
- The user authenticates via local authentication
Users authenticated through SSO/OIDC providers will not see this option.
How to Use:
1. Click your avatar in the top-right corner of the dashboard
2. Select "Change Password" from the dropdown menu
3. Enter your current password to verify your identity
4. Enter your new password (minimum 8 characters)
5. Confirm your new password
6. Click "Change Password" or press Enter
<img src="/docs-static/img/selfhosted/identity-providers/local/change-password-menu.png" alt="Change Password" className="imagewrapper"/>
Password Requirements
- Minimum length: eight characters
- New password and confirmation must match
### User IdP Badges
In the Users table, each user shows a badge indicating their identity provider: