Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 3.4 KB

tf-connect.md

File metadata and controls

74 lines (50 loc) · 3.4 KB
Raw
id title sidebar_label
tf-connect
TestFairy Connect
TestFairy Connect

import useBaseUrl from '@docusaurus/useBaseUrl'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

TestFairy Connect is a proxy server designed to facilitate the connection between your bug-tracking system (Jira Server) behind a firewall and the TestFairy cloud. By installing TestFairy Connect on-premise, companies can securely integrate their bug-tracking systems with TestFairy's web app, allowing for efficient and streamlined bug tracking and reporting.

You can install TestFairy Connect via a Docker image.

How does it work?

The core component of TestFairy Connect is the agent service. This service operates on a system within your firewall and establishes connections between TestFairy's web app and your bug-tracking system. Through this connection, bug reports and relevant data can be seamlessly exchanged between the two platforms:

<img src={useBaseUrl('/img/testfairy/testing-an-app/bug-tracking/0-overview.png')} alt="Overview"/>

Installation

To install TestFairy Connect, follow the steps below. The installation process is required only once, and the Docker will automatically download the latest version:

docker run -i -t -v $PWD:/etc/testfairy-connect testfairy/testfairy-connect:latest configure

:::note You can replace $PWD with a directory of your choice to store your TestFairy Connect configuration. :::

If there are no issues, you can follow the interactive configuration wizard displayed on the screen.

Configuring TestFairy Connect

Before TestFairy Connect can function correctly, you need to provide specific configuration data. Ensure you have the following information:

  • TestFairy API key. You can find at https://[your-subdomain].testfairy.com/settings/api-key/.
  • The URL to your bug system.
  • In the case of a Jira basic authentication - valid credentials (Username and API Token) for the Jira user.
  • In the case of a Jira OAuth authentication - admin access to Jira/the ability to manage Application Links (as described in the configuration wizard script).

By default, your configuration file config.json is saved to .testfairy-connect under the Dockers Image home directory: ~/.testfairy-connect/config.json.

Running TestFairy Connect

Once you have completed the configuration, TestFairy Connect is ready to run. To start the TestFairy Connect server, use the following command:

docker run -d -v $PWD:/etc/testfairy-connect --restart=always testfairy/testfairy-connect:latest start

:::note You can replace $PWD with a directory of your choice to store your TestFairy Connect configuration. :::

TestFairy Connect will be running in the background, and it is safe to close the ssh connection. Remember that stopping docker or rebooting the server will require you to run the start command again.

Troubleshooting

SELinux

If you have permission errors related to your docker volume, you can attach the volume in relaxed SELinux mode or disable SELinux enforcement entirely.

  • Use these commands to attach volume in relaxed SELinux mode: 
    docker run -i -t -v $PWD:/etc/testfairy-connect:z testfairy/testfairy-connect:latest configure
docker run -d -v $PWD:/etc/testfairy-connect:z --restart=always testfairy/testfairy-connect:latest start
  • Alternatively, you can disable SELinux altogether by running the following: 
    sudo setenforce 0