jalendport / craft-queuemanager
Job Queue Manager for Craft CMS.
Fund package maintenance!
jalendport
Ko Fi
www.paypal.me/jalenconner
Installs: 62 491
Dependents: 0
Suggesters: 0
Security: 0
Stars: 34
Watchers: 3
Forks: 2
Open Issues: 0
Language:JavaScript
Type:craft-plugin
Requires
- craftcms/cms: ^3.0.0
This package is auto-updated.
Last update: 2023-06-12 19:43:44 UTC
README
Warning
This plugin has been abandoned in favor of the built-in queue manager utility (Craft 3.4.0 and newer).
Queue Manager for Craft CMS 3
Job Queue Manager for Craft CMS.
Installation
Requirements
This plugin requires Craft CMS 3.0.0, or later.
Plugin Store
Log into your control panel and click on 'Plugin Store'. Search for 'Queue Manager'.
Composer
- Open your terminal and go to your Craft project:
cd /path/to/project
- Then tell Composer to load the plugin:
composer require jalendport/craft-queuemanager
- In the Control Panel, go to Settings → Plugins and click the “Install” button for Queue Manager.
Features
- View detailed job information
- Retry or cancel individual jobs
- Retry or cancel the full queue
- Console commands that offer the same functionality as found in the CP
Console commands
Retrying jobs
Individual:
./craft queue-manager/queue/retry id
Full queue:
./craft queue-manager/queue/retry-all
Cancelling jobs
Individual:
./craft queue-manager/queue/cancel id
Full queue:
./craft queue-manager/queue/cancel-all
Overriding Plugin Settings
If you create a config file in your config
folder called queue-manager.php
, you can override the plugin’s settings in the Control Panel. Since that config file is fully multi-environment aware, this is a handy way to have different settings across multiple environments.
Here’s what that config file might look like along with a list of all of the possible values you can override.
<?php return [ 'jobLimit' => 1000, ];
Parameter | Expected Value |
---|---|
jobLimit |
Integer |
Roadmap
Some things to do, and ideas for potential features:
- Cron documentation
- Responsive tables
- Filter results
- Automatically refresh jobs