socialiteproviders/lichess

Lichess Provider for Laravel Socialite

4.0.0 2021-09-30 23:17 UTC

Requires

• php: ^7.2 || ^8.0
• ext-json: *
• socialiteproviders/manager: ~4.0

MIT

• Waxmatuct

• oauth
• provider
• laravel
• socialite
• lichess

README

composer require socialiteproviders/lichess

Installation & Basic Usage

Please see the Base Installation Guide, then follow the provider specific instructions below.

Add configuration to config/services.php

'lichess' => [
  'client_id' => env('LICHESS_CLIENT_ID'),
  'client_secret' => env('LICHESS_CLIENT_SECRET'),
  'redirect' => env('LICHESS_REDIRECT_URI')
],

According to Lichess.org API reference (2.0.0) Lichess supports unregistered and public clients (no client authentication, choose any unique LICHESS_CLIENT_ID). LICHESS_CLIENT_SECRET is not needed and can be empty. Access tokens are long-lived (expect one year), unless they are revoked. Refresh tokens are not supported.

Add provider event listener

Laravel 11+

In Laravel 11, the default EventServiceProvider provider was removed. Instead, add the listener using the listen method on the Event facade, in your AppServiceProvider boot method.

• Note: You do not need to add anything for the built-in socialite providers unless you override them with your own providers.

Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
    $event->extendSocialite('lichess', \SocialiteProviders\Lichess\Provider::class);
});

Laravel 10 or below

Configure the package's listener to listen for `SocialiteWasCalled` events.

Add the event to your listen[] array in app/Providers/EventServiceProvider. See the Base Installation Guide for detailed instructions.

protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        // ... other providers
        \SocialiteProviders\Lichess\LichessExtendSocialite::class.'@handle',
    ],
];

Usage

You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed):

return Socialite::driver('lichess')->redirect();

Returned User fields

• id
• username
• email