Deploying to production

Introduction

Deploying a Laravel app using Filament to production is similar to deploying any other Laravel app. However, there are a few additional steps you should take to ensure that your Filament panel is optimized for performance and security.

Ensure that users are authorized to access panels

When Filament detects that your app's APP_ENV is not local, it will require you to set up authorization for your users. This is to ensure that only authorized users can access your Filament panel in production, while keeping the local environment easy to get started with.

To authorize users to access a panel, you should follow the guide in the users section.

NOTE

If you do not follow these steps and your user model does not implement the FilamentUser interface, no users will be able to sign in to your panel in production.

Improving Filament panel performance

Optimizing Filament for production

To optimize Filament for production, you should run the following command in your deployment script:

php artisan filament:optimize

This command will cache the Filament components and additionally the Blade icons, which can significantly improve the performance of your Filament panels. This command is a shorthand for the commands php artisan filament:cache-components and php artisan icons:cache.

To clear the caches at once, you can run:

php artisan filament:optimize-clear

Caching Filament components

If you're not using the filament:optimize command, you may wish to consider running php artisan filament:cache-components in your deployment script, especially if you have large numbers of components (resources, pages, widgets, relation managers, custom Livewire components, etc.). This will create cache files in the bootstrap/cache/filament directory of your application, which contain indexes for each type of component. This can significantly improve the performance of Filament in some apps, as it reduces the number of files that need to be scanned and auto-discovered for components.

However, if you are actively developing your app locally, you should avoid using this command, as it will prevent any new components from being discovered until the cache is cleared or rebuilt.

You can clear the cache at any time without rebuilding it by running php artisan filament:clear-cached-components.

Caching Blade Icons

If you're not using the filament:optimize command, you may wish to consider running php artisan icons:cache locally, and also in your deployment script. This is because Filament uses the Blade Icons package, which can be much more performant when cached.

Enabling OPcache on your server

From the Laravel Forge documentation:

TIP

Optimizing the PHP OPcache for production will configure OPcache to store your compiled PHP code in memory to greatly improve performance.

Please use a search engine to find the relevant OPcache setup instructions for your environment.

Optimizing your Laravel app

You should also consider optimizing your Laravel app for production by running php artisan optimize in your deployment script. This will cache the configuration files and routes.

Ensuring assets are up to date

During the Filament installation process, Filament adds the php artisan filament:upgrade command to the composer.json file, in the post-autoload-dump script. This command will ensure that your assets are up to date whenever you download the package.

We strongly suggest that this script remains in your composer.json file, otherwise you may run into issues with missing or outdated assets in your production environment. However, if you must remove it, make sure that the command is run manually in your deployment process.