README

Bastion is a package/plugin for Filament and Laravel to quickly scaffold out access control for your application.

It's primary use case is with SSO and Azure Active Directory, but it can be used with any authentication provider.

Warning

This package is still in development and is not ready for production use.

Installation

You can install the package via composer:

composer require chrisreedio/bastion

Update your PanelProvider to include the plugin:

$panel
    ->plugins([
        // ... Other Plugins
        \ChrisReedIO\Bastion\BastionPlugin::make(),
    ])

You can publish and run the migrations with:

php artisan vendor:publish --tag="bastion-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="bastion-config"

This is the contents of the published config file:

return [
    'models' => [
        'permission' => \Spatie\Permission\Models\Permission::class,
        'role' => \Spatie\Permission\Models\Role::class,
        'user' => '\App\Models\User',
    ],

    'permissions' => [
        'preload' => true,

    ],

    'default_guard' => 'web',
    'guards' => [
        // value => 'Custom Label'
        'web' => 'Web',
        'api' => 'API',
        // Your other custom guards here
    ],

    'sso' => [
        'enabled' => false,
    ],
];

You can publish the seeder(s) with:

php artisan vendor:publish --tag="bastion-seeders"

Optionally, you can publish the views using

php artisan vendor:publish --tag="bastion-views"

Usage

A super admin role may be defined by using the ->superAdminRole method on the plugin.

$panel
    ->plugins([
        // ... Other Plugins
        \ChrisReedIO\Bastion\BastionPlugin::make()
            ->superAdminRole('Developer'),
	])

Testing

composer test

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

Special thanks to @Althinect and @bezhanSalleh for their packages and hard work. This is both inspired by and based on their work. This package would not be possible without them.

License

The MIT License (MIT). Please see License File for more information.

chrisreedio / bastion

Maintainers

Details