Skip to content

Latest commit

 

History

History
89 lines (66 loc) · 4.35 KB

README.md

File metadata and controls

89 lines (66 loc) · 4.35 KB
Raw

CakeDC Users Plugin

Build Status Coverage Status Downloads Latest Version License

Versions and branches

CakePHP CakeDC Users Plugin Tag Notes
^5.0 14.2 14.2.1 stable
^4.5 13.0 13.0.1 stable
^5.0 12.0 12.0 beta
^4.3 11.0 11.1.0 stable
^4.0 9.0 9.0.5 stable
^3.7 <4.0 8.5 8.5.1 stable
^3.7 <4.0 develop - unstable
3.6 8.1 8.1.0 stable
3.5 6.x 6.0.1 stable
3.4 5.x 5.2.0 stable
>=3.2.9 <3.4.0 4.x 4.2.1 stable
^2.10 2.x 2.2.0 stable

The Users plugin covers the following features:

  • User registration
  • Login/logout
  • Social login (Facebook, Twitter, Instagram, Google, Linkedin, etc)
  • Simple RBAC via https://github.com/CakeDC/auth
  • Remember me (Cookie) via https://github.com/CakeDC/auth
  • Manage user's profile
  • 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:

  • Quick drop-in working solution for users login/registration. Get users working in 5 minutes.
  • Extensible solution for a bigger/custom application. You'll be able to extend:
    • UsersAuth Component
    • Use your own UsersTable
    • Use your own Controller

On the previous versions of the plugin, extensibility was an issue, and one of the main objectives of the 3.0 rewrite is to guarantee all the pieces could be extended/reused as easily.

Another decision made was limiting the plugin dependencies on other packages as much as possible.

Requirements

  • CakePHP 5.0+
  • PHP 8.1+

Documentation

For documentation, as well as tutorials, see the Docs directory of this repository.

Support

For bugs and feature requests, please use the issues section of this repository.

Commercial support is also available, contact us for more information.

Contributing

This repository follows the CakeDC Plugin Standard. If you'd like to contribute new features, enhancements or bug fixes to the plugin, please read our Contribution Guidelines for detailed instructions.

Security

If you've found a security issue in CakeDC Users plugin, please use the procedure described in SECURITY.md

License

Copyright 2019 Cake Development Corporation (CakeDC). All rights reserved.

Licensed under the MIT License. Redistributions of the source code included in this repository must retain the copyright notice found in each file.