> ## Documentation Index
> Fetch the complete documentation index at: https://filamentphp.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Getting Started
export const EditOnGitHub = ({version, path}) => {
const url = `https://github.com/filamentphp/filament/edit/${version}/${path}`;
return ;
};
export const Footer = () => {
const sponsorsByTier = JSON.parse(`{
"agency_partner": [
{
"name": "Kirschbaum",
"url": "https://kirschbaumdevelopment.com/solutions/filament-development",
"filename": "kirschbaum.svg"
}
],
"gold": [
{
"name": "Agiledrop",
"url": "https://www.agiledrop.com/laravel?utm_source=filament",
"filename": "agiledrop.svg"
},
{
"name": "Baiz.ai",
"url": "https://baiz.ai",
"filename": "baiz-ai.svg"
},
{
"name": "CMS Max",
"url": "https://cmsmax.com?ref=filamentphp.com",
"filename": "cms-max.svg"
},
{
"name": "Mailtrap",
"url": "https://mailtrap.io/email-sending?utm_source=community&utm_medium=referral&utm_campaign=filament",
"filename": "mailtrap.svg"
},
{
"name": "SerpApi",
"url": "https://serpapi.com/?utm_source=filamentphp",
"filename": "serpapi.svg"
}
]
}`);
function shuffleArray(items) {
const result = [...items];
for (let index = result.length - 1; index > 0; index--) {
const randomIndex = Math.floor(Math.random() * (index + 1));
[result[index], result[randomIndex]] = [result[randomIndex], result[index]];
}
return result;
}
const sponsors = Object.entries(sponsorsByTier).flatMap(([, sponsors]) => shuffleArray(sponsors));
return ;
};
You are currently viewing the documentation for Filament 1.x, which is a previous version of Filament.
Looking for the current stable version? Visit the [5.x documentation](/docs/5.x/getting-started).
Filament is a content management framework for rapidly building a beautiful administration interface designed for humans.
> Filament requires Laravel 8.x or higher, and PHP 7.4 or higher.
Installation:
```bash theme={"theme":"gruvbox-dark-hard"}
composer require filament/filament
php artisan migrate
```
Create an administrator account for your admin panel by running
```bash theme={"theme":"gruvbox-dark-hard"}
php artisan make:filament-user
```
and answering the input prompts. Administrators have access to all areas of Filament, and are able to manage other users.
Once you have a user account, you can sign in to the admin panel by visiting `/admin` in your browser.
To start building your admin panel, [create a resource](./resources).
## Configuration
If you'd like to expose advanced configuration options for Filament, you may publish its configuration file:
```bash theme={"theme":"gruvbox-dark-hard"}
php artisan vendor:publish --tag=filament-config
```
> If you have published the configuration file for Filament, please ensure that you republish it when you upgrade.
## Users
By default, Filament includes its own authentication guard and users table that is completely separate from your app's users table. This enables you to get up and running with Filament at record speed.
Some projects may choose to allow their app users access to Filament. In this case, they may customize the auth guard that Filament uses by [configuring](#configuration) `auth.guard` to the name of your default guard, typically `web`.
The next step is to prepare your `User` model for use with Filament. Implement the `Filament\Models\Contracts\FilamentUser` interface, and apply the `Filament\Models\Concerns\IsFilamentUser` trait. These provide Filament with an API that it can use to interact with your existing user data:
```php theme={"theme":"gruvbox-dark-hard"}
group === 'Filament Users';
}
```
Filament implements authorization features in its default users table. Admin users are able to access all areas of Filament, and manage other users. Users may have roles, which are associated with certain permissions in your admin panel.
To configure columns to granting users admin permissions and roles, you may set the static `$filamentAdminColumn` and `$filamentRolesColumn` properties on your class:
```php theme={"theme":"gruvbox-dark-hard"}
public static $filamentAdminColumn = 'is_filament_admin'; // The name of a boolean column in your database.
public static $filamentRolesColumn = 'filament_roles'; // The name of a JSON column in your database.
```
To disable roles and admin features, just omit these properties from your class.
Alternatively, you may specify custom logic for calculating if a user has admin permissions by overriding the `isFilamentAdmin()` method:
```php theme={"theme":"gruvbox-dark-hard"}
public function isFilamentAdmin()
{
return $this->email === 'dan@danharrin.com';
}
```
Finally, for the correct reset password URL to be sent, you should implement a `sendPasswordResetNotification($token)` function. You can use the `Filament\Models\Concerns\SendsFilamentPasswordResetNotification` trait to add this functionality to your User model, fully integrated with Filament:
```php theme={"theme":"gruvbox-dark-hard"}
If you have published the stubs for Filament, please ensure that you republish them when you upgrade.
## Upgrade Guide
To upgrade Filament to the latest version, you may run:
```bash theme={"theme":"gruvbox-dark-hard"}
php artisan filament:upgrade
```
or the following commands manually:
```bash theme={"theme":"gruvbox-dark-hard"}
composer update
php artisan migrate
php artisan livewire:discover
php artisan route:clear
php artisan view:clear
```
)}
Your logo here