Installation

Composer

composer require cakedc/users

If you want to use social login features...

composer require league/oauth2-facebook:@stable
composer require league/oauth2-instagram:@stable
composer require league/oauth2-google:@stable
composer require league/oauth1-client:@stable

NOTE: you'll need to enable social login if you want to use it, social login is disabled by default. Check the Configuration page for more details.

If you want to use reCaptcha features...

composer require google/recaptcha:@stable

NOTE: you'll need to configure the reCaptcha key and secret, check the Configuration page for more details.

If you want to use Google Authenticator features...

composer require robthree/twofactorauth:@stable
composer require endroid/qr-code:@stable

NOTE: The plugin uses endroid/qr-code as the QR code provider by default. You can use any other changing the configuration key:

'OneTimePasswordAuthenticator.qrcodeprovider' => YOUR_PROVIDER,

To finish configuration, you'll need to enable OneTimePasswordAuthenticator.login in your config/users.php file:

'OneTimePasswordAuthenticator.login' => true,

Load the Plugin

Ensure the Users Plugin is loaded in your src/Application.php file

    /**
     * {@inheritdoc}
     */
    public function bootstrap(): void
    {
        parent::bootstrap();

        $this->addPlugin(\CakeDC\Users\Plugin::class);
        // Uncomment the line below to load your custom users.php config file
        //Configure::write('Users.config', ['users']);
    }

Important note: The plugin loads the authentication and authorization plugins and uses RequestAuthorizationMiddleware with Rbac|Superuser policy. You should not load them manually.

Creating config files

You need to create the file config/users.php to configure the plugin. This documentation assumes that you will create this file.

Example config/users.php

<?php
return [
    'Users.Social.login' => true,
];

The plugin loads authentication and authorization plugins by default. To be able to access your pages you NEED to have defined rules at the file config/permissions.php. You can copy the one from the plugin and add your permissions rules.

cd {project_dir}
cp vendor/cakedc/users/config/permissions.php config/permissions.php

Go to permission documentation for more information.

Creating Required Tables

If you want to use the Users tables to store your users and social accounts:

bin/cake migrations migrate -p CakeDC/Users

Note you don't need to use the provided tables, you could customize the table names, fields etc. in your application and then use the plugin configuration to use your own tables instead. Please refer to the Extending the Plugin section to check all the customization options.

You can create the first user, the superuser, by issuing the following command:

bin/cake users add_superuser

Customization

First, make sure to set the config Users.config at Application::bootstrap

$this->addPlugin(\CakeDC\Users\Plugin::class);
Configure::write('Users.config', ['users']);

And update your config/users.php file, for example if you want to use social login:

<?php
return [
    'Users.Social.login' => true,
    'OAuth.providers.facebook.options.clientId' => 'YOUR APP ID',
    'OAuth.providers.facebook.options.clientSecret' => 'YOUR APP SECRET',
    'OAuth.providers.twitter.options.clientId' => 'YOUR APP ID',
    'OAuth.providers.twitter.options.clientSecret' => 'YOUR APP SECRET',
    //etc
];

IMPORTANT: Remember you'll need to configure your social login application callback url to use the provider specific endpoint, for example:

• Facebook App Callback URL --> http://yourdomain.com/auth/facebook
• Twitter App Callback URL --> http://yourdomain.com/auth/twitter
• Google App Callback URL --> http://yourdomain.com/auth/google
• etc.

Note: using social authentication is not required.

For more details, check the Configuration doc page.