KB294394074: MediaBeacon - Setting up S3 Integration

Description

This article's purpose is to detail the system properties required for Amazon S3 integration.

Procedure

1. With MediaBeacon shut down, navigate to your mediabeacon.properties file and enter the properties below with appropriate values.
   1. On Windows Server 2012, this can be found in a place like the following: C:\Users\Administrator\Appdata\local\MediaBeacon\mediabeacon.properties.
   2. If you have external systems (Research, Preview, Portal, etc) make sure to place the same system properties with the same values on those systems as well.

System Properties 

• mb.s3.xmp.sync.quickdownload
  • Use: enables or disables syncing metadata on quick download with S3 integration turned on.
  • Values: boolean.
    • False: quick downloads occur directly from S3 and no metadata is synced on to the asset before the download occurs.
    • True: quick downloads occur on the MediaBeacon server but metadata is synced to the asset prior to the download.

• aws.accessKeyId
  • Use: the Amazon S3 access key used to access your bucket.
• aws.secretKey
  • Use: the Amazon S3 secret key used to access your bucket.
• aws.defaultBucket
  • Use: the default bucket you want to upload objects to.
  • Values: string.
  • Notes: there is no value set by default so you must set this on configuration.
• aws.defaultRegion
  • Use: the default region you want to use for S3 integration.
  • Values: string.
  • Notes: there is not a value set by default in MB, but it is recommended to use something like 'us-east-2' for your region if you're unsure of what to use as the default.

2. Enable your bucket with CORS by following the steps below:

• Navigate to your bucket in the S3 interface.
• Click on Permissions.
• Click on CORS Configuration.
• Enter your CORS configuration in the text area on the page.
• Click Save.

CORS Configuration 

You must enable your bucket for CORS if necessary. The following is an example configuration that opens your bucket to be modified from any host.

<?xml version="1.0" encoding="UTF-8"?>
<CORSConfiguration
        xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<CORSRule>
    <AllowedOrigin>*</AllowedOrigin>
    <AllowedMethod>GET</AllowedMethod>
    <AllowedMethod>POST</AllowedMethod>
    <AllowedMethod>PUT</AllowedMethod>
    <AllowedMethod>DELETE</AllowedMethod>
    <AllowedHeader>*</AllowedHeader>
</CORSRule>
</CORSConfiguration>

For more information on CORS and S3 visit https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html.

3. Start MediaBeacon.