aligent/orocommerce-s3mediabundle

Amazon S3 Based media storage for Oro Platform (OroCommerce and OroCRM)

4.2.0 2021-09-06 01:59 UTC

README

Info

  • composer name: aligent/orocommerce-s3mediabundle

Description

This bundle provides configuration for using S3 buckets for media storage in Oro Platform by configuring the KNPGaufrette Bundle. It will work with both OroCommerce and OroCRM versions based on Oro Platform 4.0.0 and later. For older versions pf OroCommerce use one of the 1.x releases of this module.

Parameters

    amazon_s3.bucket_name: s3-bucket-name
    amazon_s3.region: ap-southeast-2
    amazon_s3.key: USER_KEY
    amazon_s3.secret: SUPER_SECRET

The key and secret are optional in an ECS environment, as the ECS credentials provider is used as a fallback if neither of them exist.

Installation Instructions

  1. Install this module via Composer

     composer require aligent/orocommerce-s3mediabundle
    
  2. Create the parameters (above) in your parameters.yml.

  3. Clear cache

     php bin/console cache:clear --env=prod
    

AWS Setup

  1. Create an Amazon S3 bucket. Default settings and permissions are fine, there is no need for the bucket to be public.

  2. Create the following IAM Customer Managed Policy (which grants full access to a single S3 bucket) substituting NameOfBucketHere with your S3 bucket's name:

     {
         "Version": "2012-10-17",
         "Statement": [
             {
                 "Effect": "Allow",
                 "Action": "s3:*",
                 "Resource": [
                     "arn:aws:s3:::NameOfBucketHere",
                     "arn:aws:s3:::NameOfBucketHere/*"
                 ]
             }
         ]
     }
    
  3. Create an IAM user, directly attach your new policy and generate Access and Secret keys. Insert those values into your parameters.yml (see above), clear cache and you're good to go!

Support

If you have any issues with this bundle, please create a pull request with a failing test that demonstrates the problem you've found. If you're really stuck, feel free to open GitHub issue.

Contribution

Any contribution is highly appreciated. The best way to contribute code is to open a pull request on GitHub.

Developer

Initial version by Adam Hall adam.hall@aligent.com.au.

Minor tweaks for OroCommerce 3.0 by Jim O'Halloran jim@aligent.com.au

Update for Oro Platform 4.0 by Jim O'Halloran jim.ohalloran@incore.com.au

Licence

OSL - Open Software Licence 3.0

Copyright

(c) 2018-19 Aligent Consulting