Page tree

You are on the Xray Server documentation. If you are looking for Xray Cloud documentation, you can find it in this page

Skip to end of metadata
Go to start of metadata

After installing Xray, you are ready to start managing tests in Jira effectively and ensure that your project requirements get delivered right. Just follow our quick setup instructions.

Xray comes pre-configured with default values that make sense for most organizations, but it has many options that will allow you to adapt it to your testing process.

In this section

The child pages are organized by common configuration actions that can be performed by project or Jira administrators.

There are several ways to configure Xray:

  • Directly using Jira configuration and settings: Since Xray uses Jira issues, you are able to configure the issue screens and add custom fields to your test-related issues, in case you want to customize it even further.
  • Using Project Settings: At the project level, besides settings related to Test Step and Test Run custom fields,  Xray provides also a couple of actions that will allow project administrators to configure the Xray issue types and screens automatically and also the test coverage.
  • Using Global Xray Administration Settings: Here is where the majority of Xray settings live. Most of these settings will affect all testing projects within the Jira instance and need to be configured by a Jira administrator.

Get it running - first steps


Please take a look at Project Organization Use Cases to learn more about how to create and enable projects for Xray. It also explains how to set up your project, i.e., whether you should split the test requirements into distinct projects or not.

Project Settings

Some project-level settings are also provided by Xray:

Administration Settings

Xray is configured in the Jira Administration > Manage Apps > Xray.

The following administration pages are provided:











  • No labels