Skip to content

Commit

Permalink
Improve docs and translations. Fix password meter
Browse files Browse the repository at this point in the history
  • Loading branch information
ajibarra committed May 10, 2024
1 parent f63c170 commit 8c0e428
Show file tree
Hide file tree
Showing 19 changed files with 567 additions and 482 deletions.
4 changes: 2 additions & 2 deletions Docs/Documentation/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ Password meter is enabled by default but you can disable it or change config opt

```php
'Users.passwordMeter.enabled' => true, //enable or disable password meter. Defaults to true
'Users.passwordMeter.requiredScore' => 3, //int value from 1 to 4 (25%,50%,75%,100%). Defaults to 3
'Users.passwordMeter.requiredScore' => 1, //int value from 1 to 4 (25%,50%,75%,100%). Defaults to 1
'Users.passwordMeter.messagesList' => ['Empty password', 'Too simple', 'Simple', 'That\'s OK', 'Great password!'], //Messages for each password level (0%,25%,50%,75%,100%)
'Users.passwordMeter.pswMinLength' => 8, //Password min length, defaults to 8
'Users.passwordMeter.pswMinLength' => 8, //Password min length, defaults to 8. It won't affect users validation in backend
'Users.passwordMeter.showMessage' => true, //shows password message
```

Expand Down
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ CakeDC Users Plugin
Versions and branches
---------------------

| CakePHP | CakeDC Users Plugin | Tag | Notes |
|:--------------:|:----------------------------------------------------------:|:-----------------:| :---- |
| ^5.0 | [14.1](https://github.com/cakedc/users/tree/14.next-cake5) | 14.next-cake5-dev | beta |
| ^4.5 | [13.0](https://github.com/cakedc/users/tree/13.next-cake4) | 13.0.1 | stable |
| ^5.0 | [12.0](https://github.com/cakedc/users/tree/12.next-cake5) | 12.0 | beta |
| ^4.3 | [11.0](https://github.com/cakedc/users/tree/11.next-cake4) | 11.1.0 | stable |
| ^4.0 | [9.0](https://github.com/cakedc/users/tree/9.next) | 9.0.5 | stable |
| ^3.7 <4.0 | [8.5](https://github.com/cakedc/users/tree/8.next) | 8.5.1 | stable |
| ^3.7 <4.0 | [develop](https://github.com/cakedc/users/tree/develop) | - | unstable |
| 3.6 | [8.1](https://github.com/cakedc/users/tree/8.1.0) | 8.1.0 | stable |
| 3.5 | [6.x](https://github.com/cakedc/users/tree/6.x) | 6.0.1 | stable |
| 3.4 | [5.x](https://github.com/cakedc/users/tree/5.x) | 5.2.0 | stable |
| >=3.2.9 <3.4.0 | [4.x](https://github.com/cakedc/users/tree/4.x) | 4.2.1 | stable |
| ^2.10 | [2.x](https://github.com/cakedc/users/tree/2.x) | 2.2.0 |stable |
| CakePHP | CakeDC Users Plugin | Tag | Notes |
|:--------------:|:----------------------------------------------------------:|:------:|:---------|
| ^5.0 | [14.2](https://github.com/cakedc/users/tree/14.next-cake5) | 14.2.1 | stable |
| ^4.5 | [13.0](https://github.com/cakedc/users/tree/13.next-cake4) | 13.0.1 | stable |
| ^5.0 | [12.0](https://github.com/cakedc/users/tree/12.next-cake5) | 12.0 | beta |
| ^4.3 | [11.0](https://github.com/cakedc/users/tree/11.next-cake4) | 11.1.0 | stable |
| ^4.0 | [9.0](https://github.com/cakedc/users/tree/9.next) | 9.0.5 | stable |
| ^3.7 <4.0 | [8.5](https://github.com/cakedc/users/tree/8.next) | 8.5.1 | stable |
| ^3.7 <4.0 | [develop](https://github.com/cakedc/users/tree/develop) | - | unstable |
| 3.6 | [8.1](https://github.com/cakedc/users/tree/8.1.0) | 8.1.0 | stable |
| 3.5 | [6.x](https://github.com/cakedc/users/tree/6.x) | 6.0.1 | stable |
| 3.4 | [5.x](https://github.com/cakedc/users/tree/5.x) | 5.2.0 | stable |
| >=3.2.9 <3.4.0 | [4.x](https://github.com/cakedc/users/tree/4.x) | 4.2.1 | stable |
| ^2.10 | [2.x](https://github.com/cakedc/users/tree/2.x) | 2.2.0 | stable |

The **Users** plugin covers the following features:

Expand All @@ -36,6 +36,8 @@ The **Users** plugin covers the following features:
* Admin management
* One-Time Password for Two-Factor Authentication
* Webauthn for Two-Factor Authentication (Yubico Key compatible)
* reCaptcha v3 (14.2 only) and v2 supported in all versions
* Password Meter

The plugin is here to provide users related features following 2 approaches:

Expand Down
2 changes: 1 addition & 1 deletion config/bootstrap.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@
];
foreach ($oldConfigs as $configKey) {
if (Configure::check($configKey)) {
trigger_error(__("Users plugin configuration key \"{0}\" was removed, please check migration guide https://github.com/CakeDC/users/blob/master/Docs/Documentation/Migration/8.x-9.0.md", $configKey));
trigger_error(__d('cake_d_c/users', "Users plugin configuration key \"{0}\" was removed, please check migration guide https://github.com/CakeDC/users/blob/master/Docs/Documentation/Migration/8.x-9.0.md", $configKey));
}
}
10 changes: 8 additions & 2 deletions config/users.php
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,15 @@
//enable or disable password meter
'enabled' => true,
//int value from 1 to 4 (25%,50%,75%,100%). Defaults to 3
'requiredScore' => 3,
'requiredScore' => 1,
//Messages for each password level (0%,25%,50%,75%,100%)
'messagesList' => ['Empty password', 'Too simple', 'Simple', 'That\'s OK', 'Great password!'],
'messagesList' => [
__d('cake_d_c/users', 'Empty password'),
__d('cake_d_c/users', 'Too simple'),
__d('cake_d_c/users','Simple'),
__d('cake_d_c/users', 'That\'s OK'),
__d('cake_d_c/users', 'Great password!')
],
//Password min length
'pswMinLength' => 8,
//shows message for password score
Expand Down
Loading

0 comments on commit 8c0e428

Please sign in to comment.