summaryrefslogtreecommitdiff
path: root/doc/integration/jira/jira_server_configuration.md
blob: 63625dd50655e94d35a6a6aa0a26e0eb19ca1d9b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
---
stage: Ecosystem
group: Integrations
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---

# Jira Server credentials **(FREE)**

To [integrate Jira with GitLab](index.md), you must
create a Jira user account for your Jira projects to access projects in GitLab.
This Jira user account must have write access to your Jira projects. To create the
credentials, you must:

1. [Create a Jira Server user](#create-a-jira-server-user).
1. [Create a Jira Server group](#create-a-jira-server-group) for the user to belong to.
1. [Create a permission scheme for your group](#create-a-permission-scheme-for-your-group).

## Create a Jira Server user

This process creates a user named `gitlab`:

1. Sign in to your Jira instance as a Jira administrator.
1. In the upper right corner of the top menu, go to the gear icon and
   select **User Management**.
1. Create a new user account (`gitlab`) with write access to
   projects in Jira.
   - **Email address**: Jira requires a valid email address, and sends a verification
     email, which is required to set up the password.
   - **Username**: Jira creates the username by using the email prefix. You can change
     this username later.
   - **Password**: You must create a password, because the GitLab integration doesn't
     support SSO, such as SAML. To create the password, visit the user profile, look up
     the username, and set a password.
1. Select **Create user**.

After you create the user, create a group for it.

## Create a Jira Server group

After you [create a Jira Server user](#create-a-jira-server-user), create a
group to assign permissions to the user.

This process adds the `gitlab` user you created to a new group named `gitlab-developers`:

1. Sign in to your Jira instance as a Jira administrator.
1. In the upper right corner of the top menu, go to the gear icon and
   select **User Management**.
1. On the sidebar, select **Groups**.

   ![Jira create new user](img/jira_create_new_group.png)

1. In the **Add group** section, enter a **Name** for the group (for example,
   `gitlab-developers`), and then select **Add group**.
1. To add the `gitlab` user to the `gitlab-developers` group, select **Edit members**.
   The `gitlab-developers` group should be listed in the leftmost box as a
   selected group.
1. In the **Add members to selected group(s)** section, enter `gitlab`.
1. Select **Add selected users**.
   The `gitlab` user appears in the **Group member(s)**
   section.

   ![Jira added user to group](img/jira_added_user_to_group.png)

Next, create a permission scheme for your group.

## Create a permission scheme for your group

After creating the group in Jira, grant permissions to the group by creating a permission scheme:

1. Sign in to your Jira instance as a Jira administrator.
1. In the upper right corner of the top menu, go to the gear icon and
   select **Issues**.
1. On the sidebar, select **Permission Schemes**.
1. Select **Add Permission Scheme**, enter a **Name** and (optionally) a
   **Description**, and then select **Add**.
1. In the permissions scheme list, locate your new permissions scheme, and
   select **Permissions**.
1. Next to **Administer Projects**, select **Edit**.
1. From the **Group** dropdown list, select `gitlab-developers`, and then select **Grant**.

   ![Jira group access](img/jira_group_access.png)

Write down the new Jira username and its
password, as you need them when
[configuring GitLab](configure.md).