Skip to content
This repository has been archived by the owner on Jan 15, 2021. It is now read-only.

Latest commit

 

History

History
46 lines (31 loc) · 1.53 KB

Installation.md

File metadata and controls

46 lines (31 loc) · 1.53 KB

Installation

The plugin should be installed using Composer.

Use the inline require for composer:

composer require burzum/cakephp-user-tools:~1.0

or add this to your composer.json configuration:

{
	"require" : {
		"burzum/cakephp-user-tools": "~1.0"
	}
}

Use the CakePHP Migration plugin to create the users table if you don't want to use your own table.

bin/cake Migrations.migrations migrate -p Burzum/UserTools

Or create your users table manually. Please note that if you are not using the same schema as the plugin provides in the migration file you will have to configure the fieldMap config setting of the UsersBehavior to map your schema.

Add the plugin to your applications bootstrap.php

Plugin::load('Burzum/UserTools');

For a quick start simply attach the UserTool component to a controller and go to to /<your-controller>/register and register a new user.

If you're unsure how to do that see the Quick Start.

Some default URLs that become available when the routes are loaded:

  • /<your-controller>/index
  • /<your-controller>/login
  • /<your-controller>/request_password

For all the customization options the plugin offers please see the documentation or check the default configuration of the component and behavior in the class files. Second is the better option right now because the documentation is not yet completed.