Documentation

• Installation
  • Providers
  • Registration flow
  • Domain Allowlist
  • Customizing view
• Usage
  • Filament Fortify
  • Filament Breezy

#Installation

You can install the package via composer:

composer require dutchcodingcompany/filament-socialite

You can publish and run the migrations with:

php artisan vendor:publish --tag="filament-socialite-migrations"
php artisan migrate

You can publish the config file with:

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

This is the contents of the published config file:

return [
    // Allow login, and registration if enabled, for users with an email for one of the following domains.
    // All domains allowed by default
    'domain_allowlist' => [],
 
    // Allow registration through socials
    'registration' => false,
 
    // Specify the providers that should be visible on the login.
    // These should match the socialite providers you have setup in your services.php config.
    'providers' => [
//        'gitlab' => [
//            'label' => 'GitLab',
//            'icon' => 'fab-gitlab',
//        ],
//        'github' => [
//            'label' => 'GitHub',
//            'icon' => 'fab-github',
//        ],
    ],
];

#Providers

You should setup the providers with Socialite and/or Socialite Providers and add them to the providers array in the filament-socialite.php config. You can specify a Blade Icon, with Font Awesome brand icons made available through Blade Font Awesome.

#Registration flow

This package supports account creation for users. However, to support this flow it is important that the password attribute on your User model is nullable. For example, by adding the following to your users table migration.

$table->string('password')->nullable();

#Domain Allowlist

This package supports the option to limit the users that can login with the OAuth login to users of a certain domain. This can be used to setup SSO for internal use.

#Customizing view

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-socialite-views"

#Usage

Add the buttons component to your login page, just above the </form> closing tag:

    <livewire:filament-socialite.buttons />
</form>

You can publish the login page for vanilla Filament by running:

php artisan vendor:publish --tag="filament-views"

Which produces a login page at resources/views/vendor/filament/login.blade.php.

#Filament Fortify

This component can also be added while using the Fortify plugin plugin.

You can publish the login page for Filament Fortify by running:

php artisan vendor:publish --tag="filament-fortify-views"

Which produces a login page at resources/views/vendor/filament-fortify/login.blade.php.

#Filament Breezy

This component can also be added while using the Breezy plugin plugin.

You can publish the login page for Filament Breezy by running:

php artisan vendor:publish --tag="filament-breezy-views"

Which produces a login page at resources/views/vendor/filament-breezy/login.blade.php.