Documentation Home

Module Installation

The Broadleaf Amazon module requires configuration and third-party property configuration

Broadleaf Dependency

  • Version 2.1.x-GA requires Broadleaf 5.2 or later.
  • Version 2.0.x-GA requires Broadleaf 5.0 or 5.1
  • Version 1.1.x-GA requires Broadleaf 4.0 or 4.1
  • Version 1.0.x-GA requires Broadleaf 3.1

Configuration Changes

Step 1. Add the dependency into your core/pom.xml:


Third Party Property Configuration

This module requires you to configure properties specific to your amazon account.

Amazon Credentials

Broadleaf requires access to your Amazon AWS account. See About Amazon Credentials for more information.

AccessKeyId / SecretKey
One approach for setting up credentials is to use an accessKeyId and secretKey. When you create the access keys on amazon you will need to copy the values and add the following properties to your file located in your core project.



Instance Profiles
If you are hosting on EC2, you can now use Instance Profiles. See Creating Instance Profiles

If you are using Instance Profiles, then the following property should be set:


Amazon File Storage Location Information

Broadleaf needs to know the specific location within your S3 account to store the files. You will need to set the bucket name and the bucket location. These properties are described on the Amazon S3 Location Selection page.

The bucket name must be unique across all of Amazon


If you would like to store files inside of a folder within the bucket (like 'img'), set the following property:


Starting and trailing slashes will be stripped from this value to build the file path so they are not necessary

The Amazon module will default to the "us-west-2" region of S3. You can override the region by setting the following property.


If your uploads require Server-Side Encryption, enable with this property. The default value is "false".