Stancl Tenancy

https://github.com/stancl/tenancy-docs
Admin
Tenancy is a package for managing multi-tenancy in Laravel applications, allowing for isolated data...
Tokens:38,723
Snippets:365
Trust Score:9
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Run the tenancy:install command

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/installation.blade.md

This command creates migrations, a config file (config/tenancy.php), a routes file (routes/tenant.php), and a service provider file (app/Providers/TenancyServiceProvider.php).

```php
php artisan tenancy:install
```

--------------------------------

### Create a job pipeline with JobPipeline::make

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/event-system.blade.md

Starts a job pipeline by specifying the jobs to run. This is the first step in creating a pipeline.

```php
use Stancl\JobPipeline\JobPipeline;
use Stancl\Tenancy\Jobs\{CreateDatabase, MigrateDatabase, SeedDatabase};

JobPipeline::make([
    CreateDatabase::class,
    MigrateDatabase::class,
    SeedDatabase::class,
])
```

--------------------------------

### Concrete Test Case with Tenancy Enabled

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/testing.blade.md

Example test case that sets $tenancy = true to trigger tenancy initialization in the base TestCase's setUp() method.

```php
class FooTest extends TestCase
{
    protected $tenancy = true;

    /** @test  */
    public function some_test()
    {
        $this->assertTrue(...);
    }
}
```

--------------------------------

### Configure Nova middleware for tenancy

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/nova.blade.md

Example Nova middleware configuration that includes tenancy middleware for the tenant app.

```php
'middleware' => [
    // You can make this simpler by creating a tenancy route group
    InitializeTenancyByDomain::class,
    PreventAccessFromCentralDomains::class,
    'web',
    Authenticate::class,
    DispatchServingNovaEvent::class,
    BootTools::class,
    Authorize::class,
],
```

--------------------------------

### Run tenants:run with options and arguments

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/console-commands.blade.md

Runs a custom command for tenants. The example shows how to pass options and arguments using --option and --argument. The command signature is email:send {--queue} {--subject=} {body}.

```bash
php artisan tenants:run email:send --tenants=8075a580-1cb8-11e9-8822-49c5d8f8ff23 --option="queue=1" --option="subject=New Feature" --argument="body=We have launched a new feature. ..."
```

--------------------------------

### Require the package via Composer

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/installation.blade.md

Run this command to install the stancl/tenancy package using Composer.

```php
composer require stancl/tenancy
```

--------------------------------

### Base TestCase with Optional Tenancy Initialization

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/testing.blade.md

Base test case that initializes tenancy in setUp() when the protected $tenancy property is true. Create a tenant and initialize tenancy to test tenant app functionality.

```php
class TestCase // extends ...
{
    protected $tenancy = false;

    public function setUp(): void
    {
        parent::setUp();

        if ($this->tenancy) {
            $this->initializeTenancy();
        }
    }

    public function initializeTenancy()
    {
        $tenant = Tenant::create();

        tenancy()->initialize($tenant);
    }

    // ...
}
```

--------------------------------

### Map a tenant value to multiple config keys

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/tenant-config.blade.md

Specify config keys as an array to copy the tenant value to multiple config keys. Example maps 'locale' to both 'app.locale' and 'locales.default'.

```php
\Stancl\Tenancy\Features\TenantConfig::$storageToConfigMap = [
    'locale' => [
        'app.locale',
        'locales.default',
    ],
];
```

--------------------------------

### Get URL for global asset from a custom disk

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenancy-bootstrappers.blade.md

For global assets shared among all tenants, create a disk and use URLs from that disk instead of the tenant-aware asset() helper.

```php
Storage::disk('branding')->url('header-logo.png');
```

--------------------------------

### Initialize tenancy manually with tenancy()->initialize()

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/manual-initialization.md

Use this snippet to manually initialize tenancy for a specific tenant, for example when using artisan tinker. It resolves the Tenancy instance via the tenancy() helper and calls initialize() with a Tenant model instance.

```php
$tenant = Tenant::find('some-id');

tenancy()->initialize($tenant);
```

--------------------------------

### Publish and move laravel-permission migrations to tenant directory

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/spatie.blade.md

Commands to publish the migrations for Spatie's laravel-permission package and move them to the tenant migrations directory. Run these after installing the package.

```bash
php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="migrations"
mv database/migrations/*_create_permission_tables.php database/migrations/tenant
```

--------------------------------

### Set static property on InitializeTenancyByDomain middleware

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/configuration.blade.md

Example of setting a static property on the InitializeTenancyByDomain middleware to customize the onFail behavior. Place such calls in the boot() method of your TenancyServiceProvider.

```php
\Stancl\Tenancy\Middleware\InitializeTenancyByDomain::$onFail = function () {
    return redirect('https://my-central-domain.com/');
};
```

--------------------------------

### Configure central domains in config/tenancy.php

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/quickstart.blade.md

Add your central domains to the 'central_domains' array in the config file. The example shows a domain used with Laravel Valet.

```php
'central_domains' => [
    'saas.test', // Add the ones that you use. I use this one with Laravel Valet.
],
```

--------------------------------

### Send data from event to job pipeline

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/event-system.blade.md

Adds a 'send' callback to the pipeline to pass data from the event to the jobs. This example uses the TenantCreated event and returns the tenant.

```php
use Stancl\JobPipeline\JobPipeline;
use Stancl\Tenancy\Jobs\{CreateDatabase, MigrateDatabase, SeedDatabase};
use Stancl\Tenancy\Events\TenantCreated;

JobPipeline::make([
    CreateDatabase::class,
    MigrateDatabase::class,
    SeedDatabase::class,
])->send(function (TenantCreated $event) {
    return $event->tenant;
})
```

--------------------------------

### Define a central queue connection

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/queues.blade.md

Create a new queue connection with the `central` key set to `true` to ensure jobs dispatched on this connection run centrally under all circumstances. This example uses the database driver.

```jsx
// queue.connections
'central' => [
    'driver' => 'database',
    'table' => 'jobs',
    'queue' => 'default',
    'retry_after' => 90,
    'central' => true, // <---
],
```

--------------------------------

### Use a memoized method for dependency access

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/early-identification.blade.md

Provides an alternative to constructor DI by using a memoized method to access a dependency. The example shows a protected property and a method that lazily resolves Cloudinary via the container, with a note that injecting Application in the constructor is safe.

```php
class PostController
{
    protected Cloudinary $cloudinary;

    protected cloudinary(): Cloudinary
    {
        // If you don't like the service location here, injecting Application
        // in the controller constructor is one thing that's 100% safe.
        return $this->cloudinary ??= app(Cloudinary::class);
    }

    public function edit(Request $request, Post $post)
    {
        if ($request->has('image')) {
            $post->image_url = $this->cloudinary()->store(
                $request->file('image')
            );
        }
    }
}
```

--------------------------------

### Inject dependencies in route actions

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/early-identification.blade.md

Shows how to inject dependencies in route actions instead of controller constructors to avoid the central context issue. The example uses a route binding a Post model and injects Request, Post, and Cloudinary in the controller method.

```php
// Note that this is sort-of pseudocode. Notice the route action DI
// and just skim the rest :)

Route::get('/post/{post}/edit', 'PostController@edit');

class PostController
{
    public function edit(Request $request, Post $post, Cloudinary $cloudinary)
    {
        if ($request->has('image')) {
            $post->image_url = $cloudinary->store($request->file('image'));
        }
    }
}
```

--------------------------------

### Specify database credentials with tenancy_db_username and tenancy_db_password

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/customizing-databases.blade.md

Set 'tenancy_db_username' and 'tenancy_db_password' to specify the user and password created with the tenant database. Only works with the permission controlled MySQL database manager. The user gets grants from PermissionControlledMySQLDatabaseManager::$grants.

```php
Tenant::create([
    'tenancy_db_username' => 'foo',
    'tenancy_db_password' => 'bar',
]);
```

--------------------------------

### Create a tenant with Tenant::create()

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenants.blade.md

Create a new tenant using the Tenant model. Firing an event triggers configured jobs like database creation and migration.

```php
$tenant = Tenant::create([
    'plan' => 'free',
]);
```

--------------------------------

### Create tenants and domains via tinker

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/quickstart.blade.md

Commands to create two tenants with domains foo.localhost and bar.localhost using tinker.

```php
$ php artisan tinker
>>> $tenant1 = App\Models\Tenant::create(['id' => 'foo']);
>>> $tenant1->domains()->create(['domain' => 'foo.localhost']);
>>>
>>> $tenant2 = App\Models\Tenant::create(['id' => 'bar']);
>>> $tenant2->domains()->create(['domain' => 'bar.localhost']);
```

--------------------------------

### Create a user in each tenant database

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/quickstart.blade.md

Iterates over all tenants and creates a user in each tenant's database using runForEach.

```php
App\Models\Tenant::all()->runForEach(function () {
    App\Models\User::factory()->create();
});
```

--------------------------------

### Set up CreateTenantConnection listener in TenancyServiceProvider

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/manual-mode.blade.md

Add this event-listener mapping to the TenancyServiceProvider to create the tenant connection when tenancy is initialized. This is required for manual mode.

```php
// app/Providers/TenancyServiceProvider.php

Events\TenancyInitialized::class => [
    Listeners\CreateTenantConnection::class,
],
```

--------------------------------

### List all tenants with tenants:list

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/console-commands.blade.md

Lists all existing tenants. The output shows tenant IDs and hostnames.

```bash
php artisan tenants:list
Listing all tenants.
[Tenant] id: dbe0b330-1a6e-11e9-b4c3-354da4b4f339 @ localhost
[Tenant] id: 49670df0-1a87-11e9-b7ba-cf5353777957 @ dev.localhost
```

--------------------------------

### Run migrations

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/user-impersonation.blade.md

Run the migrations to create the impersonation tokens table.

```jsx
php artisan migrate
```

--------------------------------

### Run command in tenant context using $tenant->run()

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenants.blade.md

Use the run() method on a tenant object to execute a callable within that tenant's context, then automatically return to the previous context (central or another tenant). The callable receives no arguments and can perform operations like creating a User.

```php
$tenant->run(function () {
    User::create(...);
});
```

--------------------------------

### Run tenants:migrate with --tenants option

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/console-commands.blade.md

Migrates tenant databases. By default, migrations are in database/migrations/tenant; use --path to specify a different path. The --tenants option specifies tenant IDs.

```bash
php artisan tenants:migrate --tenants=8075a580-1cb8-11e9-8822-49c5d8f8ff23
```

--------------------------------

### Unscoped query on secondary model

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/single-database-tenancy.blade.md

Directly calling Comment::all() without the BelongsToPrimaryModel trait will not be scoped to the current tenant, potentially accessing other tenants' data. This is an example of an unsafe query.

```php
Comment::all();
```

--------------------------------

### Run tenants:migrate-fresh with --tenants option

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/console-commands.blade.md

Runs db:wipe and tenants:migrate on the tenant's database. The --tenants option specifies tenant IDs.

```bash
php artisan tenants:migrate-fresh --tenants=8075a580-1cb8-11e9-8822-49c5d8f8ff23
```

--------------------------------

### Primary model with BelongsToTenant trait

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/single-database-tenancy.blade.md

Apply the BelongsToTenant trait to primary models to automatically scope queries to the current tenant. The example shows a Post model with a hasMany relationship to Comment.

```php
class Post extends Model
{
    use BelongsToTenant;

    public function comments()
    {
        return $this->hasMany(Comment::class);
    }
}

class Comment extends Model
{
    public function post()
    {
        return $this->belongsTo(Post::class);
    }
}
```

--------------------------------

### Enable caching for DomainTenantResolver in TenancyServiceProvider::boot()

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/cached-lookup.blade.md

Set static properties on DomainTenantResolver to enable caching, set TTL (default 3600 seconds), and optionally specify a cache store (null uses default). Place in TenancyServiceProvider::boot().

```php
// TenancyServiceProvider::boot()

use Stancl\Tenancy\Resolvers;

 // enable cache
DomainTenantResolver::$shouldCache = true;

// seconds, 3600 is the default value
DomainTenantResolver::$cacheTTL = 3600;

// specify some cache store
// null resolves to the default cache store
DomainTenantResolver::$cacheStore = 'redis';
```

--------------------------------

### Redirect using tenant_route() helper

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/cross-domain-redirect.blade.md

Alternative way to redirect users to another domain using the `tenant_route()` helper. Requires the CrossDomainRedirect feature to be enabled.

```php
return redirect(tenant_route($domain, 'home'));
```

--------------------------------

### Create a universal route

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/universal-routes.blade.md

Create a route with the 'universal' middleware group and InitializeTenancyByDomain. The route works in both central and tenant applications; tenancy initializes if a tenant is found, otherwise central context is used.

```php
Route::get('/foo', function () {
    // ...
})->middleware(['universal', InitializeTenancyByDomain::class]);
```

--------------------------------

### Enable TelescopeTags feature in tenancy.features config

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/telescope-tags.blade.md

Uncomment this line in the tenancy.features configuration to enable automatic tagging of Telescope requests by the active tenant.

```php
// Stancl\Tenancy\Features\TelescopeTags::class,
```

--------------------------------

### CreateFrameworkDirectoriesForTenant job

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/realtime-facades.blade.md

Add this job to your TenantCreated job pipeline to create the framework/cache directory for each tenant. It uses the tenant's run method to execute within the tenant context, creating the directory with mkdir and permissions 0777.

```php
<?php

namespace App\Jobs;

use Stancl\Tenancy\Contracts\Tenant;

class CreateFrameworkDirectoriesForTenant
{
    protected $tenant;

    public function __construct(Tenant $tenant)
    {
        $this->tenant = $tenant;
    }

    public function handle()
    {
        $this->tenant->run(function ($tenant) {
            $storage_path = storage_path();

            mkdir("$storage_path/framework/cache", 0777, true);
        });
    }
}
```

--------------------------------

### Configure platform middleware in config/platform.php

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/orchid.blade.md

Configure the middleware in config/platform.php to include the tenant identification middleware (e.g., InitializeTenancyByDomain) for both public and private routes. Ensure the middleware class is imported.

```php
'middleware' => [
    'public'  => ['web', 'universal', InitializeTenancyByDomain::class], // Don't forget to import the middleware
    'private' => ['web', 'platform', 'universal', InitializeTenancyByDomain::class],
],
```

--------------------------------

### Implement TenancyBootstrapper interface

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenancy-bootstrappers.blade.md

Create a custom bootstrapper class that implements the Stancl\Tenancy\Contracts\TenancyBootstrapper interface. The bootstrap method receives the Tenant instance, and the revert method is called when tenancy is reverted.

```php
namespace App;

use Stancl\Tenancy\Contracts\TenancyBootstrapper;
use Stancl\Tenancy\Contracts\Tenant;

class MyBootstrapper implements TenancyBootstrapper
{
    public function bootstrap(Tenant $tenant)
    {
        // ...
    }

    public function revert()
    {
        // ...
    }
}
```

--------------------------------

### Configure storage-to-config mapping for TenantConfig

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/tenant-config.blade.md

Set the $storageToConfigMap static property to map a tenant model property (e.g., paypal_api_key) to a config key (e.g., services.paypal.api_key). The value is copied when tenancy is initialized.

```php
\Stancl\Tenancy\Features\TenantConfig::$storageToConfigMap = [
    'paypal_api_key' => 'services.paypal.api_key',
];
```

--------------------------------

### Add the service provider to bootstrap/providers.php

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/installation.blade.md

Add TenancyServiceProvider to the providers array in bootstrap/providers.php. The comment indicates where to place it.

```php
return [
    App\Providers\AppServiceProvider::class,
    App\Providers\TenancyServiceProvider::class, // <-- here
];
```

--------------------------------

### Avoid Faking All Events with Event::fake()

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/testing.blade.md

This is the less selective approach that can break tenancy initialization and related processes. Prefer the selective version.

```php
Event::fake();
```

--------------------------------

### Enable TenantConfig feature in tenancy.features config

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/tenant-config.blade.md

Uncomment this line in the tenancy.features config to enable the TenantConfig feature.

```php
// Stancl\Tenancy\Features\TenantConfig::class,
```

--------------------------------

### Initialize tenancy in identification middleware

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/event-system.blade.md

Called by the identification middleware to set the current tenant and trigger the TenancyInitialized event.

```php
$this->tenancy->initialize($tenant);
```

--------------------------------

### Call tenants:run via Artisan::call()

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/console-commands.blade.md

Alternative to the CLI command. The --tenants option must be an array when using Artisan::call().

```php
Artisan::call('tenants:run', [
    'commandname' => 'email:send', // String
    '--tenants' => ['8075a580-1cb8-11e9-8822-49c5d8f8ff23'] // Array
    '--option' => ['queue=1', 'subject=New Feature'] // Array
    '--argument' => ['body=We have launched a new feature.'] // Array
])
```

--------------------------------

### Create custom Tenant model

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/quickstart.blade.md

Create app/Models/Tenant.php with this code to use domains and databases. The model extends the base Tenant and implements TenantWithDatabase, using the HasDatabase and HasDomains traits.

```php
<?php

namespace App\Models;

use Stancl\Tenancy\Database\Models\Tenant as BaseTenant;
use Stancl\Tenancy\Contracts\TenantWithDatabase;
use Stancl\Tenancy\Database\Concerns\HasDatabase;
use Stancl\Tenancy\Database\Concerns\HasDomains;

class Tenant extends BaseTenant implements TenantWithDatabase
{
    use HasDatabase, HasDomains;
}
```

--------------------------------

### Tenant and CentralUser model implementation for resource syncing

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/synced-resources-between-tenants.blade.md

Defines a Tenant model using HasDatabase and HasDomains with a users() relationship, and a CentralUser model implementing SyncMaster with a central connection. The CentralUser forces the central connection, uses ResourceSyncing, and defines the global identifier key as 'global_id'.

```php
use Stancl	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	enancy	en
```

--------------------------------

### Publish laravel-login-link config

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/spatie.blade.md

Command to publish the config file for Spatie's laravel-login-link package.

```sh
php artisan vendor:publish --tag="login-link-config"
```

--------------------------------

### Configure Passport routes with universal middleware (Passport 10.x and 11.x)

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/passport.blade.md

Shows the required middleware configuration for Passport routes in the AuthServiceProvider's boot() method. For Passport 10.x, use Passport::routes with 'universal' and InitializeTenancyByDomain middleware. For Passport 11.x, use a Route::group with the same middleware and load routes from the vendor path.

```php
// Passport 10.x
Passport::routes(null, ['middleware' => [
    'universal',
    InitializeTenancyByDomain::class
]]);

// Passport 11.x
Route::group([
    'as' => 'passport.',
    'middleware' => [
        'universal',
        InitializeTenancyByDomain::class
    ],
    'prefix' => config('passport.path', 'oauth'),
    'namespace' => 'Laravel\Passport\Http\Controllers',
], function () {
    $this->loadRoutesFrom(__DIR__ . "/../../vendor/laravel/passport/src/../routes/web.php");
});
```

--------------------------------

### Route group with path identification middleware

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenant-identification.blade.md

Use the InitializeTenancyByPath middleware with routes prefixed by /{tenant} to identify tenants via URL path.

```php
use Stancl\Tenancy\Middleware\InitializeTenancyByPath;

Route::group([
    'prefix' => '/{tenant}',
    'middleware' => [InitializeTenancyByPath::class],
], function () {
    Route::get('/foo', 'FooController@index');
});
```

--------------------------------

### Set tenant file thumbnails and previews

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/nova.blade.md

Configures the Avatar field to use tenant_asset for thumbnails and previews so file previews work correctly in the tenant app.

```php
Avatar::make('Avatar', 'photo')
    ->disk('public')
    ->thumbnail(fn ($value, $disk) => tenant_asset($value)),
    ->preview(fn ($value, $disk) => tenant_asset($value)),
```

--------------------------------

### Mount SQL init file in docker-compose.yml

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/sail.blade.md

Add this volume entry to the MySQL service in docker-compose.yml to automatically run the SQL grant statements when the container is initialized. Replace PATH_TO_THE_SQL_FILE and SQL_FILE_NAME with your actual paths.

```yaml
mysql:
    # ...
    volumes:
        # ...
        - 'PATH_TO_THE_SQL_FILE:/docker-entrypoint-initdb.d/SQL_FILE_NAME.sql'
```

--------------------------------

### Add tenant identification middlewares to login-link config

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/spatie.blade.md

Configuration for the 'middleware' key in the login-link config file. Add your tenant identification middlewares, such as InitializeTenancyByDomain and PreventAccessFromCentralDomains, after 'web'.

```php
'middleware' => [
    'web',
    // Add whatever tenant identification middlewares you use in your tenant routes
    InitializeTenancyByDomain::class,
    PreventAccessFromCentralDomains::class,
],
```

--------------------------------

### Bind job pipeline to event with toListener

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/event-system.blade.md

Converts the pipeline to a listener and binds it to an event using Event::listen. This is the final step in creating a pipeline.

```php
use Stancl\Tenancy\Events\TenantCreated;
use Stancl\JobPipeline\JobPipeline;
use Stancl\Tenancy\Jobs\{CreateDatabase, MigrateDatabase, SeedDatabase};
use Illuminate\Support\Facades\Event;

Event::listen(TenantCreated::class, JobPipeline::make([
    CreateDatabase::class,
    MigrateDatabase::class,
    SeedDatabase::class,
])->send(function (TenantCreated $event) {
    return $event->tenant;
})->shouldBeQueued(true)->toListener());
```

--------------------------------

### Publish impersonation migrations

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/user-impersonation.blade.md

Run this artisan command to publish the migration for the impersonation tokens table.

```jsx
php artisan vendor:publish --tag=impersonation-migrations
```

--------------------------------

### Configure FilePreviewController middleware for Livewire 3 file uploads

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/livewire.blade.md

Set the FilePreviewController middleware to include the tenancy middleware to make file uploads work on Livewire 3.

```php
// specify the right identification middleware
FilePreviewController::$middleware = ['web', 'universal', InitializeTenancyByDomain::class];
```

--------------------------------

### Redirect to route on different domain using domain() method

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/cross-domain-redirect.blade.md

Use this snippet to redirect a tenant to a specific route (e.g., 'home') on a different domain after signup. Requires the CrossDomainRedirect feature to be enabled in the tenancy.features config.

```php
return redirect()->route('home')->domain($domain);
```

--------------------------------

### Return tenant asset file from TenantAssetsController

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenancy-bootstrappers.blade.md

The TenantAssetsController returns a file response for tenant assets. The package expects assets to be stored in the tenant's app/public/ directory.

```php
// TenantAssetsController
return response()->file(storage_path('app/public/' . $path));
```

--------------------------------

### Create a domain for a tenant

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/domains.blade.md

Use the `domains` relationship to add a domain to a tenant. The domain value should be a subdomain (e.g., 'acme') when using subdomain identification, or a full hostname (e.g., 'acme.com') when using domain identification.

```php
$tenant->domains()->create([
    'domain' => 'acme',
]);
```

--------------------------------

### Publish Nova migrations

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/nova.blade.md

Publishes the Nova migrations so they can be moved to the tenant migrations directory.

```bash
php artisan vendor:publish --tag=nova-migrations
```

--------------------------------

### Specify database name with tenancy_db_name

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/customizing-databases.blade.md

Set the 'tenancy_db_name' key when creating a tenant to specify the database name. If not set, the name is constructed from the 'tenancy.database.prefix' config, tenant id, and 'tenancy.database.suffix' config.

```php
Tenant::create([
    'tenancy_db_name' => 'acme',
]);
```

--------------------------------

### Enable ViteBundler in tenancy config

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/vite-bundler.blade.md

Uncomment the ViteBundler class in the 'features' section of the tenancy config to activate the feature.

```php
'features' => [
    // [...]
    Stancl\Tenancy\Features\ViteBundler::class,
],
```

--------------------------------

### Manually register listener for TenancyInitialized

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/event-system.blade.md

Registers the BootstrapTenancy listener for the TenancyInitialized event, as an alternative to using the TenancyServiceProvider mapping.

```php
Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
```

--------------------------------

### Create SpatiePermissionsBootstrapper class

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/spatie.blade.md

Alternative to event listeners: a bootstrapper that sets the permission registrar's cache key to a tenant-specific key on bootstrap and resets it on revert. Implements TenancyBootstrapper.

```php
class SpatiePermissionsBootstrapper implements TenancyBootstrapper
{
    public function __construct(
        protected PermissionRegistrar $registrar,
    ) {}

    public function bootstrap(Tenant $tenant): void
    {
        $this->registrar->cacheKey = 'spatie.permission.cache.tenant.' . $tenant->getTenantKey();
    }

    public function revert(): void
    {
        $this->registrar->cacheKey = 'spatie.permission.cache';
    }
}
```

--------------------------------

### Enable UniversalRoutes feature in config

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/universal-routes.blade.md

Uncomment this line in the tenancy.features config to enable the UniversalRoutes feature.

```php
Stancl\Tenancy\Features\UniversalRoutes::class,
```

--------------------------------

### Make a command tenant-aware with TenantAwareCommand trait

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenant-aware-commands.blade.md

Add the TenantAwareCommand trait to a command class. The trait requires implementing a getTenants() method that returns an array of Tenant instances.

```php
class MyCommand extends Command
{
    use TenantAwareCommand;
}
```

--------------------------------

### Specify database name by setting tenant id

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/customizing-databases.blade.md

Set the 'id' key during tenant creation to control the database name, since the name is constructed from the prefix, id, and suffix. This avoids random id generation.

```php
Tenant::create([
    'id' => 'acme',
]);
```

--------------------------------

### Enable UserImpersonation feature in config/tenancy.php

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/user-impersonation.blade.md

Add the UserImpersonation class to the 'features' array in your config/tenancy.php file to enable the feature.

```jsx
Stancl\Tenancy\Features\UserImpersonation::class,
```

--------------------------------

### Combine TenantAwareCommand with HasATenantsOption or HasATenantArgument

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenant-aware-commands.blade.md

Use the option/argument traits together with TenantAwareCommand so the getTenants() method is implemented for you. If the command uses a custom constructor, add $this->specifyParameters() at the end for the option/argument traits to take effect.

```php
class FooCommand extends Command
{
    use TenantAwareCommand, HasATenantsOption;
}
```

--------------------------------

### Default tenant routes with middleware

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/quickstart.blade.md

Default tenant routes group using web middleware, InitializeTenancyByDomain, and PreventAccessFromCentralDomains. Only accessible on tenant domains.

```php
Route::middleware([
    'web',
    InitializeTenancyByDomain::class,
    PreventAccessFromCentralDomains::class,
])->group(function () {
    Route::get('/', function () {
        return 'This is your multi-tenant application. The id of the current tenant is ' . tenant('id');
    });
});
```

--------------------------------

### Add platform middleware to tenant routes in routes/tenant.php

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/orchid.blade.md

Add the 'platform' middleware to tenant routes in routes/tenant.php. This ensures the Orchid platform is available in the tenant context with tenancy initialization and central domain protection.

```php
Route::middleware([
    'web',
    'platform',
    InitializeTenancyByDomain::class,
    PreventAccessFromCentralDomains::class,
]);
```

--------------------------------

### Replace Nova routes with tenancy middleware

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/nova.blade.md

Replace the default Nova route registration with tenancy-aware authentication and password reset routes.

```php
->withAuthenticationRoutes()
->withPasswordResetRoutes()
```

```php
->withAuthenticationRoutes([
    // You can make this simpler by creating a tenancy route group
    InitializeTenancyByDomain::class,
    PreventAccessFromCentralDomains::class,
    'nova',
])
->withPasswordResetRoutes([
    // You can make this simpler by creating a tenancy route group
    InitializeTenancyByDomain::class,
    PreventAccessFromCentralDomains::class,
    'nova',
])
```

--------------------------------

### Migration to upgrade tenancy package schema

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/upgrading.blade.md

Create this migration file with `php artisan make:migration upgrade_tenancy_package`. It modifies the 'domains' and 'tenants' tables to match 3.x requirements, adding an id, unique domain, timestamps, and changing data column to nullable JSON. The down method reverses these changes.

```php
<?php

use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class UpgradeTenancyPackage extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('domains', function (Blueprint $table) {
            $table->dropPrimary();
        });

        Schema::table('domains', function (Blueprint $table) {
            $table->increments('id')->first();
            $table->unique('domain');
            $table->timestamps();
        });

        Schema::table('tenants', function (Blueprint $table) {
            $table->json('data')->nullable()->change();
            $table->timestamps();
        });

        DB::table('domains')->update([
            'created_at' => now(),
            'updated_at' => now()
        ]);
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('domains', function (Blueprint $table) {
            $table->dropColumn('id');
            $table->dropUnique(['domain']);
            $table->dropTimestamps();
            $table->primary('domain');
        });

        Schema::table('tenants', function (Blueprint $table) {
            $table->json('data')->nullable(false)->change();
            $table->dropTimestamps();
        });
    }
}

```

--------------------------------

### Register Passport routes with tenancy middleware (Passport 10.x)

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/passport.blade.md

Add this to the boot() method of AuthServiceProvider to register Passport routes with tenancy initialization and central domain protection middleware.

```php
Passport::routes(null, ['middleware' => [
    InitializeTenancyByDomain::class, // Or other identification middleware of your choice
    PreventAccessFromCentralDomains::class,
]]);
```

--------------------------------

### Set url_generator config to TenantAwareUrlGenerator

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/spatie.blade.md

Configuration change in the media-library config file to use the custom TenantAwareUrlGenerator class. Make sure to import the class.

```php
'url_generator' => TenantAwareUrlGenerator::class,
```

--------------------------------

### Put tenant into maintenance mode

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenant-maintenance-mode.blade.md

Call putDownForMaintenance() on a tenant object to put it into maintenance mode.

```php
$tenant->putDownForMaintenance();
```

--------------------------------

### Migration: Add custom columns for encrypted tenant attributes

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenant-attribute-encryption.blade.md

Creates the tenants table with custom columns 'tenancy_db_username' and 'tenancy_db_password' as nullable strings of length 512 to hold encrypted data. These columns are filled after tenant creation.

```php
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateTenantsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up(): void
    {
        Schema::create('tenants', function (Blueprint $table) {
            $table->string('id')->primary();

            // Your custom columns
            $table->string('tenancy_db_username', 512)->nullable();
            $table->string('tenancy_db_password', 512)->nullable();

            $table->timestamps();
            $table->json('data')->nullable();
        });
    }
}
```

--------------------------------

### Map tenant Passport keys to config using TenantConfig

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/passport.blade.md

Configure the storage-to-config mapping in the boot method of your TenancyServiceProvider to load tenant-specific Passport keys. This maps the tenant model's passport_public_key and passport_private_key attributes to the passport.public_key and passport.private_key config values.

```php
\Stancl\Tenancy\Features\TenantConfig::$storageToConfigMap = [
    'passport_public_key' => 'passport.public_key',
    'passport_private_key' => 'passport.private_key',
];
```

--------------------------------

### Create tenant impersonation route

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/user-impersonation.blade.md

Define a tenant route that calls UserImpersonation::makeResponse($token) to handle impersonation. Use a controller in production instead of a Closure route because Closure routes cannot be cached.

```jsx
use Stancl\Tenancy\Features\UserImpersonation;

// We're in your tenant routes!

Route::get('/impersonate/{token}', function ($token) {
    return UserImpersonation::makeResponse($token);
});

// Of course use a controller in a production app and not a Closure route.
// Closure routes cannot be cached.
```

--------------------------------

### Configure root_override for local disks in tenancy.filesystem config

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenancy-bootstrappers.blade.md

Override disk roots after tenancy initialization to prevent unwanted Laravel suffixing. %storage_path% is replaced by storage_path()'s output. For a tenant with key 42 and suffix_base 'tenant', Storage::disk('local')->path('') returns '/$path_to_your_application/storage/tenant42/app'.

```php
// Tenancy config (tenancy.filesystem.root_override)
// %storage_path% gets replaced by storage_path()'s output
// E.g. Storage::disk('local')->path('') will return "/$path_to_your_application/storage/tenant42/app"
// (Given a suffix_base of 'tenant' and a tenant with a key of `42`. Same as in the example above in the Storage path helper section)
'root_override' => [
    'local' => '%storage_path%/app/',
    'public' => '%storage_path%/app/public/',
],
```

--------------------------------

### Generate impersonation token

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/user-impersonation.blade.md

Generate an impersonation token using tenancy()->impersonate() with the tenant, user id, and redirect URL. The token is used to redirect the user to the impersonation route.

```jsx
// Let's say we want to be redirected to the dashboard
// after we're logged in as the impersonated user.
$redirectUrl = '/dashboard';

$token = tenancy()->impersonate($tenant, $user->id, $redirectUrl);
```

--------------------------------

### Update livewire.temporary_file_upload.middleware config

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/livewire.blade.md

Update the livewire.temporary_file_upload.middleware config to include the tenancy middleware as well.

```php
// config/livewire.php

'livewire.temporary_file_upload.middleware' => ['throttle:60,1', 'universal', InitializeTenancyByDomain::class],
```

--------------------------------

### Tenant model: Define custom columns for encrypted attributes

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenant-attribute-encryption.blade.md

Defines the getCustomColumns method on the Tenant model to include the custom columns 'tenancy_db_username' and 'tenancy_db_password' along with 'id'.

```php
public static function getCustomColumns(): array
{
    return [
        'id',
        'tenancy_db_username',
        'tenancy_db_password',
    ];
}
```

--------------------------------

### Redirect with path identification

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/user-impersonation.blade.md

Redirect to the impersonation route using the tenant id as a prefix. Ensure you use the correct prefix for your routes.

```jsx
// Make sure you use the correct prefix for your routes.
return redirect("{$tenant->id}/impersonate/{$token->token}");
```

--------------------------------

### Configure database queue driver to use central connection

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/queues.blade.md

Add this line to the `queue.connections.database` config to force the database queue driver to use the central database connection. Replace `central` with your central connection name.

```jsx
'connection' => 'central',
```

--------------------------------

### Redirect with domain identification

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/features/user-impersonation.blade.md

Redirect to the impersonation route using the tenant's primary domain. This is not part of the package; you must implement the concept of primary domains yourself.

```jsx
// Note: This is not part of the package, it's up to you to implement
// a concept of "primary domains" if you need them. Or maybe you use
// one domain per tenant. The package lets you do anything you want.
$domain = $tenant->primary_domain;
return redirect("https://$domain/impersonate/{$token->token}");
```

--------------------------------

### Set custom tenant attributes and save

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenants.blade.md

Two equivalent ways to set custom attributes: using update() with an array or setting individual properties and calling save(). Attributes without dedicated columns are stored in the JSON data column.

```php
$tenant->update([
    'attributeThatHasNoColumn' => 'value', // stored in the `data` JSON column
    'plan' => 'free' // stored in the dedicated `plan` column (see below)
]);
```

```php
$tenant->customAttribute = 'value'; // stored in the `data` JSON column
$tenant->plan = 'free'; // stored in the `plan` column (see below)
$tenant->save();
```

--------------------------------

### Selective Event Faking with Event::fake([MyEvent::class])

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/testing.blade.md

Use this to fake only specific events, avoiding the risk of breaking tenancy initialization and related processes that rely on events.

```php
Event::fake([MyEvent::class]);
```

--------------------------------

### Update Livewire middleware_group in config/livewire.php

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/livewire.blade.md

Change the Livewire middleware group in config/livewire.php to include the tenancy middleware. The first block shows the original setting, the second shows the required replacement.

```php
'middleware_group' => ['web'],
```

```php
'middleware_group' => [
    'web',
    'universal',
    InitializeTenancyByDomain::class, // or whatever tenancy middleware you use
],
```

--------------------------------

### Set tenant_model in config/tenancy.php

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/quickstart.blade.md

Modify the 'tenant_model' line in config/tenancy.php to point to the custom Tenant model.

```php
'tenant_model' => \App\Models\Tenant::class,
```

--------------------------------

### Queue a job pipeline with shouldBeQueued

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/event-system.blade.md

Sets the pipeline to be queued by calling shouldBeQueued(true). This is the third step in creating a pipeline.

```php
use Stancl\Tenancy\Events\TenantCreated;
use Stancl\JobPipeline\JobPipeline;
use Stancl\Tenancy\Jobs\{CreateDatabase, MigrateDatabase, SeedDatabase};

JobPipeline::make([
    CreateDatabase::class,
    MigrateDatabase::class,
    SeedDatabase::class,
])->send(function (TenantCreated $event) {
    return $event->tenant;
})->shouldBeQueued(true),
```

--------------------------------

### Create TenantAwareUrlGenerator class for laravel-medialibrary

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/spatie.blade.md

Custom URL generator extending DefaultUrlGenerator that overrides getUrl() to generate tenant-aware media URLs using asset() and versionUrl().

```php
use Spatie\MediaLibrary\Support\UrlGenerator\DefaultUrlGenerator;

class TenantAwareUrlGenerator extends DefaultUrlGenerator
{
    public function getUrl(): string
    {
        $url = asset($this->getPathRelativeToRoot());

        $url = $this->versionUrl($url);

        return $url;
    }
}
```

--------------------------------

### Customize onFail logic for domain middleware

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenant-identification.blade.md

Override the static $onFail property to redirect to a central domain when tenant identification fails.

```php
\Stancl\Tenancy\Middleware\InitializeTenancyByDomain::$onFail = function ($exception, $request, $next) {
    return redirect('https://my-central-domain.com/');
};
```

--------------------------------

### Create Passport clients in tenant database seeder for shared keys

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/passport.blade.md

Add this code to your tenant database seeder to create a password grant client and a personal access client. The seeder class is configured in config/tenancy.php under the seeder_parameters key. After seeding, run php artisan passport:keys to generate the key pair.

```php
public function run()
{
    $client = new ClientRepository();

    $client->createPasswordGrantClient(null, 'Default password grant client', 'http://your.redirect.path');
    $client->createPersonalAccessClient(null, 'Default personal access client', 'http://your.redirect.path');
}
```

--------------------------------

### Add laravel-permission cache key listeners to TenancyServiceProvider

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/spatie.blade.md

Event listeners for TenancyBootstrapped and TenancyEnded that set a tenant-specific cache key for the permission registrar. This prevents permission cache collisions between tenants and the central app.

```php
Events\TenancyBootstrapped::class => [
    function (Events\TenancyBootstrapped $event) {
        $permissionRegistrar = app(\Spatie\Permission\PermissionRegistrar::class);
        $permissionRegistrar->cacheKey = 'spatie.permission.cache.tenant.' . $event->tenancy->tenant->getTenantKey();
    }
],

Events\TenancyEnded::class => [
    function (Events\TenancyEnded $event) {
        $permissionRegistrar = app(\Spatie\Permission\PermissionRegistrar::class);
        $permissionRegistrar->cacheKey = 'spatie.permission.cache';
    }
],
```

--------------------------------

### Grant all privileges to Sail user in MySQL

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/sail.blade.md

Run these SQL statements in the Sail MySQL shell as root to allow the default Sail user (e.g., 'sail') to perform operations on tenant databases. Must be re-run every time the container is re-created.

```sql
GRANT ALL PRIVILEGES ON *.* TO 'sail'@'%' WITH GRANT OPTION;
FLUSH PRIVILEGES;
```

--------------------------------

### Passport storage and key path configuration

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/integrations/passport.blade.md

Configuration for Passport 10.x to use the default database connection and set a custom key path. The 'storage' section is only needed for Passport 10.x.

```php
return [
    'storage' => [ // Needed only when using Passport 10.x
        'database' => [
            'connection' => null,
        ],
    ],
    'key_path' => env('OAUTH_KEY_PATH', 'storage') // This is optional
];
```

--------------------------------

### Disabling tenant scope with withoutTenancy()

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/single-database-tenancy.blade.md

To make a global query, add withoutTenancy() to your query to disable the tenant scope.

```php
withoutTenancy()
```

--------------------------------

### Clear tenant cache with artisan command

Source: https://github.com/stancl/tenancy-docs/blob/master/source/docs/v3/tenancy-bootstrappers.blade.md

Use this artisan command to clear the cache for a specific tenant by tag. Requires a cache store that supports tagging, such as Redis.

```php
php artisan cache:clear --tag=tenant_123
```
Tokens:
Raw