Download the PHP package mreduar/s3m without Composer
On this page you can find all versions of the php package mreduar/s3m. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package s3m
Short Description Multipart Uploads using Laravel and AWS S3
License MIT
Homepage https://github.com/mreduar/s3m
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package s3m
S3M - Multipart Uploads using Laravel and AWS S3
Sometimes when running an application in a serverless environment, you may not store files permanently on the local filesystem, since you can never be sure that the same serverless "container" will be used on a subsequent request. All files should be stored in a cloud storage system, such as AWS S3, or in a shared file system through AWS EFS. Or, you may want to send a file directly to Amazon S3 simply because you don't want the server to receive files directly.
When uploading large files to S3, you may run into the 5GB limit for a single PUT request. This package allows you to upload large files to S3 by splitting the file into smaller parts and uploading them in parallel.
- Features
- Architecture
- Installation
- Usage
- Authorization
- Streaming Files To S3
- Acknowledge File Uploads & Permanent Storage
- Changelog
- Contributing
- Security Vulnerabilities
- Credits
- License
Features
- Upload large files that exceed the 5GB limit
- Upload files in parallel
- Retry failed uploads automatically
- Configurable Chunked uploads
- Configurable number of parallel uploads
- Authorization checks before uploading files
- Configurable retry attempts
Architecture
Installation
You can install the package via composer:
Add the @s3m Blade directive to your main layout (before your application's JavaScript), and the s3m() helper function will be available globally!
Configuration
S3M's default configuration settings can be customized. First, publish the configuration file:
This will create config/s3m.php in your project. There, you can customize S3M's configuration, including the AWS environment settings.
Usage
Authorization
Before initiating an upload directly to S3, S3M's internal signed storage URL generator will perform an authorization check against the currently authenticated user. If you do not already have one, you should create a UserPolicy for your application using the following command:
Next, you should add an uploadFiles method to this policy. This method should return true if the given authenticated user is allowed to upload files. Otherwise, you should return false:
Streaming Files To S3
You may use the s3m() method within your frontend code to upload a file directly to the S3 bucket attached to your environment. The following example demonstrates this functionality using Vue:
All uploaded files will be placed in a tmp directory within the bucket. This directory should be configured to automatically purge any files older than 24 hours. This feature serves to conveniently clean up file uploads that are initiated but not completed, such as a user that begins updating their profile photo but does not save the change.
The tmp directory is private by default. To override this for a given file you may add a visibility property to the options provided to the s3m() method. The visibility property should be assigned one of S3's predefined permission grants:
Acknowledge File Uploads & Permanent Storage
All uploaded files will be stored using a UUID as their filename. The response provided to the s3m method's then callback will contain the UUID of the file, the file's full S3 key, and the file's bucket. You may then POST this information to your application's backend to permanently store the file by moving it out of the bucket's tmp directory. In addition, you may wish to store additional information about the file, such as its original name and content type, in your application's database:
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Eduar Bastidas
- All Contributors
This project is inspired by Laravel Vapor. The architecture and design of this package is influenced by the work of the Laravel team and other resources.
License
The MIT License (MIT). Please see License File for more information.
All versions of s3m with dependencies
aws/aws-sdk-php Version ^3.316
illuminate/contracts Version ^10.0|^11.0|^12.0
spatie/laravel-package-tools Version ^1.16