Implementing multitenancy in Laravel allows you to serve multiple clients (tenants) from a single application instance. There are several approaches to achieve this, but two of the most common methods are:
- Single Database with Tenant ID: All tenants share the same database, and each record has a
tenant_idto differentiate data. - Multiple Databases: Each tenant has their own database.
Method 1: Single Database with Tenant ID
Step 1: Create the Tenant Model and Migration
- Create the Tenant Model:
bash
|
1 |
php artisan make:model Tenant -m |
- Define the Migration:
In the migration file, create a tenants table:
php
|
1 2 3 4 5 6 7 8 9 |
public function up() { Schema::create('tenants', function (Blueprint $table) { $table->id(); $table->string('name')->unique(); $table->string('database')->unique(); // If using multiple databases $table->timestamps(); }); } |
Step 2: Update Your Models
Add a tenant_id field to your other models (e.g., Post):
- Create a Migration:
bash
|
1 |
php artisan make:migration add_tenant_id_to_posts_table --table=posts |
- Update the Migration:
php
|
1 2 3 4 5 6 |
public function up() { Schema::table('posts', function (Blueprint $table) { $table->foreignId('tenant_id')->constrained()->onDelete('cascade'); }); } |
Step 3: Define Relationships
In the Tenant model, define the relationship:
php
|
1 2 3 4 5 6 7 8 9 10 11 |
namespace App\Models; use Illuminate\Database\Eloquent\Model; class Tenant extends Model { public function posts() { return $this->hasMany(Post::class); } } |
In the Post model, define the inverse relationship:
php
|
1 2 3 4 5 6 7 8 9 10 11 |
namespace App\Models; use Illuminate\Database\Eloquent\Model; class Post extends Model { public function tenant() { return $this->belongsTo(Tenant::class); } } |
Step 4: Middleware for Tenant Identification
Create middleware to identify the tenant based on the request. For example, you can use subdomains or request headers.
- Create Middleware:
bash
|
1 |
php artisan make:middleware TenantMiddleware |
- Update the Middleware:
php
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
namespace App\Http\Middleware; use Closure; use App\Models\Tenant; class TenantMiddleware { public function handle($request, Closure $next) { // Example: Get tenant from subdomain $subdomain = explode('.', $request->getHost())[0]; $tenant = Tenant::where('name', $subdomain)->firstOrFail(); // Set the tenant in the application (you might want to use a service provider for this) app()->instance('currentTenant', $tenant); return $next($request); } } |
Step 5: Register the Middleware
Register the middleware in app/Http/Kernel.php:
php
|
1 2 3 |
protected $routeMiddleware = [ 'tenant' => \App\Http\Middleware\TenantMiddleware::class, ]; |
Step 6: Use Tenant Data in Queries
In your controllers, use the tenant data:
php
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
namespace App\Http\Controllers; use App\Models\Post; class PostController extends Controller { public function index() { $tenant = app('currentTenant'); $posts = Post::where('tenant_id', $tenant->id)->get(); return view('posts.index', compact('posts')); } } |
Method 2: Multiple Databases
If each tenant has a separate database, you can switch the database connection dynamically.
Step 1: Create Tenant Databases
In your tenants table, store the database names.
Step 2: Configure Database Connection
In your TenantMiddleware, switch the database connection:
php
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
use Illuminate\Support\Facades\DB; class TenantMiddleware { public function handle($request, Closure $next) { // Get the tenant based on subdomain $tenant = Tenant::where('name', $subdomain)->firstOrFail(); // Set the database connection dynamically config(['database.connections.tenant.database' => $tenant->database]); DB::purge('tenant'); return $next($request); } } |
Step 3: Update Database Config
In config/database.php, define a tenant connection:
php
|
1 2 3 4 5 6 7 8 9 10 11 12 |
'tenant' => [ 'driver' => 'mysql', 'host' => env('DB_HOST', '127.0.0.1'), 'database' => '', 'username' => env('DB_USERNAME', 'forge'), 'password' => env('DB_PASSWORD', ''), 'charset' => 'utf8mb4', 'collation' => 'utf8mb4_unicode_ci', 'prefix' => '', 'strict' => true, 'engine' => null, ], |
Conclusion
With these methods, you can implement multitenancy in Laravel either by using a single database with tenant IDs or by utilizing multiple databases. Choose the approach that best fits your application’s requirements. Make sure to test thoroughly to ensure that data isolation and integrity are maintained across tenants.
- Laravel Breeze – Simple authentication starter kit
- Laravel Jetstream – Scaffolding for Laravel apps
- Laravel Passport – API authentication via OAuth2
- Laravel Sanctum – Simple API authentication
- Spatie Laravel Permission – Role and permission management
- Laravel Cashier – Subscription billing with Stripe
- Laravel Scout – Full-text search using Algolia
- Laravel Socialite – OAuth authentication (Google, Facebook, etc.)
- Laravel Excel – Excel import and export for Laravel
- Laravel Horizon – Redis queues monitoring
- Laravel Nova – Admin panel for Laravel
- Laravel Fortify – Backend authentication for Laravel
- Laravel Vapor – Serverless deployment on AWS
- Laravel Telescope – Debugging assistant for Laravel
- Laravel Dusk – Browser testing
- Laravel Mix – API for compiling assets
- Spatie Laravel Backup – Backup management
- Laravel Livewire – Building dynamic UIs
- Spatie Laravel Media Library – Manage media uploads
- Laravel Excel – Excel spreadsheet handling
- Laravel Debugbar – Debug tool for Laravel
- Laravel WebSockets – Real-time communication
- Spatie Laravel Sitemap – Generate sitemaps
- Laravel Spark – SaaS scaffolding
- Laravel Envoy – Task runner for deployment
- Spatie Laravel Translatable – Multilingual model support
- Laravel Backpack – Admin panel
- Laravel AdminLTE – Admin interface template
- Laravel Collective Forms & HTML – Simplified form and HTML generation
- Spatie Laravel Analytics – Google Analytics integration
- Laravel Eloquent Sluggable – Automatically create slugs
- Laravel Charts – Chart integration
- Laravel Auditing – Track changes in models
- Laravel JWT Auth – JSON Web Token authentication
- Laravel Queue Monitor – Monitor job queues
- Spatie Laravel Query Builder – Filter, sort, and include relationships in Eloquent queries
- Laravel Datatables – jQuery Datatables API
- Laravel Localization – Multilingual support for views and routes
- Laravel Acl Manager – Access control list manager
- Laravel Activity Log – Record activity in your app
- Laravel Roles – Role-based access control
- Spatie Laravel Tags – Tagging models
- Laravel Installer – CLI installer for Laravel
- Laravel Breadcrumbs – Generate breadcrumbs in Laravel
- Laravel Mailgun – Mailgun integration for Laravel
- Laravel Trustup Model History – Store model change history
- Laravel Deployer – Deployment automation tool
- Laravel Auth – Custom authentication guards
- Laravel CORS – Cross-Origin Resource Sharing (CORS) support
- Laravel Notifications – Send notifications through multiple channels
- Spatie Laravel Http Logger – Log HTTP requests
- Laravel Permission Manager – Manage permissions easily
- Laravel Stubs – Customize default stubs in Laravel
- Laravel Fast Excel – Speed up Excel exports
- Laravel Image – Image processing
- Spatie Laravel Backup Server – Centralize backups for Laravel apps
- Laravel Forge API – Manage servers through the Forge API
- Laravel Blade SVG – Use SVGs in Blade templates
- Laravel Ban – Ban/unban users from your application
- Laravel API Response – Standardize API responses
- Laravel SEO – Manage SEO meta tags
- Laravel Settings – Store and retrieve settings
- Laravel DOMPDF – Generate PDFs
- Laravel Turbo – Full-stack framework for building modern web apps
- Spatie Laravel Event Sourcing – Event sourcing implementation
- Laravel Jetstream Inertia – Jetstream’s Inertia.js integration
- Laravel Envoy Tasks – Task automation
- Laravel Likeable – Like/dislike functionality
- Laravel GeoIP – Determine visitor’s geographic location
- Laravel Country State City – Dropdowns for country, state, and city
- Laravel Hashids – Generate short unique hashes
- Laravel Repository – Repository pattern for Laravel
- Laravel UUID – UUID generation for models
- Spatie Laravel Medialibrary Pro – Enhanced media management
- Laravel Queue Monitor – Monitor Laravel job queues
- Laravel User Activity – Monitor user activity
- Laravel DB Snapshots – Create database snapshots
- Laravel Twilio – Twilio integration
- Laravel Roles – Role-based permission handling
- Laravel Translatable – Add translations to Eloquent models
- Laravel Teamwork – Manage teams in multi-tenant apps
- Laravel Full Text Search – Add full-text search to Laravel models
- Laravel File Manager – File and media management
- Laravel User Timezones – Automatically detect user time zones
- Laravel ChartsJS – Render charts with ChartsJS
- Laravel Stripe – Stripe API integration
- Laravel PDF Generator – PDF generation
- Laravel Elasticsearch – Elasticsearch integration
- Laravel Simple Qrcode – Generate QR codes
- Laravel Timezone – Manage timezones and conversions
- Laravel Collective API – API management for Laravel
- Laravel Rest API Boilerplate – REST API starter kit
- Laravel Multi Auth – Multi-authentication functionality
- Laravel Voyager – Admin panel for Laravel
- Laravel Voyager Database – Database manager for Voyager
- Laravel Categories – Handle categories for models
- Laravel Multitenancy – Multi-tenancy implementation
- Laravel Access Control – Advanced access control for users
- Laravel Menus – Menu management
- Laravel Translatable Routes – Multilingual route handling