README

Support Opscale

At Opscale, we’re passionate about contributing to the open-source community by providing solutions that help businesses scale efficiently. If you’ve found our tools helpful, here are a few ways you can show your support:

⭐ Star this repository to help others discover our work and be part of our growing community. Every star makes a difference!

💬 Share your experience by leaving a review on Trustpilot or sharing your thoughts on social media. Your feedback helps us improve and grow!

📧 Send us feedback on what we can improve at feedback@opscale.co. We value your input to make our tools even better for everyone.

🙏 Get involved by actively contributing to our open-source repositories. Your participation benefits the entire community and helps push the boundaries of what’s possible.

💼 Hire us if you need custom dashboards, admin panels, internal tools or MVPs tailored to your business. With our expertise, we can help you systematize operations or enhance your existing product. Contact us at hire@opscale.co to discuss your project needs.

Thanks for helping Opscale continue to scale! 🚀

Description

Secure your Nova resources with roles and permissions.

One of the most basic needs for a dashboard is differentiated user access, allowing each profile to manage and view specific information. Confidently manage access to your data with roles and permissions.

Installation

You can install the package in to a Laravel app that uses Nova via composer:

composer require opscale-co/nova-authorization

Next up, you must register the tool with Nova. This is typically done in the tools method of the NovaServiceProvider.

// in app/Providers/NovaServiceProvider.php
// ...
public function tools()
{
    return [
        // ...
        new \Opscale\NovaAuthorization\Tool(),
    ];
}

This package uses Spatie Permissions internally to manage roles and permissions structure. Follow the installation instructions for this package.

Then modify the following items in Spatie permissions configuration file (permissions.php):

• 'permission' => Opscale\NovaAuthorization\Models\Permission::class,
• 'role' => Opscale\NovaAuthorization\Models\Role::class,
• 'register_permission_check_method' => false,
• 'events_enabled' => true,

Important

This packages uses its own cache strategy, so we need to disable the default behavior with register_permission_check_method.

Then add the roles relationship to your User resource:

// in app/Nova/User.php
// ...
use Opscale\NovaAuthorization\Nova\Fields\RoleTag;

public function fields(NovaRequest $request): array
{
    return [
        // ...
        RoleTag::make(__('Roles'))
            ->hideFromIndex(),
    ];
}

Important

Use RoleTag instead of Nova's Tag field for roles. RoleTag uses Spatie's assignRole() and removeRole() methods internally, ensuring that RoleAttached and RoleDetached events are fired. Nova's default Tag field uses sync() directly on the relationship, bypassing the event system and preventing cache invalidation.

Usage

You will see a "Roles" item in your menu by default. You can create your roles here and assign them to users.

You can also automate the initial permissions setup using our built-in commands:

• php artisan create-permissions to automatically read all your resources and create the related permissions
• php artisan create-role to create a role assigning the selected permissions
• php artisan assign-role to assign an existing role for an user
• php artisan clear-cache to clear the permissions cache for users

Custom policies

This package create a dynamic Policy class for each Model class associated to your Nova app resources. If you want to use authorization for other resources or modify the logic for your resources, you can create your own policy and register it in nova-authorization config file.

Cache

Important

This package caches the permissions for each user, the cache last 24 hours and it's flushed any time a role is attached or detached from an user or a permission is attached or detached from a role.

If you want to avoid caching permission you can disable this behavior in nova-authorization config file.

Testing

npm run test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email development@opscale.co instead of using the issue tracker.

Credits

• Opscale

License

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