acdphp/laravel-schedule-police

Laravel Schedule Police

Use this if you need to:

• :white_check_mark: Stop and start scheduled commands without redeploying.
• :white_check_mark: Execute commands without going into server console.
• :white_check_mark: Keep the visibility, control, and reviewability of the schedule configurations in your codebase.

Compatibility Matrix

Installation

1. Install the package

   composer require acdphp/laravel-schedule-police
   

2. Run the migration.

   php artisan migrate
   

3. Publish assets

   php artisan vendor:publish --tag=schedule-police-assets --force
   

Config

You may override the config by publishing it.

php artisan vendor:publish --tag=schedule-police-config

You may also just define environment variables if you don't need to publish the config.

• Disable command execution in the dashboard.

SCHEDULE_POLICE_ALLOW_EXECUTE_CMD=false

• Add prefix to routes.

SCHEDULE_POLICE_URL_PREFIX=your-prefix

Dashboard

After installation, you may access the dashboard via the /schedule-police route.

Authorization

By default, you will only be able to access this dashboard in the local environment. However, you may specify authorization for non-local environments by defining viewSchedulePolice gate, typically within the boot method of the App\Providers\AuthServiceProvider class.

public function boot(): void
{
    Gate::define('viewSchedulePolice', function (User $user) {
        // return true or false
    });
}

Screenshots

Events list page

Execute page

Testing

composer test

# with docker-compose
docker-compose run --rm test-php84

Linting and static analysis

composer lint

# with docker-compose
docker-compose run --rm lint

Lint Fix

composer lint-fix

# with docker-compose
docker-compose run --rm lint-fix

License

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