This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Lichess Provider for Laravel Socialite

4.0.0 2021-09-30 23:17 UTC

This package is auto-updated.

Last update: 2021-11-17 23:52:59 UTC


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

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@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