Documentation
#filament-access-management
Auth Admin Plugin for Filament Admin with Laravel-Permission
The Auth Admin Plugin is a powerful authentication plugin designed specifically for use with Filament Admin and Laravel-Permission. With this plugin, you can easily manage roles, permissions, and menus all in one package.
This plugin binds all page routes to their corresponding permissions automatically. If a permission is not allowed, an authentication error will be displayed. This makes it easy to ensure that only authorized users can access specific pages and features within your application.
Features:
- Manage roles and permissions
- Manage menus
- Automatic permission binding to page routes
- Authentication error display for unauthorized access
#Installation
-
You can install the package via composer:
composer require solution-forest/filament-access-management
-
Add the necessary trait to your User model:
use SolutionForest\FilamentAccessManagement\Concerns\FilamentUser;
class User extends Authenticatable
{
use FilamentUser;
}
-
Clear your config cache:
php artisan optimize:clear
# or
php artisan config:clear
-
Then execute the following commands:
php artisan filament-access-management:install
If you don't already have a user named admin, this command creates a Super Admin User with the following credentials:
- Name: admin
- E-mail address: admin@("slug" pattern from config("app.name")).com
- Password: admin
You can also create the super admin user with:
php artisan make:super-admin-user
-
In your config/app.php place this code in you providers section
'providers' => [
...
/*
* Package Service Providers...
*/
\SolutionForest\FilamentAccessManagement\FilamentAuthServiceProvider::class,
...
],
#Publish Configs, Views, Translations and Migrations
You can publish the configs, views, translations and migrations with:
php artisan vendor:publish --tag="filament-access-management-config"
php artisan vendor:publish --tag="filament-access-management-views"
php artisan vendor:publish --tag="filament-access-management-translations"
php artisan vendor:publish --tag="filament-access-management-migrations"
#Migration
php artisan migrate
#Usage
Upon installation, "Menu", "Users", "Roles" and "Permissions" pages will be created. Each user have roles and each role have permissions.
Manage Menu:
Manage Users and their roles:
Manage Roles and their permissions:
Manage Permissions:
Create super admin user:
php artisan make:super-admin-user
Check permission:
# Check by permission's name
\SolutionForest\FilamentAccessManagement\Http\Auth\Permission::check($name)
# Check by http_path
\SolutionForest\FilamentAccessManagement\Http\Auth\Permission::checkPermission($path)
Get current user:
\SolutionForest\FilamentAccessManagement\Facades\FilamentAuthenticate::user();
#Advance Usage
In default, the menu created will co-exist with the original menu of filament. To override the original menu with the menu from this package, modify /config/filament-access-management.php as following:
- Set
filament.navigation.enabled => true
'filament' => [
...
'navigation' => [
/**
* Using db based filament navigation if true.
*/
'enabled' => true,
/**
* Table name db based filament navigation.
*/
'table_name' => 'filament_menu',
/**
* Filament Menu Model.
*/
'model' => Models\Menu::class,
]
...
]
#Changelog
Please see CHANGELOG for more information on what has changed recently.
#Contributing
Please see CONTRIBUTING for details.
#Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
#Credits
#License
The MIT License (MIT). Please see License File for more information.