Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Save more on your purchases! discount-offer-chevron-icon
Savings automatically calculated. No voucher code required.
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Newsletter Hub
Free Learning
Arrow right icon
timer SALE ENDS IN
0 Days
:
00 Hours
:
00 Minutes
:
00 Seconds
JIRA 6.x Administration Cookbook
JIRA 6.x Administration Cookbook

JIRA 6.x Administration Cookbook: Over 100 hands-on recipes to help you efficiently administer, customize, and extend your JIRA 6 implementation

eBook
€28.99 €32.99
Paperback
€41.99
Subscription
Free Trial
Renews at €18.99p/m

What do you get with a Packt Subscription?

Free for first 7 days. €18.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing
Table of content icon View table of contents Preview book icon Preview Book

JIRA 6.x Administration Cookbook

Chapter 1. JIRA Server Administration

In this chapter, we will cover:

  • Installing JIRA for production use
  • Upgrading JIRA with an installer
  • Upgrading JIRA manually
  • Migrating JIRA to another environment
  • Setting up the context path for JIRA
  • Setting up SSL
  • Installing SSL certificates from other applications
  • Resetting the JIRA administrator password
  • Generating test data in JIRA
  • Anonymizing JIRA exports

Introduction

Atlassian JIRA is a popular issue-tracking system used by many companies across the world. One of its strengths, unlike most other enterprise software, is it does not take days or weeks to install and implement, and it is very simple to upgrade and maintain.

We will assume that you, the reader, already know how to install a brand new JIRA. So, we will explore common administration tasks, such as upgrading and migrating your JIRA, looking at different options, from using the new automated upgrade utility provided by Atlassian to doing everything from scratch.

We will also look at some other neat tricks you can do as an administrator, such as resetting the admin password to get you out of sticky situations.

Installing JIRA for production use

In this recipe, we will look at how to install and set up JIRA in a production environment. This includes setting up a dedicated user to run JIRA under and using an external database.

We will be using the standalone archive distribution, as the steps are consistent across both Windows and Linux platforms.

Getting ready

The following things need to be checked before you start with this recipe:

  • Download the latest JIRA archive distribution from https://www.atlassian.com/software/jira/download and click on the All JIRA Download Options link.
  • Make sure your server environment meets JIRA's requirements by visiting the following link: https://confluence.atlassian.com/display/JIRA/Supported+Platforms.
  • Install Java on the system. At the time of writing, JIRA 6 required Java 7. Make sure you get the latest update for Java, unless it is explicitly stated as unsupported by JIRA.
  • Make sure the JAVA_HOME or JRE_HOME environment variable is configured.
  • Have a database system available, either on the server hosting JIRA or a different server accessible over the network. For this recipe, we will be using MySQL; if you are using a different database, change the commands and queries accordingly.
  • Download the necessary database driver. For MySQL, you can download it from https://dev.mysql.com/downloads/connector/j.

How to do it…

We first need to create an empty MySQL database for JIRA:

  1. Open up a new command prompt on the MySQL server.
  2. Run the following command (you can also use another user instead of root as long as the user has permission to create new users and databases):
    mysql -u root -p
  3. Enter the password for the user when prompted.
  4. Create a new database for JIRA by running the following command:
    create database jiradb character set utf8;
  5. Create a new user for JIRA in the database and grant the user access to the jiradb database we just created using the following command:
    grant all on jiradb.* to 'jirauser'@'localhost' identified by 'jirapassword';

    In the previous five steps, we have created a new database named jiradb and a new database user named jirauser. We will be using these details later to connect JIRA with MySQL. The next step is to install JIRA.

  6. Create a dedicated user account to run JIRA under. If you're using Linux, run the following command as root or with sudo:
    useradd --create-home --comment "Dedicated JIRA account" --shell /bin/bash jira

    Note

    It is a good practice to reduce security risks by locking down the user account so that it does not have login permissions.

  7. Create a new directory on the filesystem where JIRA will be installed in. This directory will be referred to as JIRA_INSTALL.
  8. Create another directory on the filesystem. This will be used for JIRA to store its attachments, search indexes, and other information. You can create this directory on a different drive with more hard disk capacity, such as a network drive (this could slow down the performance). This directory will be referred to as JIRA_HOME.

    Note

    It is a good practice to keep the JIRA_INSTALL and JIRA_HOME directories separate, that is, the JIRA_HOME directory should not be a subdirectory inside JIRA_INSTALL. This will make future upgrading and maintenance easier.

  9. Unzip the JIRA archive file in the JIRA_INSTALL directory.
  10. Change both the JIRA_INSTALL and JIRA_HOME directories' owner to the new JIRA user.
  11. Open the JIRA_INSTALL/atlassian-jira/WEB-INF/classes/jira-application.properties file in a text editor.
  12. Locate the jira.home= line in this file.
  13. Cut and paste this in the full path to the JIRA_HOME directory and remove the # symbol if present. Make sure you use the forward slash (/). The following line shows how it looks on a Linux system:
    jira.home=/opt/data/jira_home

    Note

    Windows uses the backward slash (\) in the file path. You should still use the forward slash (/) while specifying the jira.home directory.

  14. Copy the database driver JAR file to the JIRA_INSTALL/lib directory.
  15. Start up JIRA by running the start-jira.sh (for Linux) or start-jira.bat (for Windows) script from the JIRA_INSTALL/bin directory as the JIRA user.

    JIRA comes with a setup wizard that will help guide us through the final phase of the installation.

  16. Open up a browser and go to http://host:8080. By default, JIRA runs on port 8080. You can change this by changing the connector port value in the JIRA_INSTALL/conf/server.xml file.
  17. The first step is to select the language JIRA will use for its user interface.
  18. The second step is to set up the database information. Select the My Own Database (recommended for production environments) option.
  19. Select a value for the Database Type option. For this recipe, select the MySQL option.
  20. Enter the details for our new jiradb database.
  21. Click on Test Connection to check whether JIRA is able to connect to the database.
  22. Click on Next to move to the second step of the wizard as shown in the following screenshot:
    How to do it…
  23. Enter the title for this JIRA instance.
  24. Select Public if you would like to let people sign up for accounts, or select Private if you want only administrators to create accounts. For most organizations that use JIRA to track internal projects, it will be the Private mode.
  25. Set the Base URL option. The base URL is the one that users will use to access JIRA. Usually, this should be a fully qualified domain name or the hostname, that is, not a localhost or an IP address.
  26. Click on Next to go to the third step of the wizard, as shown in the following screenshot:
    How to do it…
  27. Enter your JIRA license key.
  28. Select the I don't have an account option if you do not have a valid JIRA license and you do not have an account on my.atlassian.com.
  29. Select the I have an account but no key option if you have an account on my.atlassian.com but you do not have a valid JIRA license key.
  30. Select the I have a key option if you have a valid JIRA license key handy.
  31. Click on Next to go to the fourth step of the wizard, as shown in the following screenshot:
    How to do it…
  32. Enter the details for the initial administrator account. The user account will have access to all configuration options in JIRA, so make sure you do not lose its login credentials.
  33. Click on Next to go to the fifth and final step of the wizard, as shown in the following screenshot:
    How to do it…
  34. Choose if you want to set up an outgoing SMTP server now or later. If you do not have an SMTP server ready right now, you can always come back and configure it later.
  35. Click on Finish to complete the setup process, as shown in the following screenshot:
    How to do it…

Once JIRA finishes the final setup procedures, you will be automatically logged in with the initial administrator account you created.

There's more…

By default, JIRA is set to use a maximum of 768 MB of memory. For a production deployment, you might need to increase the amount of memory allocated to JIRA. You can increase this by opening up the setenv.sh (on Linux) or setenv.bat (on Windows) file in the JIRA_INSTALL/bin directory and changing the value for the JVM_MAXIMUM_MEMORY parameter. For example, if we want to set the maximum memory to 2 GB, we will change it to JVM_MAXIMUM_MEMORY="2048m". You will need to restart JIRA after performing this change. For production uses, it is recommended that you allocate at least 2 GB of memory to the JIRA JVM.

If you are using LDAP for user management in your organization, refer to the Integrating with LDAP for authentication only recipe in Chapter 4, User Management.

Upgrading JIRA with an installer

In this recipe, we will show you how to upgrade your JIRA instance with the standard JIRA installer.

Getting ready

Since the JIRA installer is only available for standalone installations on Windows and Linux, we will be running you through the installer on Windows for this recipe:

  • Check the upgrade notes for any special instructions as well as the target JIRA version to make sure you can perform a direct upgrade.
  • Make sure you have a valid JIRA license.
  • Verify whether your current host environment is compatible with the target JIRA version. This includes the Java version, database, and operating system.
  • Verify whether your operating environment is compatible with the target's JIRA version, specifically the browser requirements.
  • Make sure that the add-ons you are using are compatible with the new version of JIRA.

    Tip

    You can use the Universal Plugin Manager's JIRA update check utility to check for add-on compatibility.

  • Download the installer binary for your target JIRA version.

How to do it…

Upgrade your JIRA with the installer using the following steps:

  1. Take your current JIRA offline; for example, by running the stop-jira.bat script.
  2. Back up the JIRA database with its native backup utility.
  3. Launch the installer and select the Upgrade an existing JIRA installation option.
  4. Select the directory where the current JIRA is installed:
    How to do it…
  5. Check the Back up JIRA home directory option and click on the Next button.
  6. Review the upgrade checklist and click on the Upgrade button:
    How to do it…
  7. Wait for the installer to complete the upgrade process. Once the upgrade is complete, the installer will automatically launch JIRA.
  8. Update add-ons once JIRA has successfully started.

The installer will detect and provide you with a list of customized files in the JIRA_INSTALL directory, which you will need to manually copy after the upgrade.

See also

If you cannot use the installer to upgrade JIRA, refer to the Upgrading JIRA manually recipe.

Upgrading JIRA manually

If you find yourself in a situation where you cannot use the JIRA installer to upgrade JIRA, for example, you are hosting JIRA on an OS that does not have an installer binary such as Solaris, or if you are using the WAR distribution, then you need to manually upgrade your JIRA instance.

Getting ready

The general prerequisite tasks for upgrading JIRA manually will remain the same as that of the installer. Refer to the previous recipe for the common tasks involved. Since the installer automates many of the backup tasks while upgrading JIRA manually, you will have to do the following:

  1. Back up the JIRA database with its native backup utility
  2. Back up the JIRA_INSTALL directory
  3. Back up the JIRA_HOME directory
  4. Get a list of all the customized files in the JIRA_INSTALL directory from the System Info page in JIRA
  5. For the WAR distribution, prepare and configure the installation files

How to do it…

To manually upgrade your JIRA instance, perform the following steps:

  1. Take your current JIRA offline.
  2. Install the new version of JIRA.
  3. Edit the jira-application.properties file in this version of JIRA, located in the JIRA_INSTALL/atlassian-jira/WEB-INF/classes directory.
  4. Update the value of jira.home to the current JIRA_HOME directory or to a copy of that directory.
  5. Copy any modified files.
  6. Start up the new JIRA.
  7. Update the add-ons once JIRA starts successfully.
  8. Remove the previous installation directory to avoid confusion.

How it works…

What we are doing here is essentially setting up a new instance of JIRA and pointing it to the old JIRA's data. When we start up the new JIRA, it will detect that the database it is connecting to contains data from an older version of JIRA by reading the dbconfig.xml file from the JIRA_HOME directory. It will also proceed to make all the necessary schema changes.

Left arrow icon Right arrow icon

Description

A comprehensive guide, full of practical recipes with real-life JIRA administration challenges, solutions, and examples with illustrations from the actual application. If you are an administrator who will be customizing, supporting, and maintaining JIRA for your organization, this book is for you. Familiarity with the core concepts of JIRA is essential. For some recipes, basic understanding in HTML, CSS, and JavaScript will also be helpful.

What you will learn

  • Upgrade and maintain a JIRA instance
  • Design and implement custom forms to capture information with custom fields, screens, and validation rules
  • Create custom workflows with complex validation logic and business rules
  • Secure JIRA data from unauthorized access
  • Set up single signon for JIRA on a Windows domain
  • Make JIRA compliant with FDA Part 11 with electronic signatures
  • Integrate JIRA with other cloud platforms, such as Google Drive
  • Automate administrative tasks with scripts and commandline interfaces

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Jul 10, 2014
Length: 260 pages
Edition : 1st
Language : English
ISBN-13 : 9781782176862
Vendor :
Atlassian
Tools :

What do you get with a Packt Subscription?

Free for first 7 days. €18.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing

Product Details

Publication date : Jul 10, 2014
Length: 260 pages
Edition : 1st
Language : English
ISBN-13 : 9781782176862
Vendor :
Atlassian
Tools :

Packt Subscriptions

See our plans and pricing
Modal Close icon
€18.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
€189.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts
€264.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total 120.97
JIRA 6.x Administration Cookbook
€41.99
Git Version Control Cookbook
€36.99
Atlassian Confluence 5 Essentials
€41.99
Total 120.97 Stars icon

Table of Contents

10 Chapters
1. JIRA Server Administration Chevron down icon Chevron up icon
2. Fields and Screens Chevron down icon Chevron up icon
3. JIRA Workflows Chevron down icon Chevron up icon
4. User Management Chevron down icon Chevron up icon
5. JIRA Security Chevron down icon Chevron up icon
6. E-mails and Notifications Chevron down icon Chevron up icon
7. Integrating with JIRA Chevron down icon Chevron up icon
8. JIRA Administration Chevron down icon Chevron up icon
9. JIRA Customizations Chevron down icon Chevron up icon
Index Chevron down icon Chevron up icon

Customer reviews

Top Reviews
Rating distribution
Full star icon Full star icon Full star icon Half star icon Empty star icon 3.9
(10 Ratings)
5 star 40%
4 star 30%
3 star 20%
2 star 0%
1 star 10%
Filter icon Filter
Top Reviews

Filter reviews by




Steve Sep 23, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
Good how to book.
Amazon Verified review Amazon
Craig Apr 13, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
Excellent step by step guidebook to accomplish the most common needs for JIRA. Much better than other publications that I have tried.
Amazon Verified review Amazon
Ellen Feaheny Jan 02, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
This book is the logical and natural "extra limb" for any Atlassian server administrator serious about their job supporting JIRA end users in a corporation. Sure, you can "get by" winging it day by day, and many do. But as many also learn, with JIRA, ramifications for your configuration decisions matter well beyond the day you make them. Similarly, unraveling early-on poor decisions can be both painful and cumbersome. This book will help you make good and right JIRA configuration decisions out the gate, and simultaneously bring your JIRA skill set up a whole new level. Bonus: your end users and boss(es) will thank you for it.(This is Mr. Li's 3rd book on JIRA; he's worked with the platform for 8+years in some of the largest/most complex corporate JIRA installations in the world.)
Amazon Verified review Amazon
Philipp Sendek Sep 12, 2014
Full star icon Full star icon Full star icon Full star icon Full star icon 5
JIRA, a software that has its roots in the software development and the bug tracking has a growing popularity even outside of those industries. The fact that JIRA is more like a very versatile framework than a static standard software for managing issues will become clear once more in this bookThe author doesn't limit himself to providing a plain guide that only states the obvious ways of customizations which the user interface offers, but brings in his years of experience to deliver a full-fledged administration guide with extraordinary depth:Apart from general things like the installation, setting up own issues types, workflows, field configurations et al. he picks up common snitches and minor issues and provides practical solutions in form of Velocity-, Groovy- or JavaScript-Code to adjust the appearance, automatize field input or run content checks in screens. Yet this book isn't only dedicated to "hardcore" admins either, as even starters will learn a lot on best practices before or even during setting up and getting familiar with JIRA.Therefor I can absolutely recommend this book to fresh and experienced JIRA admins alike, using it myself to pick up some new tricks in terms of scripting and "under the hood" tweaking.
Amazon Verified review Amazon
W Boudville Aug 15, 2014
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
When the book says Jira is an issue tracking package for a corporate environment, in practice for some of you, this will mean handling complaints and bugs. In the computing community, bug tracking is a common necessity for any firm putting out software.The book is directed towards a system administrator of Jira. There is much flexibility built into what you can make for your users. A form that a user fills out can have fields that you define as mandatory or not. The former means the user must fill out a field. You should probably exercise care about how many such fields you assign this status. Tempting after all to define all fields as mandatory. But that can deter some users from reporting an issue. While this might be frustrating from your standpoint, you have to make a tradeoff between ease of reporting and the comprehensiveness of those reports.Jira is much more than form filling. One chapter delves into how you can define a workflow. Using an simple graphical interface to build a directed graph. A finite state machine, for those readers with the appropriate background. This network machine can then be used by your users in a project. The transitions between nodes [states] of the network can themselves have intermediate screens where users can fill in extra data or get information.If indeed you want to use Jira for software development, then chapter 7 is germane. It shows how to integrate it with github, bitbucket and other 3rd party packages and websites. As you may know, several of these sites are now often used by programmers to archive their code in a globally accessible manner. A key paradigm change in the programming field. Jira lets you accomodate your users if they use these websites.
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is included in a Packt subscription? Chevron down icon Chevron up icon

A subscription provides you with full access to view all Packt and licnesed content online, this includes exclusive access to Early Access titles. Depending on the tier chosen you can also earn credits and discounts to use for owning content

How can I cancel my subscription? Chevron down icon Chevron up icon

To cancel your subscription with us simply go to the account page - found in the top right of the page or at https://subscription.packtpub.com/my-account/subscription - From here you will see the ‘cancel subscription’ button in the grey box with your subscription information in.

What are credits? Chevron down icon Chevron up icon

Credits can be earned from reading 40 section of any title within the payment cycle - a month starting from the day of subscription payment. You also earn a Credit every month if you subscribe to our annual or 18 month plans. Credits can be used to buy books DRM free, the same way that you would pay for a book. Your credits can be found in the subscription homepage - subscription.packtpub.com - clicking on ‘the my’ library dropdown and selecting ‘credits’.

What happens if an Early Access Course is cancelled? Chevron down icon Chevron up icon

Projects are rarely cancelled, but sometimes it's unavoidable. If an Early Access course is cancelled or excessively delayed, you can exchange your purchase for another course. For further details, please contact us here.

Where can I send feedback about an Early Access title? Chevron down icon Chevron up icon

If you have any feedback about the product you're reading, or Early Access in general, then please fill out a contact form here and we'll make sure the feedback gets to the right team. 

Can I download the code files for Early Access titles? Chevron down icon Chevron up icon

We try to ensure that all books in Early Access have code available to use, download, and fork on GitHub. This helps us be more agile in the development of the book, and helps keep the often changing code base of new versions and new technologies as up to date as possible. Unfortunately, however, there will be rare cases when it is not possible for us to have downloadable code samples available until publication.

When we publish the book, the code files will also be available to download from the Packt website.

How accurate is the publication date? Chevron down icon Chevron up icon

The publication date is as accurate as we can be at any point in the project. Unfortunately, delays can happen. Often those delays are out of our control, such as changes to the technology code base or delays in the tech release. We do our best to give you an accurate estimate of the publication date at any given time, and as more chapters are delivered, the more accurate the delivery date will become.

How will I know when new chapters are ready? Chevron down icon Chevron up icon

We'll let you know every time there has been an update to a course that you've bought in Early Access. You'll get an email to let you know there has been a new chapter, or a change to a previous chapter. The new chapters are automatically added to your account, so you can also check back there any time you're ready and download or read them online.

I am a Packt subscriber, do I get Early Access? Chevron down icon Chevron up icon

Yes, all Early Access content is fully available through your subscription. You will need to have a paid for or active trial subscription in order to access all titles.

How is Early Access delivered? Chevron down icon Chevron up icon

Early Access is currently only available as a PDF or through our online reader. As we make changes or add new chapters, the files in your Packt account will be updated so you can download them again or view them online immediately.

How do I buy Early Access content? Chevron down icon Chevron up icon

Early Access is a way of us getting our content to you quicker, but the method of buying the Early Access course is still the same. Just find the course you want to buy, go through the check-out steps, and you’ll get a confirmation email from us with information and a link to the relevant Early Access courses.

What is Early Access? Chevron down icon Chevron up icon

Keeping up to date with the latest technology is difficult; new versions, new frameworks, new techniques. This feature gives you a head-start to our content, as it's being created. With Early Access you'll receive each chapter as it's written, and get regular updates throughout the product's development, as well as the final course as soon as it's ready.We created Early Access as a means of giving you the information you need, as soon as it's available. As we go through the process of developing a course, 99% of it can be ready but we can't publish until that last 1% falls in to place. Early Access helps to unlock the potential of our content early, to help you start your learning when you need it most. You not only get access to every chapter as it's delivered, edited, and updated, but you'll also get the finalized, DRM-free product to download in any format you want when it's published. As a member of Packt, you'll also be eligible for our exclusive offers, including a free course every day, and discounts on new and popular titles.