Skip to content

Commit

Permalink
Merge pull request #1454 from Codium-ai/hl/jira_datacenter_docs
Browse files Browse the repository at this point in the history
documentation
  • Loading branch information
hussam789 authored Jan 15, 2025
2 parents 2d9141a + d0c442b commit 1997da3
Showing 1 changed file with 38 additions and 2 deletions.
40 changes: 38 additions & 2 deletions docs/docs/core-abilities/fetching_ticket_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 1997da3

Please sign in to comment.