Customize Jira login page

Still need help?

The Atlassian Community is here for you.

Ask the community

The information in this page relates to customizations in JIRA. Consequently, Atlassian Support cannot guarantee to provide any support for the steps described on this page as customizations are not covered under Atlassian Support Offerings. Please be aware that this material is provided for your information only and that you use it at your own risk.

Also, please be aware that customizations done by directly modifying files are not included in the upgrade process. These modifications will need to be reapplied manually on the upgraded instance.

Purpose

In some usage scenarios, you may want to include a customized message on JIRA's login gadget to include messages you'd find useful or remove certain elements. Since there's no way to modify the gadget through JIRA's interface, you'll have to manually edit its source files.

Process

(warning) Always remember to backup the files you modify so you can rollback in case anything goes wrong in the process.

  1. For JIRA 8.x and above, the gadget plugin jar jira-gadgets-plugin-<version>.jar file will be in the <jira-install>/atlassian-jira/WEB-INF/atlassian-bundled-plugins/ folder.
  2. Create a temporary folder and extract the jira-gadgets-plugin-<version>.jar file there:

    jar xf jira-gadgets-plugin-8.20.1.jar
  3. The file to be modified is only login.soy, It is located under the extracted jar with directory structure login/static/dashboarditem/login.
  4. Modify the login.soy file as per your requirement, for e.g. adding a new <div> element with a label to display a message.

    <div>
          <label> This is Customized Login Gadget </label>
    </div>
    <div class="field-group">       
    	<label accesskey="u" for="login-form-username" id="usernamelabel">{getText('gadget.login.username', '<u>', '</u>')|noAutoescape}</label>
       	<input class="text medium-field" id="login-form-username" name="os_username" type="text">
    </div>
  5. Create a new JAR container after modifying the files and name it the same as the original JAR file (e.g. jira-gadgets-plugin-<version>.jar). 

    jar cvfm jira-gadgets-plugin-8.20.1.jar META-INF/MANIFEST.MF ./*

6. Restart JIRA and access the login page.

As a result, below is the customized login gadget


Last modified on Feb 22, 2022

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.