Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/friendsofflarum/oauth
Allow users to log in with GitHub, Twitter, Facebook, and more!
https://github.com/friendsofflarum/oauth
facebook flarum friendsofflarum github linkedin oauth twitter
Last synced: 4 days ago
JSON representation
Allow users to log in with GitHub, Twitter, Facebook, and more!
- Host: GitHub
- URL: https://github.com/friendsofflarum/oauth
- Owner: FriendsOfFlarum
- License: mit
- Created: 2020-06-08T15:03:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T08:16:54.000Z (16 days ago)
- Last Synced: 2024-10-29T09:24:53.869Z (16 days ago)
- Topics: facebook, flarum, friendsofflarum, github, linkedin, oauth, twitter
- Language: PHP
- Homepage: https://discuss.flarum.org/d/25182
- Size: 813 KB
- Stars: 44
- Watchers: 9
- Forks: 16
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# OAuth by FriendsOfFlarum
 [](https://packagist.org/packages/fof/oauth) [](https://packagist.org/packages/fof/oauthh) [](https://opencollective.com/fof/donate)
A [Flarum](http://flarum.org) extension. Allow users to log in with various OAuth providers
### Bundled providers
By default these providers are included:
- Discord
- Facebook
- Github
- Gitlab
- Google
- LinkedIn
- Twitter
### Permissions
This extension provides the ability to view the status of linked OAuth providers (intended for admin and/or moderator use). In order for this to function correctly, you must also set the permission `Moderate Access Tokens` to at least the same group as you require for `Moderate user's linked accounts`.
### Additional providers
Additional OAuth providers are available for this extension. Here's a handy list of known extensions, let us know if you know of any more and we'll get them added!
- [Amazon](https://extiverse.com/extension/ianm/oauth-amazon)
- [Apple](https://extiverse.com/extension/blomstra/oauth-apple)
- [Slack](https://extiverse.com/extension/blomstra/oauth-slack)
- [Line](https://extiverse.com/extension/ianm/oauth-line)
- [Microsoft](https://github.com/imorland/flarum-ext-oauth-microsoft) *experimental
- [Twitch](https://github.com/imorland/flarum-ext-oauth-twitch)
- [Auth0](https://extiverse.com/extension/lodge104/flarum-ext-oauth-auth0)
### Screenshots
Default provider settings example
Login/signup example with `Github`, `Twitter`, `Twitch` and `Google` enabled.
### Installation
```sh
composer require fof/oauth
```
### Updating
```sh
composer update fof/oauth
php flarum cache:clear
```
### Configuration
#### Translation
You can replace the text for the forum sign in buttons in two ways.
- Use `fof-oauth.forum.providers.` to replace the name of the provider on the forum side
- Use `fof-oauth.forum.log_in.with__button` to replace the entire button "Log In with " text
### Extending
It is possible to add additional `Providers` using an extender. See [OAuth-Amazon](https://github.com/imorland/flarum-ext-oauth-amazon) for an example of how to accomplish this but basically:
- In your new extension, require `fof/oauth` as a dependency
- Define a new `Provider` which extends `FoF\OAuth\Provider`
- From your new extensions `extend.php`, register the provider `(new FoF\OAuth\Extend\RegisterProvider(MyNewProvider::class))`
- Provide the required translations under the `fof-oauth` namespace. See the linked example extension for details on which keys are required.
- (optionally) Provide an admin panel link to `fof/oauth` for easy configuration. Again, see the linked example.
- (optionally) Provide any CSS required to style your new login button. See the linked example.
### Links
[](https://opencollective.com/fof/donate)
- [Discuss](https://discuss.flarum.org/d/25182)
- [Packagist](https://packagist.org/packages/fof/oauth)
- [GitHub](https://github.com/FriendsOfFlarum/oauth)
An extension by [FriendsOfFlarum](https://github.com/FriendsOfFlarum).