General

Maintenance for Jira allows administrators to easily put Jira into maintenance mode.

Having this option to switch Jira into maintenance mode can be very useful for administrators, especially when planning daily maintenance / migration / upgrades or updates on a separate instance and planning the switch after testing is complete, during which you can control who has access to Jira and make any changes.

How to use Maintenance mode

Jira Administrators can enable this mode and configure a service landing page for this mode for all users who will not have access to the system

Go to Administration -> Manage apps and select Maintenance in the section Maintenance for Jira

Configuration

Enable/Disable Maintenance mode

Enable/Disable maintenance mode is very elementary, just switch and save the configuration by clicking Save.

In this section, you can also quickly preview what the maintenance landing page will be like

Direct link: JIRA_URL/plugins/servlet/maintenance/status

Enable/Disable Outgoing Mail

On the maintenance mode page, you can also quickly switch whether you want to enable/disable outgoing emails - this may be important if you intend to perform actions that may generate sending emails to users

Customization of the login page address

On the maintenance mode page, you can change the login page address as well as add additional parameters. For example, in many situations when you use SSO, you can set additional parameters to bypass logging in via SSO.

For example, your URL might look like this:

login.jsp?auth_fallback
custom/login/login.php

By default, the application has a standard login address.

Additional address changes and parameters may vary depending on the SSO used and application configuration.

Changing the appearance of the maintenance landing page

On the maintenance mode page, you can change the appearance of the landing maintenance page by changing the Main and Detailed Message fields.

The main message is displayed at the top of the page (usually it is, e.g., the logo and title or general information about what is happening), while the Details message is displayed at the bottom of the page (here you can place more detailed data, what is happening, break statuses, etc.)

Thanks to the use of Rich Text fields, you can easily create a personalized page for yourself.

Changing the appearance of the application banner

On the maintenance mode page, you can change the appearance of the information banner in the application.

This message is displayed to every user who can log in to the application in service mode as well as on the login page

Thanks to the use of Rich Text fields, you can easily create a personalized message for yourself.

Managing access to Jira

In maintenance mode, Jira Administrators have access to Jira by default. If you want to grant access to other users (e.g., testers, early adopters, etc.), you can do so by selecting an additional group that will be able to log in to the application.

Additional information

User sessions

Whenever a Jira Administrators enable maintenance mode, all user sessions without access to Jira will be automatically invalidated to prevent unwanted changes

REST API availability

For all administrators and people with access to Jira, all methods (GET, PUT, POST, DELETE, etc.) for all REST APIs available in Jira and added by third-party plugins work without any changes

For users without access to Jira, GET method for all REST APIs available in Jira and plugins added by third- plugins works without any changes, the remaining methods (e.g., PUT, POST, DELETE, etc.) will return a 403 Forbidden status with the response

{
    "message": "maintenance mode is enabled",
    "status": "blocked"
}

Banner with in-app messages

For all administrators and people with access to Jira, an additional banner will be displayed during maintenance mode informing them that this mode is enabled

Support

If you have any questions or suggestions, please don’t hesitate to contact me.

Please feel free to contact us by email support@itlab.net.pl or Jira Service Desk if you require any further information.