These instructions will help you install JIRA on JBoss 4.
If you're having problems, see Getting Help.
On this page:
- 1. Unpack JIRA
- 2. Configure JBoss
- 3. Configure the JIRA webapp
- 4. Set JIRA Home
- 5. Build JIRA
- 6. Deploy the WAR in JBoss
- 7. Set mail.mime.decodeparameters
- 8. Start JBoss
- User-contributed notes
1. Unpack JIRADownload and unzip JIRA (but not with XP's unzipper nor the default tar utility on Solaris). Ensure that you download the WAR/EAR version, not the Standalone version that is recommended on the Downloads page.
A new directory containing JIRA will be created, hereafter referred to as
2. Configure JBoss
The application server (JBoss) is responsible for establishing a database connection, and making it available to webapps like JIRA as a "DataSource". DataSources are configured in XML files under JBoss'
2.1. Configure the datasource
For production use, you should configure JBoss to provide a datasource for an external database like PostgreSQL or MySQL. DataSources are configured in XML files under
server/default/deploy/. Create a new file,
Here we have created a DataSource called 'JiraDS'. Change the connection-url and other details as required for your database (the database configuration guides show the correct connection-url and driver-class entry formats). Note:
max-pool-size are used to configure the minimum and maximum connection pool sizes respectively.
2.2. Add the JDBC driver
Download the right JDBC driver for your database (again, see the relevant database configuration guide for where to get it). Copy the driver's jar file in JBoss'
servers/default/lib directory. If you are using the built-in HSQLDB database, the JDBC driver (hsqldb.jar) is already present.
3. Configure the JIRA webapp
The following steps assume that you have the JIRA WAR/Webapp distribution.
3.1. Modify transaction factory attributes
edit-webapp/WEB-INF/classes/entityengine.xml file, and change:
For JBoss 4.0.1 and 4.0.2, use UserTransaction rather than ClientUserTransaction.
3.2. Specify database type and JNDI path
You now need to make changes to the
entityengine.xml file to specify the database type and JNDI path. These changes will differ, depending on whether you are using HSQLDB or an external database (not HSQLDB). Go to the bottom of
edit-webapp/WEB-INF/classes/entityengine.xml where the database type and datasource JNDI location are specified:
For HSQLDB (using the built-in datasource from Â§1.1) all you need to do is replace
For external databases (not HSQLDB):
field-type-nameappropriately for your database.
- If necessary, adjust
schema-nameappropriately your database.
4. Set JIRA HomeTo specify the location of your JIRA Home Directory (note that you need to do this before you build JIRA):
- Edit the
jira-application.propertiesfile (see the JIRA Installation Directory page to find where this file is located), add a 'jira.home' property and set it to your desired location for the JIRA home directory. Please use forward-slashes ("/"), not back-slashes ("\").
Please note that you cannot use the same JIRA home directory for multiple instances of JIRA. We recommend that you do not specify your JIRA home directory to be inside your installation directory, to prevent information from being accidentally lost during major operations (e.g. backing up and restoring instances).
5. Build JIRA
Now build a JIRA webapp by typing
build (Windows) or
./build.sh (Unix) on the command line, in the directory where you originally extracted JIRA to. This will produce a deployable WAR file in the
6. Deploy the WAR in JBoss
Copy and rename
server/default/deploy/jira.war in JBoss.
7. Set mail.mime.decodeparametersThe following system property must be set in order for the JIRA mail handler to work correctly with emails from RFC 2231-compliant mail clients:
System properties are set in different ways depending on your application server.
8. Start JBoss
Stop and start JBoss to fully deploy the new JIRA webapp. Watch the startup logs for errors.
Once JBoss has started, JIRA should be accessible at
http://localhost:8080/jira/ (change the host and port as needed; the 'jira' part is whatever the WAR name is).
Have experiences to share with JBoss and JIRA? We welcome your thoughts. Please see the user-contributed JBoss 4 notes.