> ## Documentation Index
> Fetch the complete documentation index at: https://filament-34a8cf01.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> [!WARNING]
>
> You are currently viewing the documentation for Filament 2.x, which is a previous version of Filament.
>
> Looking for the current stable version? Visit the [5.x documentation](https://filament-34a8cf01.mintlify.site/5.x).

## 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](https://filament-34a8cf01.mintlify.site/2.x/forms/installation.md), [table builder](https://filament-34a8cf01.mintlify.site/2.x/tables/installation.md) and [notifications](https://filament-34a8cf01.mintlify.site/2.x/notifications/installation.md) 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:

```bash theme={"theme":"gruvbox-dark-hard"}
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`:

```json theme={"theme":"gruvbox-dark-hard"}
"post-update-cmd": [
    // ...
    "@php artisan filament:upgrade"
],
```

If you don't have one, you may create a new user account using:

```bash theme={"theme":"gruvbox-dark-hard"}
php artisan make:filament-user
```

Visit your admin panel at `/admin` to sign in, and you're now ready to start [building resources](./resources)!

[![](https://user-images.githubusercontent.com/41773797/147615302-daec5d1c-e3ac-428a-98c2-c3fb40d945b5.png)](https://demo.filamentphp.com)

## 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](https://filament-34a8cf01.mintlify.site/2.x/admin/users.md#authorizing-access-to-the-admin-panel).

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:

```bash theme={"theme":"gruvbox-dark-hard"}
php artisan vendor:publish --tag=filament-config
```

## Publishing translations

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

```bash theme={"theme":"gruvbox-dark-hard"}
php artisan vendor:publish --tag=filament-translations
```

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

```bash theme={"theme":"gruvbox-dark-hard"}
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:

```bash theme={"theme":"gruvbox-dark-hard"}
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:

```json theme={"theme":"gruvbox-dark-hard"}
"post-update-cmd": [
    // ...
    "@php artisan filament:upgrade"
],
```

[Edit this page on GitHub](https://github.com/filamentphp/filament/edit/2.x/packages/admin/docs/01-installation.md)

## Sponsored by

[Your logo here](https://github.com/sponsors/danharrin)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.