Step-by-step deployment guide

This version of the gateway is currently compatible with Elimity Insights server versions matching >3.41.0.

1. Setting up a dedicated user in Jira Data Center

As usual, we recommend creating a dedicated user in Jira Data Center for this connector. Don't assign any groups for this user yet, we'll cover that in the next step. Either way, refer to the official documentation for additional information about creating users in Jira Data Center. Having created a new dedicated user, we can now use it to log in and generate a personal access token. Again, the official documentation provides more details on how to do this. Note down the generated token.

2. Setting up a dedicated group in Jira Data Center

To assign the minimal required global permissions in Jira Data Center, we also recommend creating a dedicated group. More specifically, we recommend following these steps:

1. Create a new group

2. Add the dedicated user to the newly created group

3. Grant the following global permissions to the newly created group:

   1. Jira administrators

   2. Browse users

3. Generating a secret token

To make sure your gateway only serves requests from authenticated sources, we need to generate a secret token. You could do this for example with OpenSSL:

$ openssl rand -base64 32

You should use this token to configure the built-in connector. The gateway itself only has to verify this token, so we just need to provide it with a hash (hex-encoded SHA256). You can again use OpenSSL for this step:

$ echo -n 'paste-secret-token-here' | openssl dgst

Note down the resulting hash for later use.

4. Configuring the gateway

To configure your gateway, mount an JSON configuration file at /app/config/config.json with the properties listed below. Refer to the following attachment for a starting point:

154B

config.json

Open

Edit the following properties in this file to configure the gateway to your needs:

Property	Type	Description
personalAccessToken	string	Token you noted down in step 1
restApiBaseUrl	string	Base URL of your Jira Data Center instance's REST API, e.g. https://jira.example.com/rest
secretTokenHash	string	Secret token hash you noted down in step 3

5. Deploying the gateway

Having configured the gateway we can now deploy it so the built-in connector can start importing. Since we distribute the gateway as a Docker image, our recommendation for deployment is to use a CaaS solution like Google Cloud Run or Azure Container Apps. If that's not an option, you can also manually deploy the image on e.g. Windows Server. Refer to our documentation about gateways and import agents for additional details.