Versions Compared

Key

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

Amazon S3 Connector for Confluence user guide:

Administration
Panel

Page Macro




Adding a new Bucket

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

Create Bucket Association

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

new bucket association

Bucket"

Image Removed

You need to fill

Image Added


Fill in all required fields to successfully add a new bucket

association:Friendly name — represents the name of the account

Image Added


LabelA custom label that will be used in the macro
and it will mask your
to hide the real S3 Bucket name
.
S3 Bucket
name — represents your real Amazon S3 account name
  • Access Key — This is actually a username. It is alphanumeric text string that uniquely identifies the user who owns the account. It is Access Key.

  • Access Secret — This key plays the role of a password . It’s called secret because it is assumed to be known by the owner only.

  • Image Removed
    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)


    To test your Bucket credentials

    just

    click on the button “Test

    connection

    & Add” and you will be

    inform

    informed about the validation result

    .

    Image Added

    Image Removed


    Bucket Permissions

    Once

    you fill in all fields click on the button “Save” and your account will be stored.Image Removed

    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



    Image Added



    Image Added


    View
    Create
    Rename
    Delete


    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 Modified


    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 Modified


    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 Modified


    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 Modified


    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 Modified


    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 Modified


    Example of Macro content

    Image Modified