Skip to content

WEB-802: Document password configuration variables in README - #3238

Merged
IOhacker merged 1 commit into
openMF:devfrom
YousufFFFF:WEB-802-readme-password-vars
Feb 28, 2026
Merged

WEB-802: Document password configuration variables in README#3238
IOhacker merged 1 commit into
openMF:devfrom
YousufFFFF:WEB-802-readme-password-vars

Conversation

@YousufFFFF

@YousufFFFF YousufFFFF commented Feb 27, 2026

Copy link
Copy Markdown
Member

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_LENGTH
  • Password validation configuration behavior
  • Default value (8) maintained for backward compatibility

The 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

  • If you have multiple commits please combine them into one commit by squashing them.
  • Read and understood the contribution guidelines at web-app/.github/CONTRIBUTING.md.

Summary by CodeRabbit

  • Documentation
    • Updated password policy docs with configurable minimum length, regex-based rules, behavioral notes, and a Docker example for configuration.
  • New Features
    • Added documentation and toggles for additional UI display and compliance settings (tenant selector, backend info, production mode, server switch, data-hiding and RBAC enablement).

@coderabbitai

coderabbitai Bot commented Feb 27, 2026

Copy link
Copy Markdown

Note

.coderabbit.yaml has unrecognized properties

CodeRabbit is using all valid settings from your configuration. Unrecognized properties (listed below) have been ignored and may indicate typos or deprecated fields that can be removed.

⚠️ Parsing warnings (1)
Validation error: Unrecognized key(s) in object: 'pre_merge_checks'
⚙️ Configuration instructions
  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 158f475 and 8f955a6.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

Walkthrough

Documentation updated: README.md changes include default minimum password length lowered to 8, a new Password Policy Settings section documenting MIFOS_MIN_PASSWORD_LENGTH and MIFOS_PASSWORD_REGEX (with behavioral notes and a Docker example), and expanded UI display toggles.

Changes

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ````.

ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7a9c25e and 158f475.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@YousufFFFF
YousufFFFF force-pushed the WEB-802-readme-password-vars branch from 158f475 to 8f955a6 Compare February 27, 2026 20:45
@YousufFFFF

Copy link
Copy Markdown
Member Author

@IOhacker I just pushed the updates!

@IOhacker IOhacker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@IOhacker
IOhacker merged commit 7042c46 into openMF:dev Feb 28, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants