wwwision/neos-jobqueuemodule

Flowpack.JobQueue 包的 Neos 后端模块

1.1.0 2022-11-21 13:29 UTC

This package is auto-updated.

Last update: 2024-09-21 17:12:17 UTC


README

Neos 后端模块,用于 Flowpack.JobQueue.Common 包。

使用方法

通过 composer 安装包

composer require wwwision/neos-jobqueuemodule

然后导航到新的 jobs 模块,位于 /neos/administration/jobs

注意:如果认证用户没有 Neos.Neos:Administrator 角色,则需要授权权限以访问 JobQueue 后端模块(见下文)。

配置

该包不需要任何特定设置,因为行为是通过相应的权限确定的

访问控制

默认情况下,具有 Neos.Neos:Administrator 角色的用户将具有对模块和所有配置的 JobQueues 的访问权限。要授予编辑角色对特定队列的访问权限,可以通过 Policy.yaml 授予权限。

通常,用户需要访问 administration 模块以及 administration/jobs 子模块

roles:
  'Some.Package:SomeEditorRole':
    privileges:
      - privilegeTarget: 'Neos.Neos:Backend.Module.Administration'
        permission: GRANT
      - privilegeTarget: 'Wwwision.Neos.JobQueueModule:Module'
        permission: GRANT

示例 1:对特定队列的读取访问

要授予角色对特定 Job Queue 的读取访问权限,可以授予 Queues.Specific.Access 权限

roles:
  'Some.Package:SomeEditorRole':
    privileges:
      # ...
      - privilegeTarget: 'Wwwision.Neos.JobQueueModule:Queues.Specific.Access'
        parameters:
          queue: 'Some.Queue:Name'
        permission: GRANT

使用此 Policy.yaml,对应角色的用户将如果配置了 Some.Queue:Name,则可以访问队列。

示例 1a:授予从特定队列删除消息的权限

为了允许用户从队列中删除挂起的消息(即标记为 完成),可以额外授予 Queues.Specific.FinishMessages 权限

roles:
  'Some.Package:SomeEditorRole':
    privileges:
      # ...
      - privilegeTarget: 'Wwwision.Neos.JobQueueModule:Queues.Specific.FinishMessages'
        parameters:
          queue: 'Some.Queue:Name'
        permission: GRANT

示例 2:对所有队列的读取访问

使用 Queues.Any.Access 权限可以一次性授予对所有队列的访问权限

roles:
  'Some.Package:SomeEditorRole':
    privileges:
      # ...
      - privilegeTarget: 'Wwwision.Neos.JobQueueModule:Queues.Any.Access'
        permission: GRANT

示例 2a:授予删除所有队列消息的权限

同样,可以授予 Queues.Any.FinishMessages 权限,以允许在所有可访问的队列中完成消息

roles:
  'Some.Package:SomeEditorRole':
    privileges:
      # ...
      - privilegeTarget: 'Wwwision.Neos.JobQueueModule:Queues.Any.FinishMessages'
        permission: GRANT

致谢

此包的开发部分由 brandung GmbH 赞助。感谢您支持开源开发!

贡献

以问题或拉取请求的形式的贡献非常受欢迎。

许可

请参阅 LICENSE