Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Amazon S3 Connector for Confluence user guide:

Page Macro
Panel


Table of Contents
maxLevel2
minLevel2

Adding a new Bucket

The administration section gives you the ability to manage your Amazon S3 Buckets.

To create a new Bucket association, click on "+ Add Bucket"


Fill in all required fields to successfully add a new bucket


LabelA custom label that will be used in the macro to hide the real S3 Bucket name
S3 Bucket Name

The name of your S3 Bucket exactly as it is displayed in AWS (Buckets can be created using the AWS Console)

Access Key

The access key of the IAM user who has access to specified S3 Bucket (Created through IAM on the AWS Console)

Secret Key

The secret key of the IAM user who has access to specified S3 Bucket (Created through IAM on the AWS Console)


Note: To start a bucket in a subdirectory simply add the path to the bucket name

E.g. BucketName/SubDirectory 

To test your Bucket credentials click on the button “Test & Add” and you will be informed about the validation result


Bucket Permissions

Once a bucket has been created the permission manager will appear where you can select which users, groups and Spaces can access the Bucket


Note

If you do not set any permissions after creating a bucket, no one will be able to view, edit or delete objects




Add users and groups to the Bucket permissions to grant them the desired level of access


ViewView all bucket files 
CreateUpload files and create new folders
RenameRename existing files and folders
DeleteDelete

If you need to change your bucket association details you can do it when you click on the button “Edit” at the end of the row with listed account details.

Image Removed

If you want to delete your existing configured bucket association only click on the button “Delete” at the end of the row with account details you want to remove.

Image Removed

Using the S3 Macro on a page

Macro "Amazon S3 Storage Connector" is responsible for rendering the content of Amazon S3 Buckets.

Create a new page or edit an existing page, open a Macro browser and click on the category "Media".

Image Removed

Click on the macro and to show the configuration page where you can set the following parameters:

  • Title — Set title for macro content. It will be shown before the content.
  • Bucket — Set the bucket whose content will be shown. Buckets can be configured only in administration.
  • Show border — Allow showing borders around macro content.
  • Display image thumbnails — Allow rendering thumbnails of images.
  • View as:
    • Directory listing — Bucket content will be rendered as directory listing which is similar to a traditional file manager.
    • Tree structure — Bucket content will be rendered in a tree view structure.

Image Removed

Selected path in macro will be used as a default root path when a macro is rendered on a page. It means that user cannot traverse above of selected path.

To insert macro with set configuration into a page just click on the button Insert.

Image Removed

To edit macro just click on the macro placeholder when editing a page. Property panel gives you also ability to quickly change the title of the macro.

Image Removed

Example of Macro content

Image Removed
files and folders


Restrict Bucket access to only allow it to be viewed in selected Spaces - Leave empty to allow all Spaces to access this bucket

Image Added


Editing and Deleting a Bucket

Existing Buckets can be edited and deleted from the main Bucket list on the Amazon S3 Settings menu

Image Added




Macro Options

Image Added


Configure the macro layout and display options

Image Added

TitleSet a title for the macro
BucketSelect the Bucket to display - only buckets that the current user has permission to view will be available in the drop-down list
Show BordersShow a border around the macro
Show VersionsIf versioning is enabled on the Bucket selecting this option will show previous versions of objects
Display Image ThumbnailsShows preview of images as a small thumbnail
Thumbnail SizeSelect thumbnail size
View as

Image Added

Order FieldDefault ordering field - Name, Size, Last Modified
Order TypeAscending, Descending