Projects

External Attachments for Confluence

saturday 05 march 2016 at 14h04

Categories : Atlassian add-on

External Attachments plugin for Confluence allows to attach and embed files from remote sources via url. All attached remote files will be automatically synchronized in the background and without any action required by user.

Installation

The process of installation is as the same as for other plugins and documentation to it is provided by Atlassian.

Edit License

After plugin is successfully installed into Confluence the valid license key has to be inserted into license field otherwise plugin will not work properly.

Configuration can be accessed when the Configure button is pressed or after click on External Attachments link in the left navigation panel at the Administration page of Confluence.

Administration

If files are located on external servers which require basic authentication then credentials need to be prompted before the file is accessed. To avoid that action administration page allows allows to set up external servers which can be selected when adding external attachments to a Confluence page. After that proper credentials will be used to download files in the background. 

Add External Server

Press Add External Server button above the table an external server can be configured and stored into database.

Edit server

To edit configured external server it is required to click on the edit button at the end of particular row.

In the Edit dialog following fields can be changed:

  • Name
  • Host
  • Username
  • Password

Active/Inactive server

Each configured external server can be active or inactive. Only active external servers are listed and accessible in the dropdown when adding external attachment to a Confluence page.

To make external server inactive it is required to click on the Make External Server inactive button at the end of particular row.

To make external server active it is required to click on the Make External Server active button at the end of particular row.

Delete Server

To delete external server it is required to click on Delete External Server button at the end of particular row.

Further it is required to confirm the deletion of external server. After that an external server will be permanently deleted from the database.

Usage

Creating external attachments

There are several ways how to create an external attachment:

  1. Add url to the existing attachment

This action can be done on the Attachments page - in the table of the attachments or on the edit page of the attachment.

After click on the pencil button the popup with input field for url will be shown and an url of the remote source can be entered.

  1. Upload remote file from url

Using a form “Attach Remote File” below the table with list of attachments on Attachments page.

After the filling required fields and click on Attach button files from remote sources can be uploaded to the Confluence storage.

Note: Server field is not mandatory field. It can be used only when the file is located on a server protected by basic authentication.

  1. Upload remote file in Link browser

Note: Insert Menu can be different across Confluence versions

There are several possibilities how to show panel with External Attachment in the Link Browser:

  • Click on the Files and images in the Editor’s Insert Menu

  • Click on the button External Attachments at the bottom of page below the Editor (Note: It is present in the old versions of Confluence)

  • Click on the link External Attachments in the menu of Link Browser

  • Note: Server field is not mandatory field. It can be used only when the file is located on a server protected by basic authentication.

  1. Upload remote file in Image Dialog

Note: Insert Menu can be different across Confluence versions

There are several possibilities how to show panel with External Images in the Image Dialog:

  • Click on the link in the Editor’s Insert Menu

  • Click on the link External Attachments in the menu of Link Browser

Synchronization of the external attachment with remote source

  1. Automatically

The attachments are updated only when a page is shown. Add-on provides synchronization in the background and updates files if it is necessary. Then you will be informed about updated attachments.

  1. Manually

External attachments can be manually synchronized/updated on the Attachments page.

Sync all

It allows to synchronize all attachments of the page with their remote sources. Only changed files will be updated.

Sync

It allows to synchronize one attachment with its remote source. The file will be updated only when the file is changed in the remote source.

Reload

It allows to replace existing version of the attachment with file in remote source. The file will be overwrite every time you reload it (it doesn’t matter whether the files are same or not).

Usage Notes

If you want to use existing functionality of the Confluence, then you need to use attachments, e.g. in macros. The attachments will be synchronized automatically anyway.

If you want to use direct links to the files in the remote sources then you need to use External Attachments in the Link Browser.

If you want to place to the page images that are pointed to the images in the remote sources then you need use External Images in the Image Dialog

Support

Please, leave comments at atlassian answers or contact support@decoy.sk for any issues.

We are also looking for your feedback, opinions and ideas on how we can improve this add-on. So, feel free to contact us on above email address.

Enjoy the great features of this plugin!

Categories

Archives