Download the PHP package vidwan/tenant-buckets without Composer
On this page you can find all versions of the php package vidwan/tenant-buckets. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vidwan/tenant-buckets
More information about vidwan/tenant-buckets
Files in vidwan/tenant-buckets
Package tenant-buckets
Short Description Automatically Provision AWS S3 Buckets for tenants.
License MIT
Homepage https://github.com/vidwan-co/tenant-buckets
Informations about the package tenant-buckets
Provision S3 Buckets for each tenant.
Automatically Provision AWS S3 Buckets for each tenant. It's an Extention for stancl/tenancy. For more details refer to TenancyForLaravel.
Concept
The concept is simple, to automatically provison a new AWS S3 bucket for tenant on registration and update the same on the central database's tenant table & data coloumn under tenant_bucket
.
Then using a bootstrapper updating the bucket in config filesystems.disks.s3.bucket
during runtime when in Tenant's context and then reverting it back on central context.
Roadmap
- [x] Automatic Bucket Creation
- [x] Selecting the created bucket during Tenancy Bootstrapping.
- [x] Deletion of Bucket when the Tenant is deleted.
- [ ] Testing with Amazon S3 service.
Note: I have still not tested this package under production environment or with a real AWS S3 Bucket. I have only tested it under development environment using MinIO. I will update this after testing it on AWS S3 Bucket with an additional section on AWS IAM Policy Setup for creating the buckets using
aws-sdk-php
. Untill then, if you have tested, a PR is welcome.
Installation
You can install the package via composer:
Usage
1. Filesystem Config Setup
Ensure your S3 configuration has all the Key/Value pairs, as below:
File: config/filesystems.php
Using Minio for development? Make sure to update your
.env
withAWS_USE_PATH_STYLE_ENDPOINT=true
2. Tenancy Config
There are two parts in tenancy config to take care of.
Part a.
Add the TenantBucketBootstrapper::class
to the tenancy config file under bootstrappers
.
File: config/tenancy.php
Part b.
Make sure the s3
is commented in tenancy.filesystem.disks
config or else it conflicts with the tenancy itself.
File: config/tenancy.php
3. Job Pipeline
Add Vidwan\TenantBuckets\Jobs\CreateTenantBucket
& Vidwan\TenantBuckets\Jobs\DeleteTenantBucket
in JobPipeline::make()
. As the name suggests, the former Creates a New Bucket on Tenant Creation and the later Deletes it when a Tenant is being Deleted.
File: app/Providers/TenancyServiceProviders.php
Cheers! 🥳
Testing
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
- Shashwat Mishra
- All Contributors
License
The MIT License (MIT). Please see License File for more information.