Passport by FriendsOfFlarum
, (*1)
The Laravel Passport compatible oauth extension., (*2)
Installation
composer require fof/passport:*
Updating from Flagrow
This extension replaces Flagrow Passport., (*3)
To upgrade from the old extension to the new one:, (*4)
composer require fof/passport:*
Composer should let you know that flagrow/passport
has been automatically removed., (*8)
-
Enable the new extension in the admin panel., (*9)
-
Your existing settings will be migrated to FoF Passport automatically., (*10)
-
You should be good to go! All URLs stay the same., (*11)
Configuration
In the extension settings, you have to fill the following data:, (*12)
Setting |
Example |
Description |
OAuth authorization url |
https://example.com/oauth/authorize |
<your laravel install>/oauth/authorize |
OAuth token url |
https://example.com/oauth/token |
<your laravel install>/oauth/token |
Api URL providing user details when authenticated |
https://example.com/api/user |
Default Laravel installs have an /api/user route, otherwise point to a route returning the current user data (protected by the passport driver) |
OAuth application id |
1 |
The integer Client ID you've made in the Laravel app or via artisan passport:client
|
OAuth application secret |
abcdefghijABCDEFGHIJabcdefghijABCDEFGHIJ |
The Client secret provided by Laravel once you created the OAuth client |
OAuth scopes to request |
Optional additional scopes to request during authorization, perhaps you want to protect the user url with a scope or add additional functionality |
Label for login button |
Login with Example |
Label to place on the login button |
Icon for login button |
far fa-id-card |
FontAwesome icon to place on the login button. List of available icons
|
Hint: When creating the OAuth client in your Laravel app, don't forget to set the redirect
value to <your flarum install>/auth/passport
or you might encounter invalid_client
errors., (*13)
Links
An extension by FriendsOfFlarum, (*14)