README

S3 Drop-in extension for Leaf FS

S3 for Leaf FS

A drop-in extension for Leaf FS that allows you to use S3 as a storage driver for Leaf FS.

Installation

You can easily install Leaf using Composer.

composer require leafs/s3

Leaf MVC

If you are using Leaf MVC, add your S3 URL to the .env file:

S3_URL=https://your-s3-url

Leaf without MVC

If you are using Leaf without MVC, you can set the S3 URL in your code:

storage()->bucket('your-s3-url');

Usage

From there, you can use the s3 bucket as you would with your local storage, only wrapping your storage path in the withBucket() method to switch to bucket storage. For example, to upload a file:

storage()->upload('path/to/file.txt', withBucket('path/in/s3'));

// or directly from the request
request()->upload('file', withBucket('path/in/s3'));

💬 Stay In Touch

📓 Learning Leaf 3

Leaf has a very easy to understand documentation which contains information on all operations in Leaf.
You can also check out our youtube channel which has video tutorials on different topics
You can also learn from codelabs and contribute as well.

😇 Contributing

We are glad to have you. All contributions are welcome! To get started, familiarize yourself with our contribution guide and you'll be ready to make your first pull request 🚀.

To report a security vulnerability, you can reach out to @mychidarko or @leafphp on twitter. We will coordinate the fix and eventually commit the solution in this project.

🤩 Sponsoring Leaf

Your cash contributions go a long way to help us make Leaf even better for you. You can sponsor Leaf and any of our packages on open collective or check the contribution page for a list of ways to contribute.

And to all our existing cash/code contributors, we love you all ❤️

leafs / s3

Maintainers

Details