wwwision / neos-jobqueuemodule
Neos Backend Module for the Flowpack.JobQueue packages
Fund package maintenance!
bwaidelich
www.paypal.me/bwaidelich
Installs: 5 724
Dependents: 0
Suggesters: 0
Security: 0
Stars: 6
Watchers: 3
Forks: 0
Open Issues: 0
Type:neos-package
Requires
- php: >=7.4
- flowpack/jobqueue-common: ^3.2
- neos/neos: ^7.0 || ^8.0 || dev-master
Requires (Dev)
- roave/security-advisories: dev-latest
README
Neos Backend Module for the Flowpack.JobQueue.Common packages.
Usage
Install package via composer:
composer require wwwision/neos-jobqueuemodule
And navigate to the new jobs
module at /neos/administration/jobs
Note: If the authenticated user doesn't have the Neos.Neos:Administrator
role, you'll need to grant privileges
in order to access the JobQueue backend module (see below).
Configuration
This package doesn't require any specific settings, since the behavior is determined via corresponding privileges:
Access control
Users with the role Neos.Neos:Administrator
will have access to the module and all configured JobQueues by default.
To grant editor roles access to specific queues, privileges can be granted via Policy.yaml.
In general, users need access to the administration
module as well as the administration/jobs
sub module:
roles: 'Some.Package:SomeEditorRole': privileges: - privilegeTarget: 'Neos.Neos:Backend.Module.Administration' permission: GRANT - privilegeTarget: 'Wwwision.Neos.JobQueueModule:Module' permission: GRANT
Example 1: Read access to specific queue
To grant a role read access to a specific Job Queue, the Queues.Specific.Access
privilege can be granted:
roles: 'Some.Package:SomeEditorRole': privileges: # ... - privilegeTarget: 'Wwwision.Neos.JobQueueModule:Queues.Specific.Access' parameters: queue: 'Some.Queue:Name' permission: GRANT
With this Policy.yaml
, users of the corresponding role will have access to a queue Some.Queue:Name
if that's configured.
Example 1a: Grant removing messages of specific queue
In order to allow users to remove pending messages from the queue (i.e. mark them finished
), the Queues.Specific.FinishMessages
can be granted additionally:
roles: 'Some.Package:SomeEditorRole': privileges: # ... - privilegeTarget: 'Wwwision.Neos.JobQueueModule:Queues.Specific.FinishMessages' parameters: queue: 'Some.Queue:Name' permission: GRANT
Example 2: Read access to all queues
With the Queues.Any.Access
privilege access to all queues can be granted at once:
roles: 'Some.Package:SomeEditorRole': privileges: # ... - privilegeTarget: 'Wwwision.Neos.JobQueueModule:Queues.Any.Access' permission: GRANT
Example 2a: Grant removing messages of all queues
Similarly, the Queues.Any.FinishMessages
privileges can be granted to allow finishing of messages in
all accessible queues:
roles: 'Some.Package:SomeEditorRole': privileges: # ... - privilegeTarget: 'Wwwision.Neos.JobQueueModule:Queues.Any.FinishMessages' permission: GRANT
Acknowledgements
The development of this package was partly sponsored by brandung GmbH. Thank you for supporting Open Source development!
Contribution
Contributions in the form of issues or pull requests are highly appreciated.
License
See LICENSE