Defining the Authenticator configuration directory
Before using the plugin to configure the authenticator, you must define where the plugin will store the configuration settings. This information is stored in an environment variable.
Defining the Authenticator configuration directory (Unix)
Steps
-
Create a directory of your choosing on the Atlassian server. We suggest creating a subdirectory in your Atlassian instance: e.g.
<Atlassian Installation Directory>/pingfederate-settings
The user that is running Jira must have read/write permissions for the created directory.
-
Within your Jira root directory, edit
./bin/setenv.sh
(setenv.bat
on Windows) -
At the top of this file insert the following (modify the actual path to suit your environment):
PINGFEDERATE_ATLASSIAN_DATA_PATH=<Atlassian Installation Directory>/pingfederate-settings; export PINGFEDERATE_ATLASSIAN_DATA_PATH
-
Restart the Jira server.
Defining the Authenticator configuration directory (Windows)
Steps
-
Create a directory of your choosing on the Atlassian server.
You should create a subdirectory in your Atlassian instance, such as
<Atlassian Installation Directory>\pingfederate-settings
. -
Go to your Jira root directory and edit
.\bin\setenv.bat
. -
At the start of the
.\bin\setenv.bat
file, insert the following:Choose from:
-
If Jira or Confluence is running as a standalone service (started using
startup.bat
):set PINGFEDERATE_ATLASSIAN_DATA_PATH=<Atlassian Installation Directory>\pingfederate-settings
-
If Jira or Confluence is started using Windows service, go to Jira’s
bin
directory with a command prompt running as Administrator, whereTomcat9.exe
binary is located and enter the following.tomcat9 //US//<service id> --Environment=PINGFEDERATE_ATLASSIAN_DATA_PATH=<Atlassian Installation Directory>\pingfederate-settings
Depending on your version of Atlassian, you might need to change
tomcat9
totomcat8
in the command. To find out which version of Tomcat you have, check the documentation for your Atlassian product:-
Bundled Tomcat and Java versions for Confluence
-
Bundled Tomcat and Java versions for Jira
To determine your service ID, open
services.msc
and select the Jira or Confluence service. The service ID appears in the details area. A service ID is formatted asJIRA123456123456
. -
-
-
Restart the Jira server.