WEB-802: Document password configuration variables in README - #3238
Conversation
|
Note
|
| Cohort / File(s) | Summary |
|---|---|
Documentation README.md |
Lowered default MIFOS_MIN_PASSWORD_LENGTH from 12 to 8; added Password Policy Settings documenting MIFOS_MIN_PASSWORD_LENGTH and MIFOS_PASSWORD_REGEX, behavioral notes (fallbacks, scope limited to Basic Auth), Docker example; expanded UI Display Settings with additional toggles; minor markdown fence fixes. |
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~5 minutes
Suggested reviewers
- IOhacker
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | ✅ Passed | The title 'WEB-802: Document password configuration variables in README' directly and specifically describes the main change: documenting password configuration variables in the README file. |
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
🧪 Generate unit tests (beta)
- Create PR with unit tests
- Post copyable unit tests in a comment
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands and usage tips.
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 312: Remove the duplicate MIFOS_MIN_PASSWORD_LENGTH entry from the
"Session & Performance Settings" table and keep the canonical documentation
entry in the "Password Policy Settings" section; locate the table row containing
the "MIFOS_MIN_PASSWORD_LENGTH" key in the Session & Performance Settings and
delete that entire row so the only remaining documentation of
MIFOS_MIN_PASSWORD_LENGTH is the entry under Password Policy Settings.
- Around line 333-336: Replace the non-standard 4-backtick code fence that opens
with ````bash (the block containing MIFOS_MIN_PASSWORD_LENGTH and
MIFOS_PASSWORD_REGEX) with a standard 3-backtick fence (```bash) and close it
immediately after those two lines with ```, and also fix the later mismatched
fence that opens with ```bash but closes with ```` so both fences use consistent
3-backtick delimiters; look for the offending fences (the ````bash opener and
the later ```bash/```` pair) and normalize them to ```bash ... ``` and ```bash
... ``` respectively.
- Line 398: The README has a Markdown code-fence mismatch: the Docker example
opens with a four-backtick fence (````bash) but closes with only three backticks
(```); update the closing fence (the end of that Docker example) to use four
backticks (````) so the closing fence matches the opening fence and conforms to
CommonMark; locate the Docker example that begins with the ````bash fence and
replace the trailing ``` with ````.
158f475 to
8f955a6
Compare
|
@IOhacker I just pushed the updates! |
Description
This PR updates the README.md to document the password configuration variables introduced in WEB-628.
Specifically, it adds documentation for:
MIFOS_MIN_PASSWORD_LENGTHThe purpose of this change is to ensure that deployment and Docker environment variables are clearly documented for administrators and contributors. No functional or code-level changes are included in this PR.
Related issues and discussion
#WEB-802
Related to #WEB-628
Screenshots, if any
N/A (Documentation-only change)
Checklist
web-app/.github/CONTRIBUTING.md.Summary by CodeRabbit