tobymaxham/zhylon-auth

Zhylon OAuth2 Provider for Laravel Socialite

v1.1 2024-04-14 23:45 UTC

This package is auto-updated.

Last update: 2024-10-31 23:55:43 UTC


README

This package is a LaravelSocialite driver for the Zhylon oAuth service. To register for the service visit https://id.zhylon.net.

Composer install package

composer require tobymaxham/zhylon-auth

Prepare your User model

Since the package will fill the user model with the data from the oAuth provider, you need to add some fields to your user model fillable array.

protected $fillable = [
    'zhylon_id',
    'zhylon_token',
    'zhylon_refresh_token',
];

Config and Migration

php artisan vendor:publish
php artisan migrate

Change you .env file:

ZHYLON_AUTH_CLIENT_ID=YOUR_CLIENT_ID
ZHYLON_AUTH_CLIENT_SECRET=YOUR_CLIENT_SECRET
ZHYLON_AUTH_CALLBACK_WEBSITE="https://your-website.com"

If you want you could also change some project specific settings:

ZHYLON_AUTH_SITE_PATH="/auth/zhylon"
ZHYLON_AUTH_BASE_URI="https://id.zhylon.net"
ZHYLON_AUTH_HOME="/dashboard"

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

If you've found a bug regarding security please mail git@maxham.de instead of using the issue tracker.

Credits

License

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