fof/oauth

Allow users to log in with GitHub, Twitter, Facebook, Google, and more!

Fund package maintenance!
Website

Installs: 11 126

Dependents: 8

Suggesters: 0

Security: 0

Stars: 27

Watchers: 8

Forks: 11

Open Issues: 11

Type:flarum-extension


README

License Latest Stable Version OpenCollective Donate

A Flarum extension. Allow users to log in with GitHub, Twitter, Facebook, Discord, GitLab, Google and LinkedIn!

Installation

composer require fof/oauth:"*"

Updating

composer update fof/oauth

Configuration

Translation

You can replace the text for the forum sign in buttons in two ways.

  • Use fof-oauth.forum.providers.<name> to replace the name of the provider on the forum side
  • Use fof-oauth.forum.log_in.with_<name>_button to replace the entire button "Log In with " text

Extending

It is possible to add additional Providers using an extender. See 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

OpenCollective GitHub

An extension by FriendsOfFlarum.