See Favro Jira Proxy for general considerations when using the Favro Jira Proxy.

To use single sign-on authentication you need to be logged in as the user you want the Favro Jira Proxy to connect to jira as. Ideally you should use a VM configured to automatically log in as the user when the OS starts up.

Installing

Prerequisites

You need have Node.js 8 or later in your path. See: https://nodejs.org/en/download/

Download the Favro Jira Proxy:
Windows

Put the Favro Jira Proxy in a folder writable by the user you are logged in as (the user you want the Favre Jira Proxy to authenticate to Jira with).
Start cmd.exe and run:

mkdir "%USERPROFILE%\FavroJiraProxy"
cd /d "%USERPROFILE%\FavroJiraProxy"

Extract the distribution you downloaded in the folder you just created. Change the version number to the version you just downloaded. If you have an older version of Windows installed you might have to download a tool to extract the tar.gz archive. For example 7-Zip.

tar -xf "%USERPROFILE%\Downloads\FavroJiraProxy-1.0.17.tar.gz"

Add the integration to run as a daemon. This will automatically create the necessary files depending on your operating system and then launch the daemon.

FavroJiraProxy.exe --daemon-add --mode user

An icon will appear in your task bar when the Favro Jira Proxy is running.

Configuration

Use your favorite editor to edit the configuration file for the proxy.

cd /d "%USERPROFILE%\FavroJiraProxy"
notepad FavroJiraProxyConfig.json

You can paste this example config as a starting point.

{
	"JiraURL": "https://myjira.example.com:8080/",
	"JiraExtractSessionCookie": true
}

After you have edited the configuration file you need to restart the Favro Jira Proxy for changes to take effect.

FavroJiraProxy.exe --daemon-restart

To check your configuration for errors check the contents of the log file.

type Log\FavroJiraProxy.log

See Sync Jira issues to Favro for how to connect Favro to your Jira Server now that you have configured the Favro Jira Proxy.

Upgrading

To upgrade the server simply stop the daemon extract the new package and start it again.

cd /d "%USERPROFILE%\FavroJiraProxy"
FavroJiraProxy.exe --daemon-stop
tar -xf "%USERPROFILE%\Downloads\FavroJiraProxy-1.0.17.tar.gz"
FavroJiraProxy.exe --daemon-start

You can find more information about our Jira integration on our website.