Storing Users in a Database

From a fresh Statamic project

If you installed Statamic using the statamic new command, or created a project based on the statamic/statamic repo, it will be configured to store users in files.

Statamic comes with an Eloquent driver to make the transition as seamless as possible.

1. Ensure you have a database configured.
2. In your user model, cast the preferences column to json.

   class User extends Authenticatable
   {
       protected function casts(): array 
       { 
           return [ 
               'preferences' => 'json', 
           ]; 
       }; 
    
       // ...
   }

3. If you plan to import existing file based users, you'll need to use UUIDs for the primary key. You can do this by adding a trait to your user model:

   class User extends Authenticatable
   {
       use \Illuminate\Database\Eloquent\Concerns\HasUuids; 
    
       // ...
   }

4. In config/statamic/users.php, use the Eloquent repository.

   'repository' => 'file', 
   'repository' => 'eloquent', 

5. In config/auth.php, use the Eloquent provider:

   'providers' => [
       'users' => [
           'driver' => 'statamic', 
           'driver' => 'eloquent', 
           'model' => App\Models\User::class, 
       ]
   ]

6. Generate a migration for the role and user group pivot tables.

   php please auth:migration

   • If you're planning to import existing file based users, edit the migration to change the id & user_id columns to the uuid type.

     Schema::table('users', function (Blueprint $table) {
         $table->uuid('id')->change(); 
         $table->boolean('super')->default(false);
         $table->string('avatar')->nullable();
         $table->json('preferences')->nullable();
         $table->timestamp('last_login')->nullable();
         $table->string('password')->nullable()->change();
     });
      
     Schema::create('role_user', function (Blueprint $table) {
         $table->increments('id');
         $table->integer('user_id');  
         $table->uuid('user_id');  
         $table->string('role_id');
     });
      
     Schema::create('group_user', function (Blueprint $table) {
         $table->increments('id');
         $table->integer('user_id');  
         $table->uuid('user_id');  
         $table->string('group_id');
     });

   • If you've customized your user blueprint, edit the migration so it includes those fields as columns. You can also create a new migration file by running php artisan make:migration. You'll have to manually edit the migration file to reflect your changes. Read up on Laravel database migrations here.

     $table->string('some_field');

7. Run the migrations:

   php artisan migrate

8. If you have existing file based users, import them:

   php please eloquent:import-users

9. If you are using the Statamic forgot password form, add the following method to your User model

   public function sendPasswordResetNotification($token)
   {
       $this->notify(new \Statamic\Notifications\PasswordReset($token));
   }

In an existing Laravel app

If you've installed Statamic into an existing Laravel app, it will already be configured to use the Eloquent driver.

You will need to run migrations to prepare your database for Statamic's user, password reset, and permission setup.

1. Configure the two separate password reset drivers. Unlike a regular Laravel installation, Statamic has a second table to track password activations which are the same as resets, but last a little longer before they expire. This is optional.

   In config/auth.php add the following inside the passwords array:

   'activations' => [
       'provider' => 'users',
       'table' => 'password_activation_tokens',
       'expire' => 4320,
       'throttle' => 60,
   ],

   In config/statamic/users.php change the passwords array to:

   'passwords' => [
       'resets' => 'users',
       'activations' => 'activations',
   ],

2. Create and run the migrations.

   This will add some columns to the users table (like super, and last_login), create the role_user and group_user pivot tables, and create the password_activations table.

   php please auth:migration
   php artisan migrate

3. Optional: If you are using the Statamic forgot password form, add the following method to your User model

   public function sendPasswordResetNotification($token)
   {
       $this->notify(new \Statamic\Notifications\PasswordReset($token));
   }

This assumes you are happy to use our opinionated setup. If you need something more custom you can create your own user driver.