How to Set Custom Headers in Communication Between Exalate on Jira On-premise and Other Exalate Apps

    This article applies to Exalate Classic only. If you're using the New Exalate experience, please refer to the New Exalate documentation.

    This article describes how to send custom headers from Jira on-premise to the Exalate application which is installed on a separate server.

    Set Custom Headers in an Environment Variable

    You need to add the custom headers to an environment variable in your JIRA_INSTALL directory.

    //Keys and their respective values should be separated by colons (:) and each key/value pair should be separated by an escaped semi-colon (\;)
    //All the headers should be surrounded by single or double quotes
    //The format for the headers you are going to add should be the following:
     
    'key1:value2\;key2:value2'
    1. Add this parameter into the ${JIRA_INSTALL}/bin/setenv.sh file with your custom headers.

      For more information, please read how to set properties and options on Jira startup.

      -Dcom.exalate.sync.headers='key1:value2\;key2:value2'
    2.  Start up your Jira on-premise.
    3.  Run the synchronization as usual. Now requests include the custom headers you've set. 

    Use Custom Headers for Basic Authentication

    //Encode your username and password separated by a colon (:) in Base 64 and put it after "Basic" and a space in the value of your header, like the following example:
    //Aladdin:OpenSesame -> QWxhZGRpbjpPcGVuU2VzYW1l
    
    -Dcom.exalate.sync.headers='Authorization:Basic QWxhZGRpbjpPcGVuU2VzYW1l'