Before you start

In order to connect TestFairy to JIRA Server that is installed on-prem, start by installing TestFairy Connect

Configuring TestFairy Connect with JIRA Server

This guide explains how to configure the TestFairy Connect agent to work with an on-premise JIRA using basic-authentication (user/password-token) or OAuth.

Using the wizard

Start the wizard by typing the following command in your terminal or command prompt:

$ testfairy-connect configure

Welcome to TestFairy Connect configuration wizard.

  • What is your TestFairy API Key?

    Please put your Upload API key here, you can access it via the Settings Page

  • What kind of issue tracking system will you use with TestFairy Connect?

    Choose "JIRA"

  • What is your JIRA URL (e.g.

    Please provide the url address of your JIRA server. Don't forget to include the http:// or https:// prefix.

  • How shall TestFairy Connect authenticate to JIRA?

    Please choose "basic"

  • What is the type of JIRA issues to be created using TestFairy Connect?

    Please choose to appropriate issuetype used in your JIRA. By default, JIRA uses "Bug", but it varys on project type. Other examples are "Defect" or "Task".

  • JIRA username:

    Please enter your JIRA login username

  • JIRA password:

    And your JIRA login password

  • Please enter HTTP proxy server address, leave empty if none:

    If you require HTTP proxy to access this JIRA server, please send it here. For example, http://user@


When done, the configuration wizard will display the success message: Successfully connected to issue tracker.

Congratulations, you have successfully configured TestFairy Connect with JIRA using basic authentication. Next, start the agent from command line

Configure JIRA with OAuth

Access token & secret generation:

  1. Obtain a keypair:

    openssl genrsa -out jira_rsa 2048
    openssl rsa -in jira_rsa -pubout >
  2. Configure JIRA the Application Link for TestFairy Connect integration.
    In your browser, go to your JIRA Admin page, like http://localhost:2990/jira/plugins/servlet/applinks/listApplicationLinks.
    Enter 'url' or any string to use for Application Link identification.

    Create an Application Link

    In the next screen, click 'Continue'.


    Setup Application Link

    • Application Name: TestFairy
    • Application Type: Generic Application
    • Service Provider Name: TestFairy
    • Consumer Key: testfairy-connect
    • Shared Secret: [paste public key contents here]
    • Request Token URL: /plugins/servlet/oauth/request-token
    • Request Token URL: /plugins/servlet/oauth/access-token
    • Request Token URL: /plugins/servlet/oauth/authorize

      Verify Access Token

  3. Run the token generation script found here. Right-click to copy .js file path.

    wget [paste file path here]
    npm install oauth
    node oauth.js
  4. Update your config.json with access_token and access_token_secret.

  5. (optional) Install the TestFairy Chrome Extension

The TestFairy Chrome Extension is available here. With this Chrome extension, every JIRA issue that has a link to a TestFairy session will contain the right TestFairy session, timeline, logs, and crash reports enbedded in the JIRA issue.

Last updated on 2023-05-23