Installation
- Requirements
- Installation
- Deploying to production
- Publishing the configuration
- Publishing the translations
- Upgrade Guide
Requirements
Filament has a few requirements to run:
- PHP 8.0+
- Laravel v8.0+
- Livewire v2.0+
This package is compatible with other Filament v2.x products. The form builder and table builder come pre-installed with the package, and no other installation steps are required to use them within the admin panel.
Installation
To get started with the admin panel, you can install it using the command:
composer require filament/filament:"^2.0"
Each time you upgrade Filament, you need to run the filament:upgrade
command. We recommend adding this to your composer.json
's post-update-cmd
:
"post-update-cmd": [ // ... "@php artisan filament:upgrade"],
If you don't have one, you may create a new user account using:
php artisan make:filament-user
Visit your admin panel at /admin
to sign in, and you're now ready to start building resources!
Deploying to production
By default, all App\Models\User
s can access Filament locally. To allow them to access Filament in production, you must take a few extra steps to ensure that only the correct users have access to the admin panel.
Please see the Users page.
If you don't complete these steps, there will be a 403 error when you try to access the admin panel in production.
Publishing the configuration
If you wish, you may publish the configuration of the package using:
php artisan vendor:publish --tag=filament-config
Publishing the translations
If you wish to translate the package, you may publish the language files using:
php artisan vendor:publish --tag=filament-translations
Upgrade Guide
To upgrade the package to the latest version, you must run:
php artisan config:clearphp artisan livewire:discoverphp artisan route:clearphp artisan view:clear
Alternatively, you may use the filament:upgrade
command to do this all at once:
composer updatephp artisan filament:upgrade
We recommend adding these commands to your composer.json
's post-update-cmd
:
"post-update-cmd": [ // ... "@php artisan filament:upgrade"],
Still need help? Join our Discord community or open a GitHub discussion