diff --git a/docs/docs/core-abilities/fetching_ticket_context.md b/docs/docs/core-abilities/fetching_ticket_context.md index 22c55f3d6..8b9f8cd19 100644 --- a/docs/docs/core-abilities/fetching_ticket_context.md +++ b/docs/docs/core-abilities/fetching_ticket_context.md @@ -120,9 +120,45 @@ jira_api_email = "YOUR_EMAIL" ``` -#### Jira Server/Data Center 💎 +#### Jira Data Center/Server 💎 -Currently, we only support the Personal Access Token (PAT) Authentication method. +##### Local App Authentication (For Qodo Merge On-Premise Customers) + +##### 1. Step 1: Set up an application link in Jira Data Center/Server +* Go to Jira Administration > Applications > Application Links > Click on `Create link` + +![application links](https://www.qodo.ai/images/pr_agent/jira_app_links.png){width=384} +* Choose `External application` and set the direction to `Incoming` and then click `Continue` + +![external application](https://www.qodo.ai/images/pr_agent/jira_create_link.png){width=256} +* In the following screen, enter the following details: + * Name: `Qodo Merge` + * Redirect URL: Enter your Qodo Merge URL followed `https://{QODO_MERGE_ENDPOINT}/register_ticket_provider` + * Permission: Select `Read` + * Click `Save` + +![external application details](https://www.qodo.ai/images/pr_agent/jira_fill_app_link.png){width=384} +* Copy the `Client ID` and `Client secret` and set them in your `.secrets` file: + +![client id and secret](https://www.qodo.ai/images/pr_agent/jira_app_credentionals.png){width=256} +```toml +[jira] +jira_app_secret = "..." +jira_client_id = "..." +``` + +##### 2. Step 2: Authenticate with Jira Data Center/Server +* Open this URL in your browser: `https://{QODO_MERGE_ENDPOINT}/jira_auth` +* Click on link + +![jira auth success](https://www.qodo.ai/images/pr_agent/jira_auth_page.png){width=384} + +* You will be redirected to Jira Data Center/Server, click `Allow` +* You will be redirected back to Qodo Merge PR Agent and you will see a success message. + + +##### Personal Access Token (PAT) Authentication +We also support Personal Access Token (PAT) Authentication method. 1. Create a [Personal Access Token (PAT)](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html) in your Jira account 2. In your Configuration file/Environment variables/Secrets file, add the following lines: