Skip to content

Installation Guide

This section will guide you through the installation process of Filament Tenancy in your Laravel application.

Filament Tenancy offers two installation methods:

  1. Quick Installation - Recommended for most users. Uses an interactive installer that automates the entire process.

  2. Manual Installation - For users who prefer complete control over each step of the process.

  • ✅ This is your first time installing the package
  • ✅ You want the installer to configure everything automatically
  • ✅ You prefer a step-by-step guided process
  • ✅ You want requirements to be automatically verified
  • ✅ You already have experience with the package
  • ✅ You need granular control over each step
  • ✅ You want to customize the configuration from the start
  • ✅ You’re integrating into an existing project with complex configuration

Regardless of the method you choose, the process includes:

  1. Package Installation - Install via Composer
  2. Database Configuration - Configure database connection
  3. File Publishing - Publish configuration files and migrations
  4. Migration Execution - Create necessary tables
  5. Central Database Configuration - Setup central roles and permissions
  6. Service Registration - Register ServiceProvider and Middleware

After installation, verify that everything is working:

Terminal window
# Verify that the command is available
php artisan filament-tenancy:install --help
# Verify configuration
php artisan config:show filament-tenancy
# Verify migrations
php artisan migrate:status

Once installation is complete:

  1. Review the initial configuration
  2. Configure the central database
  3. Proceed to the basic usage guide

If you encounter problems during installation: