https://github.com/aligent/orocommerce-s3mediabundle
Media storage on Amazon S3 for OroCommerce
https://github.com/aligent/orocommerce-s3mediabundle
Last synced: about 1 year ago
JSON representation
Media storage on Amazon S3 for OroCommerce
- Host: GitHub
- URL: https://github.com/aligent/orocommerce-s3mediabundle
- Owner: aligent
- License: gpl-3.0
- Created: 2018-11-20T03:51:08.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-10T00:22:56.000Z (over 2 years ago)
- Last Synced: 2025-04-02T23:46:09.478Z (about 1 year ago)
- Language: PHP
- Size: 57.6 KB
- Stars: 0
- Watchers: 29
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Amazon S3 Media Storage Bundle for Oro Platform
===============================================
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 6.1.0 and later. For older versions of OroCommerce use one
of the older 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
1. Create the parameters (above) in your parameters.yml.
1. 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.
1. 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/*"
]
}
]
}
1. 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](https://github.com/aligent/orocommerce-s3mediabundle/pulls)
with a failing test that demonstrates the problem you've found. If you're really
stuck, feel free to open [GitHub issue](https://github.com/aligent/orocommerce-s3mediabundle/issues).
Contribution
------------
Any contribution is highly appreciated. The best way to contribute code is to open a [pull request on GitHub](https://help.github.com/articles/using-pull-requests).
Developer
---------
Initial version by Adam Hall .
Minor tweaks for OroCommerce 3.0 by Jim O'Halloran
Updates for Oro Platform 4.0, 5.1 & 6.1 by Jim O'Halloran
Licence
-------
[MIT](https://opensource.org/licenses/mit)
Copyright
---------
(c) 2018-25 Aligent Consulting & Contributors