Add CLI reset-password command documentation#41
Add CLI reset-password command documentation#41renehonig wants to merge 2 commits intochirpstack:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces dedicated documentation for the new chirpstack reset-password CLI command and wires it into the docs navigation and changelog so users can discover and use it for secure password management.
Changes:
- Added
chirpstack/use/cli-commands.mddocumenting CLI usage, with a focus on the newreset-passwordcommand and its security implications. - Updated the ChirpStack changelog with a v4.17.0 entry describing the new CLI feature and linking to the CLI documentation.
- Linked the new CLI commands page from the main
SUMMARY.mdnavigation under “Use”.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
src/chirpstack/use/cli-commands.md |
New CLI commands overview, including detailed reset-password usage, options, examples, and security considerations. |
src/chirpstack/changelog.md |
Adds v4.17.0 “CLI reset-password command” feature entry and points readers to the CLI commands doc. |
src/SUMMARY.md |
Adds the “CLI commands” page to the “Use” section so the new documentation is discoverable. |
Additional suggestion (non-blocking): If the chirpstack --help output has been updated to include reset-password, import-device-profiles, and migrate-device-profile-templates, consider updating the CLI snippet in src/chirpstack/configuration.md in a follow-up so the inline help example stays in sync with the actual binary.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Replace 'echo cleartext | ...' examples with read -rs and secrets manager patterns to avoid shell history exposure - Change stdin label from 'recommended for scripts' to 'pipeline use' - File method is now recommended for scripts, consistent with the security table
Add CLI reset-password command documentation
Summary
This PR adds documentation for the new
reset-passwordCLI command that was implemented to address security concerns from issue #588.Changes
Modified Files
chirpstack-docs/src/chirpstack/use/cli-commands.md- Added comprehensive documentation for thereset-passwordcommand including:Documentation Preview
reset-password
Reset a user's password without API access. This command is useful for:
Usage:
Options:
-e, --email <EMAIL>-p, --password-file <FILE>--stdinExamples:
Security Notes
chmod 600permissionsTesting
The documentation was validated by:
rpasswordcrate validation