JIRA
Install
Admin
Use
Search JIRA documentation:

Configuring File Attachments

PDF
PDF

When you enable file attachments, you allow users to attach files and screenshots to JIRA issues. This requires space on the server to save the attachments into. Note that attachments are not stored in JIRA's database and so will need to be backed up separately.

Configuring file attachments takes two steps:

  1. Enabling attachments.
  2. Granting the 'Create Attachments' permission to appropriate users.

Additionally, if you wish to allow users to attach a file when creating a new issue, you need to ensure that the 'Attachment' field is not hidden within the field configuration(s) associated with the specific issue type(s).

Step 1: Enabling attachments

  1. Log in as a user with the 'JIRA System Administrators' global permission.
  2. Bring up the administration page by clicking either the 'Administration' link on the top bar or the title of the Administration box on the dashboard:

    Link to Administration sectionLink to Administration section

  3. Under the 'Global Settings' sub-menu in the left-hand navigation column, click the 'Attachments' link. This will display the 'Attachment Settings' page, which states whether attachments are on or off:

    Page for enabling attachments
  4. Click the 'Edit Configuration' link.
  5. In the 'Allow Attachments' field, select 'ON'.
  6. In the 'Attachment Path' field, type the absolute or relative path to the directory where attachments will be stored. Note that this directory should be given appropriate security as described in Security Overview.
  7. (Optional) In the 'Enable Thumbnails' field, select 'ON' if you wish to enable image attachments to be displayed as thumbnails. For details please see 'Image attachment thumbnails'.
  8. Click the 'Update' button.

Step 2: Granting the 'Create Attachments' permission to users

You now need to grant the 'Create Attachments' permission to appropriate users in the permission scheme(s) of project(s) for which you wish to allow attachments.

  1. Log in as a user with the 'JIRA Administrators' global permission.
  2. Bring up the administration page by clicking either the 'Administration' link on the top bar or the title of the Administration box on the dashboard:

    Link to Administration sectionLink to Administration section

  3. Under the 'Schemes' sub-menu in the left-hand navigation column, click the 'Permission Schemes' link. This will display a list of all permision schemes in your JIRA system, and the projects which use each scheme.
  4. For each relevant permission scheme,

    1. Click the 'Permissions' link to edit the scheme.

      Permission Schemes
    2. In the 'Permissions' drop-down list, find 'Create Attachments', and click the 'Add' link.

      Adding a permission to a scheme
    3. In the 'User-Group' drop-down list, select the relevant group. Then click the 'Add' button.

      Adding a permission to a scheme

Changing the attachment size limit

The default maximum attachment size is 10Mb. This can be changed, but not yet through the web interface (see JRA-2994).

To change the maximum attachment size, edit the atlassian-jira/WEB-INF/classes/webwork.properties file and change the webwork.multipart.maxSize parameter.

Specifying the maximum attachments per issue

JIRA allows multiple files to be attached to an issue in one operation. From the 'Attach File' page, the user can toggle between multiple and single attachment screens by selecting the 'Attach multiple' files link. The attachment form will retain the multiple/single attachment preference for that specific user for the duration of the user's session or until manually changed.

The number of attachment 'boxes' to be displayed on the multiple attachment screen is set to 3 by default. To change this, edit jira.attachment.number in the jira-application.properties file, then restart JIRA.