Attachment Checker for Confluence
Breadcrumbs

User Guide for Attachment Checker for Confluence before version 1.4.0

  • Log in as a  Jira administrator  to carry out the following instructions.

  • Ensure that the plugin version to be installed is compatible with your Confluence version. (View:  Compatibility matrix )

Install Plugin


Confluence Administration > Add-ons > Atlassian Marketplace > Find new add-ons

By Searching in Atlassian Marketplace

  1. Go to Find new add-ons

  2. Search for Attachment Checker in the search field

  3. Click Free trial or Buy now to install, configure and start using

Confluence Administration > Add-ons > Atlassian Marketplace > Manage add-ons

By Upload

  1. Download the latest version from Marketplace

  2. Go to Manage add-ons

  3. Click on Upload add-on

  4. Select the .jar file

  5. Click Upload

  6. The Attachment Checker should be installed

  7. Click on Free trial or Buy now to configure and start using

*The Attachment Checker for Confluence offers a free trial for 30 days.

Configuration


Accessing the Configuration Page
acc-how-to-access-config-page.jpg

Configuration Settings

The settings are organised into the following tabs:

  • File Type Blocking

  • Virus Scanning

  • Quota Checking


      File Type Blocking
      To block file types based on the configured whitelisting/blacklisting rules.
attachment checker config file type blocking.png

Field Name

Required

Default Value

Explanation

Extensions

(tick)

jpg

The list of extensions to be used for filtering.
For each of the extension listed, all of it's associated extension(s) will also be filtered automatically.

Filter Mode

(tick)

Whitelist

Choose a filter mode:

  • Whitelist (Only configured file types are allowed)

  • Blacklist (Only configured file types are blocked)

Error Message

(tick)

This file type is not allowed.

The message to be displayed when a file attached is not allowed.


      Virus Scanning
      To scan all uploaded attachments for virus threats.


virusScanningConfig.png


Field Name

Required

Default Value

Explanation

Virus Scanning

(tick)

Disabled

Select whether to enable the scanning of attachments:

  • Enable

  • Disable

Scanner Path

(tick)


The full path to the scanner.

Delete Virus File

https://akeles.jira.com/wiki/s/-607157113/6452/dcac233cd72e085e65b2712b2fb56d4c18aca08f/_/images/icons/emoticons/check.png

Disabled

Select whether to auto delete an infected attachment:

  • Enable

  • Disable


      Quota Checking
      To control the amount of attachments uploaded in each Space.
      To set the attachment quota for each Space individually, click on Edit Space Quota button to go to the Attachment Summary page.
attachment checker config quota checking.png

Field Name

Required

Default Value

Explanation

Quota Checking

(tick)

Disabled

Select whether to enable the quota checking:

  • Enable

  • Disable

Default

(tick)

Unlimited

Enter default quota (rounded up to 2 decimal place):

  • '0' for Unlimited

MB

Select preferred unit to use:

  • MB

  • GB

Error Message

(tick)

Insufficient storage available.

The message to be displayed when the file size of a file attached is greater than the storage space available.


Update Settings

*Only System Administrators are allowed to update the settings.

  1. Click on the tab that you wish to edit.

  2. Click on the Edit Settings button.

  3. Make the necessary changes to the form.

  4. Click on the Save button.

attachment checker config steps to update settings part 1.png
attachment checker config steps to update settings part 2.png

      Attachment Quota

  1. Click on the pencil icon to edit.

  2. Make the necessary changes to the form.

  3. Click on the tick button to save or cross button to cancel.

      If the attachment quota for a particular Space is not set, the default attachment quota will be used.
attachment checker attachment summary.png