README

The Users plugin for CakePHP provides a comprehensive, extensible solution for user management, authentication, and authorization. It's designed to get you up and running with a full-featured user system in minutes, while remaining flexible enough for complex, custom applications.

Versions and branches

Key Features

• User Lifecycle: Registration, email validation, profile management, and password reset.
• Authentication: Login/Logout, "Remember Me" (Cookie), and Magic Link (one-click login).
• Social Login: Facebook, Twitter, Instagram, Google, LinkedIn (via OpenID Connect), Amazon, GitHub.
• Security & 2FA:
  • One-Time Password (OTP) for Two-Factor Authentication.
  • Webauthn (Yubico Key, TouchID, etc.) for Two-Factor Authentication.
  • Account lockout policy after failed attempts.
  • Password strength meter.
  • reCaptcha v2 and v3 support.
• Authorization: Integrated RBAC (Role-Based Access Control) and Superuser support via CakeDC/auth.
• Extensibility: Easily extend Controllers, Models (Tables/Entities), Mailers, and Templates.
• Admin Management: Out-of-the-box CRUD for user management.

Requirements

• CakePHP 5.0+
• PHP 8.1+

Quick Start (Installation)

1. Install via Composer:

   composer require cakedc/users

2. Load the Plugin: In your src/Application.php:

   public function bootstrap(): void
   {
       parent::bootstrap();
       $this->addPlugin('CakeDC/Users');
   }

3. Run Migrations:

   bin/cake migrations migrate -p CakeDC/Users

4. Create a Superuser:

   bin/cake users add_superuser

Documentation

For full installation details, configuration options, and tutorials, please visit the Documentation.

Support

• Bugs & Features: Please use the GitHub issues section.
• Commercial Support: Contact CakeDC for professional assistance.

Contributing

We welcome contributions! Please review our Contribution Guidelines and the CakeDC Plugin Standard.

License

Copyright 2010 - Present Cake Development Corporation (CakeDC). All rights reserved.

Licensed under the MIT License. Redistributions of the source code must retain the copyright notice.