Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/FriendsOfFlarum/passport

The Laravel passport compatible oauth extension for your Flarum forum.
https://github.com/FriendsOfFlarum/passport

flagrow flarum flarum-extension laravel-passport sso

Last synced: 3 months ago
JSON representation

The Laravel passport compatible oauth extension for your Flarum forum.

Host: GitHub
URL: https://github.com/FriendsOfFlarum/passport
Owner: FriendsOfFlarum
License: mit
Created: 2017-03-17T20:37:19.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-11-12T12:46:48.000Z (8 months ago)
Last Synced: 2024-03-24T14:15:33.746Z (3 months ago)
Topics: flagrow, flarum, flarum-extension, laravel-passport, sso
Language: PHP
Homepage: https://discuss.flarum.org/d/5203
Size: 315 KB
Stars: 27
Watchers: 3
Forks: 10
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-flarum - FoF Passport - The [Laravel Passport](https://laravel.com/docs/passport) compatible oauth extension. (Extensions / Others ([:top:](#table-of-contents)))

README

        # Passport by FriendsOfFlarum

[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/FriendsOrFlarum/passport/blob/master/LICENSE.md) [![Latest Stable Version](https://img.shields.io/packagist/v/fof/passport.svg)](https://packagist.org/packages/fof/passport) [![Total Downloads](https://img.shields.io/packagist/dt/fof/passport.svg)](https://packagist.org/packages/fof/passport)

The [Laravel Passport](https://laravel.com/docs/passport) compatible oauth extension.

## Installation

```bash

composer require fof/passport:*

```

## Updating from Flagrow

This extension replaces [Flagrow Passport](https://packagist.org/packages/flagrow/passport).

To upgrade from the old extension to the new one:

- **Backup your data!**

- Disable the Passport extension in the admin panel.

- Run:

```sh

composer require fof/passport:*

```

Composer should let you know that `flagrow/passport` has been automatically removed.

- Enable the new extension in the admin panel.

- Your existing settings will be migrated to FoF Passport automatically.

- You should be good to go! All URLs stay the same.

## Configuration

In the extension settings, you have to fill the following data:

Setting | Example | Description

--- | --- | ---

OAuth authorization url | `https://example.com/oauth/authorize` | `/oauth/authorize`

OAuth token url | `https://example.com/oauth/token` | `/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](https://fontawesome.com/icons?m=free)

**Hint:** When creating the OAuth client in your Laravel app, don't forget to set the `redirect` value to `/auth/passport` or you might encounter `invalid_client` errors.

## Links

- [Flarum Discuss post](https://discuss.flarum.org/d/5203)

- [Source code on GitHub](https://github.com/FriendsOfFlarum/passport)

- [Report an issue](https://github.com/FriendsOfFlarum/passport/issues)

- [Download via Packagist](https://packagist.org/packages/fof/passport)

An extension by [FriendsOfFlarum](https://github.com/FriendsOfFlarum)