Atlassian

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

  1. 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.

  2. Within your Jira root directory, edit ./bin/setenv.sh( setenv.bat on Windows)

  3. 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

  4. Restart the Jira server.

Defining the Authenticator configuration directory (Windows)

Steps

  1. 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.

  2. Go to your Jira root directory and edit .\bin\setenv.bat.

  3. At the start of the .\bin\setenv.batfile, 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, where Tomcat9.exebinary 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 to tomcat8 in the command. To find out which version of Tomcat you have, check the documentation for your Atlassian product:

      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 as JIRA123456123456.

      Screen capture of the Services window showing Atlassian Confluence selected.
  4. Restart the Jira server.