Installation

#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, table builder and notifications 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"
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"
],
"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
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\Users 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 configuration

If you wish, you may publish the configuration of the package using:

php artisan vendor:publish --tag=filament-config
php artisan vendor:publish --tag=filament-config

#Publishing translations

If you wish to translate the package, you may publish the language files using:

php artisan vendor:publish --tag=filament-translations
php artisan vendor:publish --tag=filament-translations

Since this package depends on other Filament packages, you may wish to translate those as well:

php artisan vendor:publish --tag=forms-translations
php artisan vendor:publish --tag=tables-translations
php artisan vendor:publish --tag=filament-support-translations
php artisan vendor:publish --tag=forms-translations
php artisan vendor:publish --tag=tables-translations
php artisan vendor:publish --tag=filament-support-translations

#Upgrading

To upgrade the package to the latest version, you must run:

composer update
php artisan filament:upgrade
composer update
php artisan filament:upgrade

We recommend adding the filament:upgrade command to your composer.json's post-update-cmd to run it automatically:

"post-update-cmd": [
    // ...
    "@php artisan filament:upgrade"
],
"post-update-cmd": [
    // ...
    "@php artisan filament:upgrade"
],

Edit on GitHub

Still need help? Join our Discord community or open a GitHub discussion