Install

Admin

Use

	Documentation Overview Printable manuals Installation Guide PDF Administration Guide PDF User Guide PDF Local docs (docs XML source) JIRA Installation & Upgrade Guide Requirements Installing JIRA Installing Java Installing JIRA Standalone Installing JIRA WAR/EAR Running the Setup Wizard Connecting JIRA to a Database Database Overview SQL Server MySQL PostgreSQL Oracle DB2 Firebird MaxDB Sybase HSQL Switching databases Configuring JIRA Standalone Running JIRA as a Service Configuring SSL (HTTPS) Installing with Confluence Configuring JIRA WAR/EAR Configuration overview Configuring database storage Server-specific Guides Server Comparison JBoss 4.x JBoss 3.x Jetty OC4J 10.1.3.x+ Orion and OC4J 9.x-10.1.2.x Pramati 3.5 Resin 3 Resin 2.1 Tomcat 6.0 Tomcat 5.5 Tomcat 5.0 Tomcat 4.1 Tomcat 4.0 Weblogic 8.1 and 9.x Websphere 6.x Websphere 5.1 Websphere 5 Other servers Integrating JIRA with a Web Server Integrating with IIS Integrating with Apache Upgrading JIRA Upgrading JIRA Disabling Auto-Export Downgrading JIRA JIRA Administrator's Guide Introduction Getting Help Look and Feel Logo, Colours and Timezone Configuring the default Language Configuring the default Issue Navigator Configuring the default Dashboard Overview of Dashboard Portlets Enabling Portlets and Other Plugins Editing the Announcement Banner Enabling Logout Confirmation Email Email Overview Creating a Notification Scheme Customising Email Content Creating Issues & Comments from Email SMTP configuration User Management Managing Users Managing Groups Managing Project Roles Migrating from Groups to Project Roles Enabling public signup and CAPTCHA Integrating JIRA with LDAP Integrating JIRA with Crowd Configuring Trusted Applications Security Overview Global permissions Project permissions Issue security Project Management Defining a Project Assigning members to Project Roles Defining Project Components Defining Project Versions Creating Release Notes for a Version Configuring Project Keys Configuring Fields and Screens Overview Defining 'Resolution' field values Defining 'Priority' field values Defining 'Status' field values Defining 'Issue Type' field values Associating Issue Types with Projects Translating Resolution/Priority/Status/Type Configuring field behaviour Configuring rich-text renderers Associating behaviour with Issue Types Placing fields on screens Associating screens with Issue Operations Associating screens with Issue Types Creating & configuring Custom Fields Custom Field Overview Adding Custom Fields Configuring Custom Fields Configuring Workflow Workflow Activating Workflow Events Importing from Other Systems Importing from Bugzilla Importing from Mantis Importing from FogBugz Importing from Excel/CSV Moving or Archiving Individual Projects Overview Archiving a project Merging JIRA instances Splitting JIRA instances Integrating with Source Control Integrating with CVS and ViewCVS Integrating with Subversion Integrating with Perforce Integrating with ClearCase Integrating with FishEye Configuration Options & Settings Global Settings Enabling Issue Linking Enabling Sub-tasks Enabling Trackback linking Enabling Time Tracking Enabling File Attachments Enabling Thumbnails for Attachments Server Administration Indexing & Search Backing up Data Automated Backups Restoring Data Database Integrity Checker Increasing memory Performance Tips Database Indexing Precompile JSP pages Logging and Profiling Thread Dump Downgrading (Ent to Pro) Downgrading (Ent to Std) Downgrading (Pro to Std) Using robots.txt with Search Engines Appendix A - Extending JIRA Extension Overview Listeners Services Jelly tags JIRA Toolkit Customising Text Developer Guides JIRA Plugins JIRA RPC Overview Creating a SOAP Client Creating an XML-RPC Client Creating Custom Field Types Custom Workflow Elements Creating new Portlets Creating new Reports More.. JIRA Source Building JIRA from source API Documentation JIRA User's Guide Introduction Concepts What is an Issue? What is a Project? Understanding Workflow Getting Started Exploring the JIRA Dashboard Using Keyboard Shortcuts Managing your User Profile Choosing a Language Changing your Password Working with Issues Creating an Issue Setting Security on an Issue Attaching a Screenshot Editing rich-text fields Logging Work on an Issue Scheduling an Issue Creating a Sub-Task Watching and Voting on an Issue Commenting on an Issue Linking Issues Cloning an Issue Viewing an Issue's FishEye Changesets Modifying Multiple ('Bulk') Issues Searching and Reporting Using Quick Search Using the Issue Navigator Saving Searches ('Issue Filters') Receiving Filter Results via Email Performing Advanced Searches Generating Reports Overview Browsing a Project's Road Map Browsing a Project's Change Log Browsing a Project's FishEye Changesets Browsing a Project's Popular Issues Browsing a Component's Open Issues Browsing a Component's Road Map Browsing a Component's Change Log Browsing a Component's Popular Issues Browsing a Version's Open Issues Browsing a Version's Summary Browsing a Version's Popular Issues Reporting on a Version's Time Tracking Reporting on a Version's Workload Reporting on a User's Workload Reporting on a Field in an Issue Filter Customising the Dashboard Overview Adding the Administration portlet Adding the All Filters portlet Adding the Assigned To Me portlet Adding the Bugzilla search portlet Adding the Calendar portlet Adding the Charting portlet Adding the Filter Statistics portlet Adding the 2D Filter Statistics portlet Adding the In Progress portlet Adding the Introduction portlet Adding the Project portlet Adding the Projects portlet Adding the Project Statistics portlet Adding the Project Table portlet Adding the Quick Links portlet Adding the Road Map portlet Adding the Saved Filter portlet Adding the Text portlet Adding the Voted Issues portlet Adding the Watched Issues portlet

JIRA 3.12.x Documentation

PDF

The JIRA documentation consists of three manuals:

The documentation can also be downloaded as XML source for custom intranet deployments. Documentation for previous versions is also available.

Here are some pointers to get you started:

Not yet downloaded JIRA? You can get it from the JIRA download page.
Setting up or installing JIRA? Start with the requirements and installation guide. Don't forget to set up an external database.
Upgrading JIRA? Find out about the latest features in the release notes, then follow the upgrade documentation.
To learn about JIRA, the best place to start is with the basic concepts of issues and projects.
Having problems or errors with JIRA? See debugging problems.
Looking to extend JIRA? Read extending JIRA or browse the API docs, before consulting the JIRA Development Hub in Confluence. A library of pre-built plugins and extensions is also available.
The Administrator's Knowledge Base should cover any other questions you may have. You may also find the mailing list forums helpful.

Note

Looking for more helpful information? You can receive news, product information and code tips via our newsletter, blogs and forums.
Stay in touch with us here.

JIRA's documentation is an ongoing effort and we are constantly trying to improve it. If you have any suggestions about areas you'd like better documented, or ideas about how to improve the existing documentation, please contact us.