README

Automatically Provision AWS S3 Buckets for each tenant. It's an Extention for stancl/tenancy. For more details refer to TenancyForLaravel.

Tenancy V4.x

Use branch tenancy-v4 for Tenancy v4.x versions.

Use dev-tenancy-v4 for pulling latest changes from branch.

composer require vidwan/tenant-buckets:dev-tenancy-v4

Or just use a Release Candidate:

composer require vidwan/tenant-buckets:^4.0.0-rc

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

• Automatic Bucket Creation
• Selecting the created bucket during Tenancy Bootstrapping.
• 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:

composer require vidwan/tenant-buckets

Usage

1. Filesystem Config Setup

Ensure your S3 configuration has all the Key/Value pairs, as below:

File: config/filesystems.php

        's3' => [
            'driver' => 's3',
            'key' => env('AWS_ACCESS_KEY_ID'),
            'secret' => env('AWS_SECRET_ACCESS_KEY'),
            'region' => env('AWS_DEFAULT_REGION'),
            'bucket' => env('AWS_BUCKET'),
            'url' => env('AWS_URL'),
            'endpoint' => env('AWS_ENDPOINT'),
            'use_path_style_endpoint' => env('AWS_USE_PATH_STYLE_ENDPOINT', false),
        ],

Using Minio for development? Make sure to update your .env with AWS_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.

Vidwan\TenantBuckets\Bootstrappers\TenantBucketBootstrapper::class

File: config/tenancy.php

    'bootstrappers' => [
        // Tenancy Bootstrappers
        Vidwan\TenantBuckets\Bootstrappers\TenantBucketBootstrapper::class,
    ],

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

    'filesystem' => [
        'suffix_base' => 'tenant',
        'disks' => [
            'local',
            'public',
            // 's3', // Make sure this stays commented
        ],
    ],

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

use Vidwan\TenantBuckets\Jobs\CreateTenantBucket;
use Vidwan\TenantBuckets\Jobs\DeleteTenantBucket;

...

    public function events()
    {
        return [
            // Tenant events
            ...
            Events\TenantCreated::class => [
                JobPipeline::make([
                    Jobs\CreateDatabase::class,
                    Jobs\MigrateDatabase::class,
                    Jobs\SeedDatabase::class,
                    // Your own jobs to prepare the tenant.
                    // Provision API keys, create S3 buckets, anything you want!
                    CreateTenantBucket::class, // <-- Place it Here
					
                ])->send(function (Events\TenantCreated $event) {
                    return $event->tenant;
                })->shouldBeQueued(false),
            ],
            ...
            Events\DeletingTenant::class => [
                JobPipeline::make([
                    DeleteTenantBucket::class, // <-- Place it Here
                ])->send(function (Events\DeletingTenant $event) {
                    return $event->tenant;
                })->shouldBeQueued(false),
            ],
            ...
        ];
    }

Cheers! 🥳

Testing

composer test

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.