History

Daniil Shakir fdf7b7b284 Add example for matrix-auth version 3.0 (#2174 ) Co-authored-by: Tim Jacomb <21194782+timja@users.noreply.github.com>		2022-11-25 15:04:15 +00:00
..
README.md	Add example for matrix-auth version 3.0 (#2174 )	2022-11-25 15:04:15 +00:00

README.md

matrix-auth-plugin

Requires matrix-auth >= 3.0

There are a couple of built-in authorizations to consider.

anonymous - anyone who has not logged in.
authenticated - anyone who has logged in.

sample-configuration (global matrix)

jenkins:
  authorizationStrategy:
    globalMatrix:
      permissions:
        - "USER:Overall/Read:anonymous"
        - "GROUP:Overall/Administer:authenticated"
        - "USER:Overall/Administer:admin"

Permissions must be defined per line, meaning each line must grant permission to only a single role, and only a single user or group of users.

sample-configuration (project based matrix)

jenkins:
  authorizationStrategy:
    projectMatrix:
      permissions:
        - "View/Delete:authenticated"
        - "View/Read:authenticated"
        - "View/Configure:authenticated"
        - "View/Create:authenticated"
        - "Job/Read:authenticated"
        - "Job/Build:authenticated"
        - "Job/Configure:authenticated"
        - "Job/Create:authenticated"
        - "Job/Delete:authenticated"
        - "Job/Discover:authenticated"
        - "Job/Move:authenticated"
        - "Job/Workspace:authenticated"
        - "Job/Cancel:authenticated"
        - "Run/Delete:authenticated"
        - "Run/Replay:authenticated"
        - "Run/Update:authenticated"
        - "SCM/Tag:authenticated"
        - "Overall/Read:anonymous"
        - "Overall/Administer:authenticated"

Some permissions depends on actual plugin-usage.
For Example: Release/*:authenticated is only available if you use the Release plugin in one of your jobs.

GitHub Authorization

https://plugins.jenkins.io/github-oauth/

You can configure authorization based on GitHub users, organizations, or teams.

username - specific GitHub username.
organization - every user that belongs to a specific GitHub organization.
organization*team - specific GitHub team of a GitHub organization.