Documentation for JIRA 6.3 EAP developer (EAP) releases only. Not using this? See below:
(JIRA 6.2.x documentation | JIRA OnDemand documentation | earlier versions of JIRA)

Skip to end of metadata
Go to start of metadata
This page describes how to set Java properties and options on startup for JIRA.

On this page:

Linux

To Configure System Properties in Linux Installations,
  1. From <jira-install>/bin (or <Tomcat-home>/bin for JIRA WAR installations), open setenv.sh.
  2. Find the section JVM_SUPPORT_RECOMMENDED_ARGS=
  3. Refer to the list of parameters below.

(info) Add all parameters in a space-separated list, inside the quotations.

Windows (starting from .bat file)

To Configure System Properties in Windows Installations When Starting from the .bat File,
  1. From <jira-install>/bin (or <Tomcat-home>/bin for JIRA WAR installations), open setenv.bat.
  2. Find the section set JVM_SUPPORT_RECOMMENDED_ARGS=
  3. Refer to the list of parameters below.

(info) Add all parameters in a space-separated list, inside the quotations.

Windows Service

There are two ways to configure system properties when starting Running JIRA as a Service, either via command line or in the Windows Registry

Setting Properties for Windows Services via Command Line

Setting Properties for Windows Services via Command Line
  1. Identify the name of the service that JIRA is installed as in Windows ( Control Panel > Administrative Tools > Services ):

    (info) In the above example, the SERVICENAME is: JIRA231112155942
  2. Open the command window from Start >> Run >> type in 'cmd' >> Enter
  3. cd to the bin directory of your JIRA Installation Directory (or the bin directory of your Tomcat installation if your are running JIRA WAR).
  4. Run:

    (info) In the above example, it would be tomcat7w //ES//JIRA231112155942

  5. Click on the Java tab to see the list of current start-up options:
  6. Append any new option on its own new line by adding to the end of the existing Java Options. Refer to the list of parameters below.

 

Setting Properties for Windows Services via the Windows Registry

In some versions of Windows, there is no option to add Java variables to the service. In these cases, you must add the properties by viewing the option list in the registry.

To Set Properties for Windows Services via the Windows Registry,
  1. Go to Start >> Run, and run "regedit32.exe".
  2. Find the Services entry:
    32-bit: HKEY_LOCAL_MACHINE >> SOFTWARE >> Apache Software Foundation >> Procrun 2.0 >> JIRA
    64-bit: HKEY_LOCAL_MACHINE >> SOFTWARE >> Wow6432Node >> Apache Software Foundation >> Procrun 2.0 >> JIRA
  3. To change existing properties, especially increasing Xmx memory, double-click the appropriate value.
  4. To change additional properties, double-click options.
  5. Refer to the list of parameters below. Enter each on a separate line.

Verifying Your Settings

To verify what settings are in place, check the <jira-home>/logs/atlassian-jira.log or catalina.out file. A section in the startup appears like this:

This display is also available by Viewing your System Information.

List of Startup Parameters

Memory Property

Notes

Related Pages

-Xmx
-Xms
XX:MaxPermSize

These properties are pre-existing. See related pages for instructions.

Increasing JIRA Memory

-XX:+PrintGCTimeStamps -verbose:gc -Xloggc:gc.log -XX:+HeapDumpOnOutOfMemoryError

Set these for Garbage Collection tuning.

Using Garbage Collection Logs to Analyze JIRA Performance
Using Memory Dumps to Analyze OutOfMemoryErrors

-agentlib:yjpagent=onexit=memory,dir=/path/to/write/snapshots

 

Profiling Memory and CPU Usage with YourKit

Mail Property

Notes

Related Pages

-Datlassian.mail.senddisabled
-Datlassian.mail.fetchdisabled
-Datlassian.mail.popdisabled

Set to 'true' to disable mail. In Linux setenv.sh, there is a pre-existing flag to uncomment.

Migrating JIRA to Another Server
Notifications Are Issued for Incorrect Issues

-Dmail.debug

If set to "true", logs statements related to mail

Configuring JIRA's SMTP Mail Server to Send Notifications
Creating Issues and Comments from Email

-Dmail.mime.decodetext.strict

 

Unable to Decode Mail Subject or Body when Creating Issue From Email

-Dmail.imap.auth.plain.disable
-Dmail.imaps.auth.plain.disable

 

Authenticate Failed Error when Connecting to Exchange

-Dmail.imap.starttls.enable

 

'javax.mail.MessagingException No login methods supported' Due to IMAP over SSL

-Dmail.mime.decodeparameters

Sets mail handler to work correctly with emails from RFC 2231-compliant mail clients.

Installing JIRA WAR-EAR JIRA 4.0 Upgrade Guide

-Dmail.smtp.localhost

 

Problems Sending Email from JIRA - EHLO requires domain address

Encoding Property

Notes

Related Pages

-Dfile.encoding

Set to utf-8 for encoding consistency

Integrating JIRA with CVS and ViewCVS
Characters Not Supported by ASCII are Being Displayed as Question Marks
Internationalisation and Encoding Troubleshooting
SQL Exception while Updating Issues or Importing Data in JIRA with MySQL Due to Encoding
International Characters in Notification Email Subject Lines Are Being Replaced with Question Mark

Other Properties

Notes

Related Pages

-Duser.timezone

 

Incorrect Times Displayed in JIRA

-Dsvnkit.http.methods

Values include Basic,Digest,Negotiate,NTLM

JIRA Startup Fails Due to 'java.lang.SecurityException Unable to locate a login configuration'
Subversion Plugin Displays 'An unknown error occurred - actions == null' Due to SVN Authentication

-Dorg.apache.jasper.runtime.BodyContentImpl.LIMIT_BUFFER

false

OutOfMemory Due to Tomcat Memory Leak
JRA-10145

-ea/-da

Enable/Disable assertions

java.lang.AssertionError When Sending Mail Via SMTP

-Djava.net.preferIPv4Stack

 

SocketException to Announce 'Invalid argument' for an Available Port

-Djavax.net.ssl.trustStore

 

Connecting to SSL services
Unable to Send Email 'javax.net.ssl.SSLException' Due to SMTP Server via SSL

-Djava.awt.headless

Ships with true by default. Allows thumbnail generation.

 

-Dhttp.proxyHost

-Dhttp.proxyPort

-Dhttps.proxyHost

-Dhttps.proxyPort

Outbound Proxy Server hostname and portHow to Configure an Outbound HTTP and HTTPS Proxy for JIRA

  • No labels

13 Comments

  1. Anonymous

    What do you mean?

    /bin/setenv.sh

    You can see that at the very beginning of this article.

    Or am I missing something, perhaps?

    1. Anonymous

      $CATALINA_HOME/bin/setenv.sh

      This file does not exist so it needs to be created. If you look in $CATALINA_HOME/bin/catalina.sh you will see that this file will be included if it does exist.

  2. I am trying to install Jira 4.3.1 onto a brand new Windows XP machines and getting

    a "java.lang.OutOfMemoryError: PermGen space" error almost immediatley! NOT GREAT!

    If think I need to increase "XX:MaxPermSize" but this page does not give EXACT syntax details.

    If I run    tomcat6w.exe //ES/JIRA070411125536   and go the the "Java" tab, then adding

    -DXX:MaxPermSize=512m     doesn't seem to work.

    Can someone please supply an example of the EXACT syntax required.

    Also, should I be using JIRA 4.3.1 yet???

    Thanks,

    Garry

    1. Garry, I think you may have encountered one of the bugs fixed in 4.3.2 — could you please give that a try, and contact http://support.atlassian.com if the problem persists? Many thanks.

  3. Anonymous

    Run "tomcat6w.exe //ES//JIRAnnnnnnn"  (nnnnnnn as shown on the properties screen for
    the JIRA 4.3.1windows service.

    Select the Java tab and at the end of the Java Options entry field add a new line with:

    -XX:MaxPermSize=512m

    Then click on OK

    Restart (or Start) the JIRA service

  4. I'm using Exchange 2007 and would like to integrate the Create Issues and Comments from Email.  Does anyone know if there are POP3 startup options, similar to that of IMAP, where I can enable TLS and disable plain text authentication?

  5. Hi,

    I'm having an issue with the -Dfile.encoding setting. In the text above it mentions to set this to value utf-8 in the Tomcat-7 documentation it mentions to use "UTF-8" and in other documentation I have read to set it to "utf8".

    I realize that upper/lowercase is important in Java/Tomcat and I can't figure out what the correct way of setting this value is.

    Can anyone shed a light on this?

    thanks,

    Jacques.

  6. Anonymous

    Hi,

    I'm looking at my setenv.sh and I don't have

    JVM_SUPPORT_RECOMMENDED_ARGS=

    In it... Running CentOS release 5.6.

    Anyone got any ideas - experience with this? Am I being daft?

    Cheers,

    Kate

    1. Check 9 rows down.. (smile)

  7. Anonymous

    Step 4 in "Windows Service" service is inconsistent with Step 1. Screenshot in Step 1 shows tomcat5.exe in path to service executable. However, Step 4 says that matching executable to run would be tomcat7w

    1) I think matching executable to run via command line should be tomcat5w (based on screenshot from Step 1)

    2) It needs to be explained that w has to be added to executable name from service path.

  8. Please help me!

    I restart server windows 2003, after JIRA 4.4.4  error not working

    http://i816.photobucket.com/albums/zz86/hungchuc/jiraloi_zpsa2a7cf96.png

    thanks all !

     

  9. Where is -Datlassian.plugins.enable.wait in this documentation? That optioned is mentioned in JIRA System Plugin Timeout While Waiting for Plugins to Enable.

  10. Anonymous

    I am trying to upload a file with Japanese characters onto a JIRA issue. It is running on an HTTPS connection. It works fine on an HTTP connection. On HTTPS it does not get attached. It says "Cannot attach. Unknown server error (500)". How to get it to work?