Laravel Nova

In the central app

If you wish to use Laravel Nova in the central application (to manage tenants), you need to make a small change to the Nova migrations, they expect your model primary keys to always be unsigned big integers, but your tenants might be using string ids.

You can find the full Nova setup for managing tenants in the SaaS boilerplate. It also implements Nova for both the central and tenant parts of the app, with separate resources.

In the tenant app

To use Nova inside of the tenant part of your application, do the following:

• Publish the Nova migrations and move them to the database/migrations/tenant directory.

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

• Prevent Nova from adding its migrations to your central migrations by adding Nova::ignoreMigrations() to NovaServiceProvider::boot() (Don't do this if you want to use Nova both in the central & tenant parts of the app.)

• Add the tenancy middleware to your nova.middleware config. Example:

  '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,
  ],
  

• In your NovaServiceProvider's routes() method, replace the following lines:

  ->withAuthenticationRoutes()
  ->withPasswordResetRoutes()
  

  with these lines:

  ->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',
  ])
  

• Set the domain in Nova config to null

Tenant file thumbnails and previews

To make the file field previews show correctly, you have to call thumbnail(fn ($value, $disk) => tenant_asset($value)) and preview(fn ($value, $disk) => tenant_asset($value)) on the field.

For example:

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

Important: make sure to update TenantAssetsController::$tenancyMiddleware to the identification middleware of your choice.

E.g. if you're using InitializeByDomainOrSubdomain in your app, set TenantAssetsController::$tenancyMiddleware to InitializeByDomainOrSubdomain in TenancyServiceProvider's boot() method:

// In App\Providers\TenancyServiceProvider
public function boot(): void
{
    // ...
    TenantAssetsController::$tenancyMiddleware = InitializeTenancyByDomainOrSubdomain::class;
}