README

Auth module for Infuse Framework

Installation

1. Install the package with composer:

   composer require infuse/auth
   

2. Add the service to services in your app's configuration:

   'services' => [
       // ...
       'auth' => 'Infuse\Auth\Services\Auth'
       // ...
   ]

3. Add the migration to your app's configuration:

   'modules' => [
      'migrations' => [
         // ...
         'Auth'
      ],
      'migrationPaths' => [
         // ...
         'Auth' => 'vendor/infuse/auth/src/migrations'
      ]
   ]

4. (optional) Add the console command for helper tasks to console.commands in your app's configuration:

   'console' => [
       // ...
       'commands' => [
    	   // ...
    	   'Infuse\Auth\Console\ResetPasswordLinkCommand'
       ]
   ]

5. (optional) Add the garbage collection scheduled job to cron in your app's configuration:

   'cron' => [
      // ...
      [
         'id' => 'auth:garbageCollection',
         'class' => 'Infuse\Auth\Jobs\GarbageCollection',
         'minute' => 30,
         'hour' => 1,
         'day' => 1
      ]
   ]

Usage

You can create your own User model located at App\Users\Models\User for futher customization.