Auth Module
Auth Module is a flexible user registration, authentication & RBAC module for Yii2. It provides user authentication, registration and RBAC support to your Yii2 site., (*1)
Installation
The preferred way to install this extension is through composer., (*2)
Either run, (*3)
$ php composer.phar require yanglaw/yii2-auth "*"
or add, (*4)
"yanglaw/yii2-auth": "*"
to the require section of your composer.json
file., (*5)
Usage
Once the extension is installed, modify your application configuration to include:, (*6)
return [
'modules' => [
...
'auth' => [
'class' => 'auth\Module',
'layout' => '//homepage', // Layout when not logged in yet
'layoutLogged' => '//main', // Layout for logged in users
'attemptsBeforeCaptcha' => 3, // Optional
'supportEmail' => 'support@mydomain.com', // Email for notifications
'passwordResetTokenExpire' => 3600, // Seconds for token expiration
'superAdmins' => ['admin'], // SuperAdmin users
'tableMap' => [ // Optional, but if defined, all must be declared
'User' => 'user',
'UserStatus' => 'user_status',
'ProfileFieldValue' => 'profile_field_value',
'ProfileField' => 'profile_field',
'ProfileFieldType' => 'profile_field_type',
],
],
...
],
...
'components' => [
...
'user' => [
'class' => 'auth\components\User',
],
...
]
];
And run migrations:, (*7)
$ php yii migrate/up --migrationPath=@auth/migrations
License
Auth module is released under the BSD-3 License. See the bundled LICENSE.md
for details., (*8)
INSTALLATION
./yii migrate/up --migrationPath=@auth/migrations, (*9)
URLs
- Login:
yourhost/auth/default/login
- Logout:
yourhost/auth/default/logout
- Sign-up:
yourhost/auth/default/signup
- Reset Password:
yourhost/auth/default/reset-password
- User management:
yourhost/auth/user/index
- User profile:
yourhost/auth/profile/view