Markdown fixes for configuration-options
This commit is contained in:
@ -10,12 +10,14 @@ If this option is to `true`, session history will be kept, [more](../guides/how-
|
|||||||
#### numberSessionHistory (Type: `boolean, integer`, Default value: `false`)
|
#### numberSessionHistory (Type: `boolean, integer`, Default value: `false`)
|
||||||
|
|
||||||
Number of expired storing records `session history`, values:
|
Number of expired storing records `session history`, values:
|
||||||
|
|
||||||
- `false` Store all records without deleting
|
- `false` Store all records without deleting
|
||||||
- `integer` Count of records for storing
|
- `integer` Count of records for storing
|
||||||
|
|
||||||
#### timeoutSessionHistory (Type: `boolean, integer`, Default value: `false`)
|
#### timeoutSessionHistory (Type: `boolean, integer`, Default value: `false`)
|
||||||
|
|
||||||
How long store `session history` after expiring, values:
|
How long store `session history` after expiring, values:
|
||||||
|
|
||||||
- `false` Store all records without deleting
|
- `false` Store all records without deleting
|
||||||
- `integer` Time for storing after expiring in seconds
|
- `integer` Time for storing after expiring in seconds
|
||||||
|
|
||||||
@ -40,6 +42,7 @@ enabled: true if you want to enable the channel, false otherwise.
|
|||||||
|
|
||||||
The following is the default configuration:
|
The following is the default configuration:
|
||||||
|
|
||||||
|
```php
|
||||||
'google-authenticator'=>[
|
'google-authenticator'=>[
|
||||||
'class'=>\Da\User\Validator\TwoFactorCodeValidator::class,
|
'class'=>\Da\User\Validator\TwoFactorCodeValidator::class,
|
||||||
'description'=>Yii::t('usuario', 'Google Authenticator'),
|
'description'=>Yii::t('usuario', 'Google Authenticator'),
|
||||||
@ -60,14 +63,17 @@ The following is the default configuration:
|
|||||||
'codeDurationTime'=>300,
|
'codeDurationTime'=>300,
|
||||||
'smsSender'=>'smsSender',
|
'smsSender'=>'smsSender',
|
||||||
'enabled'=>true
|
'enabled'=>true
|
||||||
]
|
],
|
||||||
|
```
|
||||||
|
|
||||||
For instructions about implementation of SMS sending see at the following link: https://www.yiiframework.com/extension/yetopen/yii2-sms-aruba
|
For instructions about implementation of SMS sending see at the following link: <https://www.yiiframework.com/extension/yetopen/yii2-sms-aruba>
|
||||||
|
|
||||||
#### twoFactorAuthenticationForcedPermissions (type: `array`, default: `[]`)
|
#### twoFactorAuthenticationForcedPermissions (type: `array`, default: `[]`)
|
||||||
|
|
||||||
The list of permissions for which two factor authentication is mandatory. In order to perform the check in every action you must configure a filter into your config file like this:
|
The list of permissions for which two factor authentication is mandatory. In order to perform the check in every action,
|
||||||
|
you must configure a filter into your config file like this:
|
||||||
|
|
||||||
|
```php
|
||||||
use Da\User\Filter\TwoFactorAuthenticationEnforceFilter;
|
use Da\User\Filter\TwoFactorAuthenticationEnforceFilter;
|
||||||
...
|
...
|
||||||
'on beforeAction' => function() {
|
'on beforeAction' => function() {
|
||||||
@ -79,13 +85,17 @@ use Da\User\Filter\TwoFactorAuthenticationEnforceFilter;
|
|||||||
);
|
);
|
||||||
},
|
},
|
||||||
...
|
...
|
||||||
|
```
|
||||||
|
|
||||||
This will redirect the user to their account page until the two factor authentication is enabled.
|
This will redirect the user to their account page until the two factor authentication is enabled.
|
||||||
|
Otherwise you can set the filter on each controller you need.
|
||||||
|
|
||||||
#### enableGdprCompliance (type: `boolean`, default: `false`)
|
#### enableGdprCompliance (type: `boolean`, default: `false`)
|
||||||
|
|
||||||
Setting this attribute enables a serie of measures to comply with EU GDPR regulation, like data consent, right to be forgotten and data portability.
|
Setting this attribute enables a serie of measures to comply with EU GDPR regulation, like data consent, right to be forgotten and data portability.
|
||||||
|
|
||||||
#### gdprPrivacyPolicyUrl (type: `array`, default: null)
|
#### gdprPrivacyPolicyUrl (type: `array`, default: null)
|
||||||
|
|
||||||
The link to privacy policy. This will be used on registration form as "read our pivacy policy". It must follow the same format as `yii\helpers\Url::to`
|
The link to privacy policy. This will be used on registration form as "read our pivacy policy". It must follow the same format as `yii\helpers\Url::to`
|
||||||
|
|
||||||
#### gdprExportProperties (type: `array`)
|
#### gdprExportProperties (type: `array`)
|
||||||
@ -94,6 +104,7 @@ An array with the name of the user identity properties to be included when user
|
|||||||
Names can include relations like `profile.name`.
|
Names can include relations like `profile.name`.
|
||||||
|
|
||||||
Defaults to:
|
Defaults to:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
[
|
[
|
||||||
'email',
|
'email',
|
||||||
@ -107,21 +118,24 @@ Defaults to:
|
|||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
#### gdprAnonymizePrefix (type: `string`, default: `GDPR`)
|
#### gdprAnonymizePrefix (type: `string`, default: `GDPR`)
|
||||||
|
|
||||||
Prefix to be used as a replacement when user requeste deletion of his data
|
Prefix to be used as a replacement when user requeste deletion of his data
|
||||||
|
|
||||||
#### gdprConsentMessage (type: `string`)
|
#### gdprConsentMessage (type: `string`)
|
||||||
|
|
||||||
Use this to customize the message that will appear as hint in the give consent checkbox.
|
Use this to customize the message that will appear as hint in the give consent checkbox.
|
||||||
If you leave it empty the next message will be used:
|
If you leave it empty the next message will be used:
|
||||||
|
|
||||||
>I agree processing of my personal data and the use of cookies to facilitate the operation of this site. For more information read our privacy policy
|
>I agree processing of my personal data and the use of cookies to facilitate the operation of this site. For more information read our privacy policy
|
||||||
|
|
||||||
#### GdprRequireConsentToAll (type `boolean`, default `false`)
|
#### GdprRequireConsentToAll (type `boolean`, default `false`)
|
||||||
|
|
||||||
Whether require to already registered user give consent to process their data. According to GDPR this is mandatory.
|
Whether require to already registered user give consent to process their data. According to GDPR this is mandatory.
|
||||||
To forbid user access to any function, until it gives consent, use the AccessRuleFilter included with this module.
|
To forbid user access to any function, until it gives consent, use the AccessRuleFilter included with this module.
|
||||||
|
|
||||||
#### GdprConsentExcludedUrls (type `array`, default `['user/settings/*']`)
|
#### GdprConsentExcludedUrls (type `array`, default `['user/settings/*']`)
|
||||||
|
|
||||||
List of urls that does not require explicit data processing consent to be accessed, like own profile, account... You can use wildcards like `route/to/*` .
|
List of urls that does not require explicit data processing consent to be accessed, like own profile, account... You can use wildcards like `route/to/*` .
|
||||||
|
|
||||||
#### enableRegistration (type: `boolean`, default: `true`)
|
#### enableRegistration (type: `boolean`, default: `true`)
|
||||||
@ -164,6 +178,7 @@ If `true` it will enable administrator to send a password recovery email to a us
|
|||||||
If set to an integer value it will check user password age. If the days since last password change are greater than this configuration value
|
If set to an integer value it will check user password age. If the days since last password change are greater than this configuration value
|
||||||
user will be forced to change it. This enforcement is done only at login stage. In order to perform the check in every action you must configure
|
user will be forced to change it. This enforcement is done only at login stage. In order to perform the check in every action you must configure
|
||||||
a filter into your controller like this:
|
a filter into your controller like this:
|
||||||
|
|
||||||
```
|
```
|
||||||
use Da\User\Filter\PasswordAgeEnforceFilter;
|
use Da\User\Filter\PasswordAgeEnforceFilter;
|
||||||
class SiteController extends Controller
|
class SiteController extends Controller
|
||||||
@ -176,6 +191,7 @@ class SiteController extends Controller
|
|||||||
'class' => PasswordAgeEnforceFilter::className(),
|
'class' => PasswordAgeEnforceFilter::className(),
|
||||||
],
|
],
|
||||||
```
|
```
|
||||||
|
|
||||||
This will redirect the user to their account page until the password has been updated.
|
This will redirect the user to their account page until the password has been updated.
|
||||||
|
|
||||||
#### allowAccountDelete (type: `boolean`, default: `false`)
|
#### allowAccountDelete (type: `boolean`, default: `false`)
|
||||||
@ -220,7 +236,6 @@ Configures the permission name for `administrators`. See [AuthHelper](../../src/
|
|||||||
|
|
||||||
Configures the URL prefix for the module.
|
Configures the URL prefix for the module.
|
||||||
|
|
||||||
|
|
||||||
#### mailParams (type: `array`, default: `[]`)
|
#### mailParams (type: `array`, default: `[]`)
|
||||||
|
|
||||||
Configures the parameter values used on [MailFactory](../../src/User/Factory/MailFactory.php). The default values are:
|
Configures the parameter values used on [MailFactory](../../src/User/Factory/MailFactory.php). The default values are:
|
||||||
@ -243,7 +258,6 @@ the hash and to verify a password against it. Higher cost therefore slows down a
|
|||||||
protected against brute-force attacks, set it to the highest value that is tolerable on production servers. The time
|
protected against brute-force attacks, set it to the highest value that is tolerable on production servers. The time
|
||||||
taken to compute the hash doubles for every increment by one of `$blowfishCost`.
|
taken to compute the hash doubles for every increment by one of `$blowfishCost`.
|
||||||
|
|
||||||
|
|
||||||
#### consoleControllerNamespace (type: `string`, default: `Da\User\Command`)
|
#### consoleControllerNamespace (type: `string`, default: `Da\User\Command`)
|
||||||
|
|
||||||
Allows customization of the console application controller namespace for the module.
|
Allows customization of the console application controller namespace for the module.
|
||||||
@ -296,11 +310,11 @@ Minimum requirements when a new password is automatically generated.
|
|||||||
Array structure: `"requirement" => minimum_number_characters`.
|
Array structure: `"requirement" => minimum_number_characters`.
|
||||||
|
|
||||||
Possible array keys:
|
Possible array keys:
|
||||||
|
|
||||||
- lower: minimum number of lowercase characters;
|
- lower: minimum number of lowercase characters;
|
||||||
- upper: minimum number of uppercase characters;
|
- upper: minimum number of uppercase characters;
|
||||||
- digit: minimum number of digits;
|
- digit: minimum number of digits;
|
||||||
- special: minimum number of special characters;
|
- special: minimum number of special characters;
|
||||||
- min: minimum number of characters (= minimum length).
|
- min: minimum number of characters (= minimum length).
|
||||||
|
|
||||||
|
|
||||||
© [2amigos](http://www.2amigos.us/) 2013-2019
|
© [2amigos](http://www.2amigos.us/) 2013-2019
|
||||||
|
|||||||
Reference in New Issue
Block a user