Add Site Form

Public Site

  1. Provide a Name.
  2. Optionally, check the Auto enable new Jobs checkbox if you want to enable all Jobs on the site by default, including future new jobs.
  3. Select Public accessibility.
  4. Provide the Sync URL that should be used for synchronization and other background actions.
  5. Optionally, provide a Display URL in case the Sync URL is not accessible by users and a different URL should be used in the UI features.
  6. Select an Authentication Method
    • Select Sync Token Authentication to utilise JWT based authentication.
    • This option requires version 4.0.0 of the Jenkins counterpart plugin or higher to be installed! You will also need to provide administrative credentials to register Jira with Jenkins.
    • Select Basic Authentication to utilise username and token based authentication and provide them.
    • If you use and external source (like LDAP, AD or Crowd) for authentication, then provide the API Token as password for the user.
    • The API Token is a password replacing token that users can use to authenticate with against Jenkins. This is mostly useful for users that have there accounts managed outside Jenkins. To get a token for an account, follow these steps:

      • Login on Jenkins using the username and password of the synchronization account
      • Click on the Account Name in the top-right corner of the page after login
      • Then click on the Configure link in the left menu
      • The API Token can now be displayed by clicking on the Show API Token… button

Private Site

  1. Provide a Name.
  2. Optionally, check the Auto enable new Jobs checkbox if you want to enable all Jobs on the site by default, including future new jobs.
    • It is advised that you enable this, since jobs will only become available in Jira after Jenkins notifies Jira of it, and this can time some time depending the build workload on Jenkins.
  3. Select Private accessibility option if your Jenkins site is behind a firewall or otherwise not accessible for job and build synchronization.
  4. Provide the Display URL for UI features.
  5. Save the site and open the Configuration options of the Jenkins site by clicking on the Configuration action of the site.
  6. Follow the instructions in the dialog box to complete the registration of the site.

Next: Getting Started
Docs - Jenkins Integration for Jira

Didn’t find what you were looking for?