Skip to content

Commit

Permalink
Fixed README
Browse files Browse the repository at this point in the history
  • Loading branch information
bgaidioz committed Feb 18, 2025
1 parent b3bf541 commit cd44399
Showing 1 changed file with 5 additions and 21 deletions.
26 changes: 5 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,13 @@
# DAS Jira
[![License](https://img.shields.io/:license-BSL%201.1-blue.svg)](/licenses/BSL.txt)

## How to use

First you need to build the project:
```bash
$ docker build -t das-jira:latest .
```

This will create a docker image with the name `das-jira`.

Then you can run the image with the following command:
```bash
$ docker run -p 50051:50051 das-jira:latest
```

You can find the image id by looking at the sbt output or by running:
```bash
$ docker images
```
[Data Access Service](https://github.com/raw-labs/protocol-das) for [Jira](https://www.atlassian.com/software/jira).

## Options

| Name | Description | Default | Required |
|-------------------------|--------------------------------------------------------------------|---------|----------|
| `base_url` | Jira base url | | Yes |
| `personal_access_token` | API PAT for self hosted Jira instances | | Yes |
| `base_url` | Jira base URL | | Yes |
| `personal_access_token` | API PAT for self hosted Jira instances | | No |
| `token` | API token for user's Atlassian account. | | Yes |
| `uesrname` | Email address of agent user who have permission to access the API. | | Yes |
| `username` | Email address of agent user who have permission to access the API. | | Yes |

0 comments on commit cd44399

Please sign in to comment.