tobymaxham/zhylon-oauth

Zhylon OAuth2 Provider for Laravel Socialite

1.0.0 2021-11-21 22:07 UTC

This package is auto-updated.

Last update: 2024-10-22 04:41:46 UTC


README

Latest Version on Packagist Tests Total Downloads

Installation

composer require tobymaxham/zhylon-oauth

Configuration & Basic Usage

As a registered MX-User or Team Member at Zhylon Systems, you can create an OAuth-Clients for your application.

Add configuration to config/services.php

'zhylon' => [    
   'client_id' => env('ZHYLON_CLIENT_ID'),  
   'client_secret' => env('ZHYLON_CLIENT_SECRET'),  
   'redirect' => env('ZHYLON_REDIRECT_URI'), 
],

If you need to configure another Zhylon-Server-Instance, you can also configure this instance by adding the following configuration:

'zhylon' => [
   ...
   'instance' => env('ZHYLON_INSTANCE_URI', 'https://zhylon.de'),
],

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('zhylon')->redirect();

Returned User fields

  • id
  • name
  • email
  • profile_photo_url

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.