You can connect Stash to an Atlassian JIRA instance to delegate Stash user and group management, and authentication. Choose this option as an alternative to Atlassian Crowd, for simple configurations with a limited number of users. Note that Stash can only connect to a JIRA server running JIRA 4.3 or later. Connecting Stash and JIRA is a 3-step process:
You can connect to JIRA either when you first run Stash, using the Setup Wizard, or at any time after setup is complete. If using the Stash Setup Wizard to configure JIRA integration, we recommend that you make use of the automatic back-linking from JIRA to Stash.
| Related pages: |
Connecting to JIRA
1. Set up JIRA to allow connections from Stash
- Log in as a user with the 'JIRA Administrators' global permission.
- For JIRA 4.3.x, select Other Application from the 'Users, Groups & Roles' section of the 'Administration' menu.
For JIRA 4.4 or later, choose Administration > Users > JIRA User Server. - Click Add Application.
- Enter the application name and password that Stash will use when accessing JIRA.
- Enter the IP address of your Stash server. Valid values are:
- A full IP address, e.g.
192.168.10.12
. - A wildcard IP range, using CIDR notation, e.g.
192.168.10.1/16
. For more information, see the introduction to CIDR notation on Wikipedia and RFC 4632.
- A full IP address, e.g.
- Click Save.
- Define the directory order, on the 'User Directories' screen, by clicking the blue up- and down-arrows next to each directory. The directory order has the following effects:
- The order of the directories is the order in which they will be searched for users and groups.
- Changes to users and groups will be made only in the first directory where the application has permission to make changes.
2. Set up Stash to connect to JIRA
- Log in as a user with 'Admin' permission.
- Click Administration in the top menu and then User Directories.
- Click Add Directory and select Atlassian JIRA.
- Enter settings, as described below.
- Test and save the directory settings.
- Define the directory order, on the 'User Directories' screen, by clicking the blue up- and down-arrows next to each directory. The directory order has the following effects:
- The order of the directories is the order in which they will be searched for users and groups.
- Changes to users and groups will be made only in the first directory where the application has permission to make changes.
3. Set up Stash users and groups in JIRA
In order to use Stash, users must be a member of the Stash-users
group or have Stash 'can use' permission. Follow these steps to configure your Stash groups in JIRA:
- Add the
stash-users
andstash-administrators
groups in JIRA. - Add your own username as a member of both of the above groups.
- Choose one of the following methods to give your existing JIRA users access to Stash:
- Option 1: In JIRA, find the groups that the relevant users belong to. Add the groups as members of one or both of the above Stash groups.
- Option 2: Log in to Stash using your JIRA account, click Administration and then Global Permissions. Assign the appropriate permissions to the relevant JIRA groups.
Server settings
Setting | Description |
---|---|
Name | A meaningful name that will help you to identify this JIRA server amongst your list of directory servers. Examples:
|
Server URL | The web address of your JIRA server. Examples:
|
Application Name | The name used by your application when accessing the JIRA server that acts as user manager. Note that you will also need to define your application to that JIRA server, via the 'Other Applications' option in the 'Users, Groups & Roles' section of the 'Administration' menu. |
Application Password | The password used by your application when accessing the JIRA server that acts as user manager. |
JIRA server permissions
Setting |
Description |
---|---|
Read Only |
The users, groups and memberships in this directory are retrieved from the JIRA server that is acting as user manager. They can only be modified via that JIRA server. |
Read/Write |
The users, groups and memberships in this directory are retrieved from the JIRA server that is acting as user manager. When you modify a user, group or membership, the changes will be applied directly to your application and to the JIRA server that is acting as user manager. |
Advanced settings
Setting | Description |
---|---|
Enable Nested Groups | Enable or disable support for nested groups. Before enabling nested groups, please check to see if nested groups are enabled on the JIRA server that is acting as user manager. When nested groups are enabled, you can define a group as a member of another group. If you are using groups to manage permissions, you can create nested groups to allow inheritance of permissions from one group to its sub-groups. |
Enable Incremental Synchronisation | Enable or disable incremental synchronisation. Only changes since the last synchronisation will be retrieved when synchronising a directory.. |
Synchronisation Interval (minutes) | Synchronisation is the process by which the application updates its internal store of user data to agree with the data on the directory server. The application will send a request to your directory server every x minutes, where 'x' is the number specified here. The default value is 60 minutes. |