Installation in Lumen | laravel-permission | Spatie SPATIE Laravel Permission ===================== spatie.be/open-source [Docs](https://spatie.be/docs) [Laravel-permission](https://spatie.be/docs/laravel-permission/v3) Installation in Lumen Version v7 v6 v5 v4 v3 Other versions for crawler [v7](https://spatie.be/docs/laravel-permission/v7) [v6](https://spatie.be/docs/laravel-permission/v6) [v5](https://spatie.be/docs/laravel-permission/v5) [v4](https://spatie.be/docs/laravel-permission/v4) [v3](https://spatie.be/docs/laravel-permission/v3) - [ Introduction ](https://spatie.be/docs/laravel-permission/v3/introduction) - [ Support us ](https://spatie.be/docs/laravel-permission/v3/support-us) - [ Prerequisites ](https://spatie.be/docs/laravel-permission/v3/prerequisites) - [ Installation in Laravel ](https://spatie.be/docs/laravel-permission/v3/installation-laravel) - [ Installation in Lumen ](https://spatie.be/docs/laravel-permission/v3/installation-lumen) - [ Upgrading ](https://spatie.be/docs/laravel-permission/v3/upgrading) - [ Questions and issues ](https://spatie.be/docs/laravel-permission/v3/questions-issues) - [ Changelog ](https://spatie.be/docs/laravel-permission/v3/changelog) - [ About us ](https://spatie.be/docs/laravel-permission/v3/about-us) Basic Usage ----------- - [ Basic Usage ](https://spatie.be/docs/laravel-permission/v3/basic-usage/basic-usage) - [ Direct Permissions ](https://spatie.be/docs/laravel-permission/v3/basic-usage/direct-permissions) - [ Using permissions via roles ](https://spatie.be/docs/laravel-permission/v3/basic-usage/role-permissions) - [ Wildcard permissions ](https://spatie.be/docs/laravel-permission/v3/basic-usage/wildcard-permissions) - [ Blade directives ](https://spatie.be/docs/laravel-permission/v3/basic-usage/blade-directives) - [ Defining a Super-Admin ](https://spatie.be/docs/laravel-permission/v3/basic-usage/super-admin) - [ Using multiple guards ](https://spatie.be/docs/laravel-permission/v3/basic-usage/multiple-guards) - [ Using artisan commands ](https://spatie.be/docs/laravel-permission/v3/basic-usage/artisan) - [ Using a middleware ](https://spatie.be/docs/laravel-permission/v3/basic-usage/middleware) - [ Example App ](https://spatie.be/docs/laravel-permission/v3/basic-usage/new-app) Best Practices -------------- - [ Roles vs Permissions ](https://spatie.be/docs/laravel-permission/v3/best-practices/roles-vs-permissions) - [ Model Policies ](https://spatie.be/docs/laravel-permission/v3/best-practices/using-policies) - [ Performance Tips ](https://spatie.be/docs/laravel-permission/v3/best-practices/performance) Advanced usage -------------- - [ Testing ](https://spatie.be/docs/laravel-permission/v3/advanced-usage/testing) - [ Database Seeding ](https://spatie.be/docs/laravel-permission/v3/advanced-usage/seeding) - [ Exceptions ](https://spatie.be/docs/laravel-permission/v3/advanced-usage/exceptions) - [ Extending ](https://spatie.be/docs/laravel-permission/v3/advanced-usage/extending) - [ Cache ](https://spatie.be/docs/laravel-permission/v3/advanced-usage/cache) - [ UUID ](https://spatie.be/docs/laravel-permission/v3/advanced-usage/uuid) - [ Extending PhpStorm ](https://spatie.be/docs/laravel-permission/v3/advanced-usage/phpstorm) - [ Other ](https://spatie.be/docs/laravel-permission/v3/advanced-usage/other) - [ Timestamps ](https://spatie.be/docs/laravel-permission/v3/advanced-usage/timestamps) - [ UI Options ](https://spatie.be/docs/laravel-permission/v3/advanced-usage/ui-options) You are viewing the documentation for **an older version** of this package. You can check the version you are using with the following command: ` composer show spatie/laravel-permission ` Installation in Lumen ===================== NOTE: Lumen is not officially supported by this package. However, the following are some steps which may help get you started. First, install the package via Composer: ``` composer require spatie/laravel-permission ``` Copy the required files: ``` mkdir -p config cp vendor/spatie/laravel-permission/config/permission.php config/permission.php cp vendor/spatie/laravel-permission/database/migrations/create_permission_tables.php.stub database/migrations/2018_01_01_000000_create_permission_tables.php ``` You will also need the `config/auth.php` file. If you don't already have it, copy it from the vendor folder: ``` cp vendor/laravel/lumen-framework/config/auth.php config/auth.php ``` Then, in `bootstrap/app.php`, uncomment the `auth` middleware, and register this package's middleware: ``` $app->routeMiddleware([ 'auth' => App\Http\Middleware\Authenticate::class, 'permission' => Spatie\Permission\Middlewares\PermissionMiddleware::class, 'role' => Spatie\Permission\Middlewares\RoleMiddleware::class, ]); ``` ... and in the same file, in the ServiceProviders section, register the package configuration, service provider, and cache alias: ``` $app->configure('permission'); $app->alias('cache', \Illuminate\Cache\CacheManager::class); // if you don't have this already $app->register(Spatie\Permission\PermissionServiceProvider::class); ``` ... and in the same file, since the Authorization layer uses guards you will need to uncomment the AuthServiceProvider line: ``` $app->register(App\Providers\AuthServiceProvider::class); ``` Ensure your database configuration is set in your `.env` (or `config/database.php` if you have one). Run the migrations to create the tables for this package: ``` php artisan migrate ``` --- ### User Model NOTE: Remember that Laravel's authorization layer requires that your `User` model implement the `Illuminate\Contracts\Auth\Access\Authorizable` contract. In Lumen you will then also need to use the `Laravel\Lumen\Auth\Authorizable` trait. --- ### User Table NOTE: If you are working with a fresh install of Lumen, then you probably also need a migration file for your Users table. You can create your own, or you can copy a basic one from Laravel: https://github.com/laravel/laravel/blob/master/database/migrations/2014\_10\_12\_000000\_create\_users\_table.php (You will need to run `php artisan migrate` after adding this file.) Remember to update your ModelFactory.php to match the fields in the migration you create/copy.