Installation Guide
This section will guide you through the installation process of Filament Tenancy in your Laravel application.
Installation Options
Section titled “Installation Options”Filament Tenancy offers two installation methods:
-
Quick Installation - Recommended for most users. Uses an interactive installer that automates the entire process.
-
Manual Installation - For users who prefer complete control over each step of the process.
Which Method to Choose?
Section titled “Which Method to Choose?”Use Quick Installation if:
Section titled “Use Quick Installation if:”- ✅ 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
Use Manual Installation if:
Section titled “Use Manual Installation if:”- ✅ 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
Installation Process
Section titled “Installation Process”Regardless of the method you choose, the process includes:
- Package Installation - Install via Composer
- Database Configuration - Configure database connection
- File Publishing - Publish configuration files and migrations
- Migration Execution - Create necessary tables
- Central Database Configuration - Setup central roles and permissions
- Service Registration - Register ServiceProvider and Middleware
Post-Installation Verification
Section titled “Post-Installation Verification”After installation, verify that everything is working:
# Verify that the command is availablephp artisan filament-tenancy:install --help
# Verify configurationphp artisan config:show filament-tenancy
# Verify migrationsphp artisan migrate:statusNext Steps
Section titled “Next Steps”Once installation is complete:
- Review the initial configuration
- Configure the central database
- Proceed to the basic usage guide
Troubleshooting
Section titled “Troubleshooting”If you encounter problems during installation:
- Review common errors
- Consult the troubleshooting section
- Verify that you meet the system requirements