README

I am unfortunately making the hard decision to archive this package. It's served many of us well over the years, but more and more I've been finding my time stretched thin. As such, I am not able to put in as much focus here in development, documentation, and everything else that goes along with maintaining an open-source package. I can't in good consience leave this as is when so many of you are still using and maybe running in to some issues with things.

As an alternative, I highly recommend Spatie's laravel-permission package as a replacement. It's nearly a drop-in replacement as both Shinobi and laravel-permission hook in to Laravel's core policies system. The Spatie package is well maintained, has great documentation, and a plethora of configuration options.

If for any reason you'd like to continue or pick up where Shinobi has left off, please feel free to fork and do your thing ✌️ that's one of the beauty's of open-source.

Thank you for understanding, Kai

Caffeinated Shinobi

A simple and light-weight role-based permissions system for Laravel's Authorization Gate system. Originally developed for FusionCMS, an open source content management system.

• Every user can have zero or more permissions.
• Every user can have zero or more roles.
• Every role can have zero or more permissions.
• Every role can have one of two special flags, all-access and no-access

Documentation

You will find user friendly and updated documentation on the Caffeinated website.

Installation

Simply install the package through Composer. From here the package will automatically register its service provider and Shinobi facade.

composer require caffeinated/shinobi

Config

To publish the config file, run the following:

php artisan vendor:publish --provider="Caffeinated\Shinobi\ShinobiServiceProvider" --tag="config"

Changelog

You will find a complete changelog history within the CHANGELOG file.

Contributing

Please see CONTRIBUTING for details.

Testing

Run tests with PHPUnit:

vendor/bin/phpunit

Security

If you discover any security related issues, please email shea.lewis89@gmail.com directly instead of using the issue tracker.

Credits

• Shea Lewis
• All Contributors

License

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