gitlab-org--gitlab-foss/doc/development/integrations/jira_connect.md

# Setting up a development environment

The following are required to install and test the app:

1. A Jira Cloud instance

   Atlassian provides free instances for development and testing. [Click here to sign up](https://developer.atlassian.com/platform/marketplace/getting-started/#free-developer-instances-to-build-and-test-your-app).

1. A GitLab instance available over the internet

   For the app to work, Jira Cloud should be able to connect to the GitLab instance through the internet.

   To easily expose your local development environment, you can use tools like
   [serveo](https://medium.com/automationmaster/how-to-forward-my-local-port-to-public-using-serveo-4979f352a3bf)
   or [ngrok](https://ngrok.com). These also take care of SSL for you because Jira
   requires all connections to the app host to be over SSL.

## Installing the app in Jira

1. Enable Jira development mode to install apps that are not from the Atlassian Marketplace

   1. Navigate to **Jira settings** (cog icon) > **Apps** > **Manage apps**.
   1. Scroll to the bottom of the **Manage apps** page and click **Settings**.
   1. Select **Enable development mode** and click **Apply**.

1. Install the app

   1. Navigate to Jira, then choose **Jira settings** (cog icon) > **Apps** > **Manage apps**.
   1. Click **Upload app**.
   1. In the **From this URL** field, provide a link to the app descriptor. The host and port must point to your GitLab instance.

      For example:

      ```plaintext
      https://xxxx.serveo.net/-/jira_connect/app_descriptor.json
      ```

   1. Click **Upload**.

   If the install was successful, you should see the **GitLab for Jira** app under **Manage apps**.
   You can also click **Getting Started** to open the configuration page rendered from your GitLab instance.

   _Note that any changes to the app descriptor requires you to uninstall then reinstall the app._
Docs: Realigning scattered EE docs into CE 2019-05-05 20:56:13 -04:00			`# Setting up a development environment`

			`The following are required to install and test the app:`

			`1. A Jira Cloud instance`

Update redirected links to final destination Updating redirected links in the development, install, policy raketasks and university dirs. Should now link to final URL to avoid redirect hops 2019-07-08 20:20:40 -04:00			`Atlassian provides free instances for development and testing. [Click here to sign up](https://developer.atlassian.com/platform/marketplace/getting-started/#free-developer-instances-to-build-and-test-your-app).`
Docs: Realigning scattered EE docs into CE 2019-05-05 20:56:13 -04:00
			`1. A GitLab instance available over the internet`

			`For the app to work, Jira Cloud should be able to connect to the GitLab instance through the internet.`

Change serveo link as it often goes down 2019-09-05 04:59:03 -04:00			`To easily expose your local development environment, you can use tools like`
Add latest changes from gitlab-org/gitlab@master 2020-08-06 11:09:42 -04:00			`[serveo](https://medium.com/automationmaster/how-to-forward-my-local-port-to-public-using-serveo-4979f352a3bf)`
Change serveo link as it often goes down 2019-09-05 04:59:03 -04:00			`or [ngrok](https://ngrok.com). These also take care of SSL for you because Jira`
			`requires all connections to the app host to be over SSL.`
Docs: Realigning scattered EE docs into CE 2019-05-05 20:56:13 -04:00
Update redirected links to final destination Updating redirected links in the development, install, policy raketasks and university dirs. Should now link to final URL to avoid redirect hops 2019-07-08 20:20:40 -04:00			`## Installing the app in Jira`
Docs: Realigning scattered EE docs into CE 2019-05-05 20:56:13 -04:00
			`1. Enable Jira development mode to install apps that are not from the Atlassian Marketplace`

			`1. Navigate to Jira settings (cog icon) > Apps > Manage apps.`
			`1. Scroll to the bottom of the Manage apps page and click Settings.`
			`1. Select Enable development mode and click Apply.`

			`1. Install the app`

			`1. Navigate to Jira, then choose Jira settings (cog icon) > Apps > Manage apps.`
			`1. Click Upload app.`
			`1. In the From this URL field, provide a link to the app descriptor. The host and port must point to your GitLab instance.`

			`For example:`
Add blank lines around code blocks All code blocks should be surrounded by blank lines 2019-07-12 04:09:23 -04:00
Add latest changes from gitlab-org/gitlab@master 2020-03-25 02:07:58 -04:00			```plaintext
Docs: Realigning scattered EE docs into CE 2019-05-05 20:56:13 -04:00			`https://xxxx.serveo.net/-/jira_connect/app_descriptor.json`
			```
Add blank lines around code blocks All code blocks should be surrounded by blank lines 2019-07-12 04:09:23 -04:00
Docs: Realigning scattered EE docs into CE 2019-05-05 20:56:13 -04:00			`1. Click Upload.`

			`If the install was successful, you should see the GitLab for Jira app under Manage apps.`
			`You can also click Getting Started to open the configuration page rendered from your GitLab instance.`

			`_Note that any changes to the app descriptor requires you to uninstall then reinstall the app._`