Skip to content

Commit

Permalink
add documentation for entropy feature (#903, #830)
Browse files Browse the repository at this point in the history
  • Loading branch information
David Coutadeur committed May 14, 2024
1 parent b2e06be commit fa077a6
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/config_ppolicy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -172,3 +172,30 @@ software:
$show_extended_error = true;
Entropy
-------

When the user is typing his new password, you can enable an entropy bar,
showing the strength of the password.

.. code-block:: php
$pwd_display_entropy = true;
You can also require the entropy bar to hit a minimum level for the
password to be accepted:

.. code-block:: php
# enforce password entropy check
$pwd_check_entropy = true;
# minimum entropy level required (when $pwd_check_entropy enabled)
$pwd_min_entropy = 3;
``$pwd_min_entropy`` must be an integer between 0 (very risky) and 4 (very strong).

.. tip:: The entropy check is computed by the
`zxcvbn library <https://github.com/dropbox/zxcvbn>`_


0 comments on commit fa077a6

Please sign in to comment.