thaiphan/magento2-s3
Stars: 143
Forks: 97
Pull Requests: 9
Issues: 80
Watchers: 13
Last Updated: 2021-02-27 09:17:52
Use Amazon S3 as the file storage solution for your Magento 2 application
License: MIT License
Languages: PHP, HTML
Thai's S3 Extension for Magento 2
Amazon S3 is a popular file storage solution that allows web apps to host images in the cloud. Setting up your web app to use cloud storage removes the need to use the local filesystem to store images. This, in turn, allows companies to spin up more servers to handle more traffic without having to worry also copying over pre-existing images onto these new servers. Cloud storage also provides some other performance benefits, such as shifting a lot of the load of retrieving images for a customer to S3 and the ability to easily set up a CloudFront CDN for your images.
Thai's S3 extension for Magento 2 allows retailers to upload their catalogue and WYSIWYG images straight to Amazon S3.
This is done by overriding the built-in database file storage mechanism to upload to Amazon S3 bucket instead of MySQL. By handling integration with Amazon S3 in this manner, this extension will work nicely with third-party extensions that properly use Magento's file system mechanisms as well as work with any future Magento functionality.
Support
| Magento Version | Supported |
|---|---|
| 2.0 | ✅ |
| 2.1 | ✅ |
| 2.2 | ✅ |
| 2.3 | ❎ |
Magento 2.3 introduced breaking changes, which I am still contemplating how to fix. Please be patient or help contribute to this open source project!
Account & pricing
You will need to create an Amazon AWS account to get started. The cost to host your images on S3 varies depending on the AWS region that you are using and on the kind and amount of images that you upload. Click here for more detailed pricing information, https://aws.amazon.com/s3/pricing/
Features
Easy to use
This extension is easy to use with little configuration! You only need to follow a few simple steps (and one of them is simply to create a copy of your images as a precaution) to get up and running!
Sync all your media images
The following images are automatically saved to S3:
- Product images
- Generated thumbnails
- WYSIWYG images
- Category images
- CAPTCHA images
- Logos and favicons
Magento can now scale horizontally
Complex file syncing between multiple servers is now a thing of the past with this extension. All your servers will be able to share the one S3 bucket as the single source of media.
Easy integration with CloudFront CDN
CloudFront CDN supports using S3 as an origin server so you can significantly reduce load on your servers.
Installation
See the Installation page on the wiki.
Support
There's a Troubleshooting page on the wiki that I'll try and keep up to date with any issues that the community might have with the extension.
If you can't find the answer you're looking for, however, feel free to create a GitHub issue for support regarding this extension.
FAQs
Does this extension upload my log files?
No, the S3 extension only syncs across the media folder. You will need to find an alternative solution to store your log files.
Magento is still loading images from the file system! What went wrong?
The S3 extension is built on top of the built-in database file storage, which will re-download files back onto the file system as part of a caching mechanism. Magento will then use this cached version of the image instead of using S3.
If you have enabled S3 integration then you can safely delete the images off your file system (although please take a backup just in case). If you want Magento to not download files to the file system, you can configure your static media URL to point to S3 or CloudFront.
We did something wrong and all our images are gone! Can you restore it?
I recommend taking a backup of your media files when switching file storage systems. Unfortunately, there's nothing I can do if you somehow accidentally delete them.
Success Stories
Are you a happy user of my extension? I would love to feature you! Create a GitHub issue or send me an email to discuss opportunities for cross promotion!
OPEN ISSUES
See all- Resized images folder not created in S3 by @writecz
- Couldn't get available versions for package thaiphan/magento2-s3 by @cyanlycan
- Does this extension work on multi store sites? by @rcdlopez
- Custom folder and delete uploaded files option by @hirale
- Magento loads the media files on the server and in s3 by @ayalamauric
- Deletion not working from Amazon S3 bucket by @callsk
- Sync file problem by @juniorkid
- magento 2.2.3: images are not showing for configurable variations after saving through admin by @arunssjoshi
- Can this module use with Magento2 Downloadable products? by @ghost
- Images not uploading to s3 by @vijaydcyb
- Out of memory errors by @superdav42
- You are already using S3 as your media file storage backend! by @rudracomputech
- `bin/magento catalog:images:resize` not working by @lracicot
- Product image not showing on detail page by @baljinderimpinge
- Product listing becomes extremly slow after enabling by @SzabKel
- cannot replace images of product on S3 by @Yomna15
- Getting Issue on frontend Image url from s3 Bucket by @sanddy95
- Can not create configurable product with variations that have same images. by @dieguitoqueiroz
- CLI Config not saving by @djay1988
- Can't resync media image after installation by @ramzdam
- Product image keep buffering in front web store page by @merin3
- S3 catalog images duplicated in Local EBS volume by @KarthikeyanBrigita
- image upload and download not working properly while using s3 extension by @merin3
- s3:storage export issue by @saran5132
- allowed memory size exhuasted by @joebassi
- Product image can not upload to S3 bucket by @navuitag