nordsoftware/lumen-oauth2

OAuth2 module for the Lumen PHP framework.

Lumen OAuth2

, _(*1)

OAuth2 module for the Lumen PHP framework., _(*2)

Requirements

• PHP 5.6 or newer
• Composer
• Lumen 5.3 or newer

Usage

Installation

Run the following command to install the package through Composer:, _(*3)

composer require nordsoftware/lumen-oauth2

Install a storage connector by running one of the following commands:, _(*4)

composer require nordsoftware/lumen-oauth2-doctrine

or, _(*5)

composer require nordsoftware/lumen-oauth2-eloquent

or you can build your own., _(*6)

Configure

Copy the configuration template in config/oauth2.php to your application's config directory and modify according to your needs. For more information see the Configuration Files section in the Lumen documentation., _(*7)

Bootstrapping

Add the following lines to bootstrap/app.php:, _(*8)

$app->configure('oauth2');

Depending on the storage connector in use, register the correct service provider, e.g., _(*9)

$app->register(Nord\Lumen\OAuth2\Doctrine\DoctrineServiceProvider::class);

Then the OAuth2 module service provider., _(*10)

$app->register(Nord\Lumen\OAuth2\OAuth2ServiceProvider::class);

And to use the middleware for authenticating users., _(*11)

$app->routeMiddleware([
    .....
    Nord\Lumen\OAuth2\Middleware\OAuth2Middleware::class,
]);

Contributing

Please read the guidelines., _(*12)

License

See LICENSE., _(*13)