Documentation for JIRA 4.4. Documentation for other versions of JIRA is available too.

Skip to end of metadata
Go to start of metadata
Gliffy Zoom Zoom

After you have installed JIRA Standalone or WAR and have accessed its URL (eg. http://localhost:8080 or http://localhost:8080/jira) for the first time, you will be presented with a brief Setup Wizard to configure JIRA.

On this page:

Step 1 of 4: Database Configuration

The first page of the Setup Wizard is shown below.

On this page you can choose between connecting JIRA to:

  • The internal database — used for evaluating JIRA only or
  • An external database — used for running JIRA in a production environment.

You can also choose the language you would like the JIRA user interface to appear in by clicking the relevant flag.
(info) Be aware that some languages may have more comprehensive translations than others.

Connecting to an External Database

If you choose to connect JIRA to an external database by clicking the 'External' radio button, you will be presented with a number of database configuration options.

(info) Your external database must be a newly-created (or empty) database. For more information on creating a database, refer to step 2 (for creating/configuring a database) of the appropriate documentation for your database:

To configure your external database connection:

  1. Choose the type of database server (running your new JIRA database) in the 'Database Type' field. Your database configuration options will change depending on your chosen 'Database Type'.
  2. The fields on this page of the Setup Wizard are identical to those on the JIRA Configuration Tool (included with JIRA Standalone distributions) when configuring your database connection. For details on configuring these fields for your external database, refer to step 3 of section 4.1 (Using the JIRA Configuration Tool) of the appropriate documentation:

(warning) Please Note:

  • In the Setup Wizard, JIRA expects that the external database it connects to is empty. You will not be able to proceed if JIRA detects that your external database contains any existing data.
  • You cannot configure your database connection pool size through the Setup Wizard. You can do this subsequently using the JIRA Configuration Tool (for JIRA Standalone only) or by manually configuring your database connection (described on each specific database configuration guide). See Connecting JIRA to a Database for details.

Step 2 of 4: Application Properties

On this page you can configure some of JIRA's settings and enter your license key. For more details on the settings and what they mean, see Configuring JIRA Options.

JIRA will store your automated backups, file attachments and indexes within your JIRA Home Directory.

(info) If you have an existing XML backup of a JIRA site, you can import it into your new JIRA installation at this point by clicking the top 'import your existing data' link. See Restoring Data for details on using this feature.

License Key

You are required to enter a valid license key before you can use JIRA. You can obtain an evaluation license key which will allow JIRA to run unrestricted for 30 days. To use your existing license key or obtain a new license key, follow the steps below:

  1. Do either of the following:
    • If you are a new user/customer, click the 'generate an evaluation key' link to do just that.
      OR
    • If you are an existing customer and have an existing JIRA license, click the 'you can retrieve it' link to retrieve your existing license.
  2. Once you have either created an account or logged in with an existing account, the 'Licenses' page will appear.
    (info)If you logged in with an existing account, a list of your existing Atlassian product licenses will be shown. If you do not have any existing JIRA licenses, generate a new one by:
    • Clicking on the 'New Evaluation License' link,
    • Selecting 'JIRA' for the 'Product' field,
    • Completing the remaining fields and
    • Clicking the 'Generate License' button to generate your new evaluation license.
      You will be taken back to the 'License' page again.
  3. On the 'Licenses' page, copy the new evaluation license key to your clipboard and paste it into the 'License Key' field of the Setup Wizard.

Step 3 of 4: Administrator Account

After completing the second step, the third page of the wizard sets up an administrator account.

Once this initial administrator account is created, that administrator can then create other administrators.

Step 4 of 4: Email Notification

The last page of the Setup Wizard allows you to configure the outgoing emails from JIRA.

To enable or disable email notifications (you can always enable them later), select the respective Enable or Disable radio buttons.

If you enable email notifications, you will need to set up a connection to a mail server, as indicated in the following screenshot.

You're done!

Once you complete step 4, JIRA should be set up and ready for use.

Click 'log in to JIRA' to start using JIRA!

For information on getting started with JIRA, please refer to the following guides:

Also note that you can click the help icon (yellow question-mark) in the upper right-hand corner at any time for further information.

Additional Notes

(warning) Due to a known issue in JIRA 4.4.0, the Setup Wizard currently does not add an important MySQL setting to JIRA's database configuration, which is required to avoid data corruption. To work around this issue:

  1. Close the Setup Wizard's browser window/tab now and stop JIRA.
  2. Configure JIRA to connect to MySQL (outside the Setup Wizard) as described on the Connecting JIRA to MySQL page.
  3. Restart JIRA. The Setup Wizard will start from Step 2 (above), since JIRA will have already detected your existing database configuration.

(info) If you are using JIRA 4.4.1 or later, you do not need to worry about adding this parameter as this issue has been addressed.