How to Configure Attachment Checker for Confluence

Owned by Angela Teo
Last updated: May 20, 2020 by Cao Liang
4 min read

Prerequisite


Installation

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.


Configuration

Accessing the Configuration Page

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.

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.


To allow all files, set Filter Mode to "Blacklist" and enter "," in list of extensions.


Filter Mode(tick)WhitelistChoose 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.

Field Name
Required
Default Value
Description
On Access Scanning(tick)Disabled

Available from version 1.9.0 onwards.

Add comment when infected files are deleted by on access scanner after they are uploaded.

  • Enable
  • Disable
Virus Scanning(tick)Disabled

Select whether to enable the scanning of attachments:

  • Enable
  • Disable
Scanner Path(tick)
The full path to the scanner.
Additional Options

Available from version 1.8.0 onwards.

The option settings to the scanner.

Delete Virus Files(tick)Disabled

Select whether to auto delete file if it is detected as a virus:

  • 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 Quota Summary page.

Field NameRequiredDefault ValueExplanation
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.

Quota Summary

This is only available from version 1.2.0 onwards.

Initial Setup

This is a one-time setup whereby you can select a preferred timing to calculate all the attachments in all Confluence Spaces.

Once you set the Scheduled Time, a daily job to do the calculation will be scheduled.

This must be completed before the Quota Check can be enabled.

Field NameDescription
Scheduled TimeFromTo
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 00
  • 15
  • 30
  • 45
  • AM
  • PM
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • Until all Spaces are calculated
  • 00
  • 15
  • 30
  • 45
  • AM
  • PM


For first time users, the Quota Check is disabled by default.

You will be redirected to the initial setup when you access the Quota Summary page.


For existing users, if Quota Check is enabled, you will not go through the initial setup.

If not all Spaces have completed the calculation, Attachment Checker will try to calculate on the run.

If you experience problems with the pagination, search or filter, you may wish to go through the initial setup step by clicking on Recalculate.


Scheduled Job

The job will start running at the specified start time and ends approximately around the specified end time.

If there are Spaces NOT calculated after the job stops, they will be calculated on the next job run.


Recalculate

This allows recalculation of the storage used should there be any discrepency.

By clicking Confirm:

  • You will be redirected to the Quota Summary Initial Setup.
  • Quota Check will be disabled, and CANNOT be enabled until the setup has completed.
  • If Quota Check is currently enabled, it will be re-enabled upon setup completion.


Configuring 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.

Pagination, Search and Filter

This is only available from version 1.5.5 onwards.

The maximum number of Spaces shown on each page is 50. If your Confluence instance has more than 50 Spaces, there will be pagination.

The search is by Space Key or Space Name, and is case insensitive. If there are more than 50 matching Spaces, there will be pagination.

The filters are by:

  • Allocation
    • All
    • Custom – the Space's storage allocated is not the default. 
    • Default – the Space's storage allocated follows the default.
  • Usage
    • All
    • Empty – the Space does not have any attachments.
    • Exceeded – the storage taken up by the attachments in the Space exceeds the Space's allocated storage.