README

Log in to your Flarum forum with MediaWiki OAuth2. An addon for FoF OAuth.

This extension enables users to authenticate with any MediaWiki installation that supports OAuth2 (MediaWiki 1.35+, with the OAuth extension installed).

Installation

Install with composer:

composer require songnguxyz/oauth-mediawiki
php flarum migrate
php flarum cache:clear

Updating

composer update songnguxyz/oauth-mediawiki
php flarum cache:clear

Setup

1. Enable the OAuth extension on your MediaWiki installation. See MediaWiki OAuth documentation for details.

2. Register an OAuth2 consumer on your MediaWiki:

   • Go to Special:OAuthConsumerRegistration/propose on your wiki
   • Select "OAuth 2.0" as the OAuth protocol version (Propose an OAuth 2.0 client)
   • Fill in the required details, including the callback URL from your Flarum OAuth settings
   • Request the necessary grants (at minimum: mwoauth-authonly for authentication)
   • Note down the Client Key and Client Secret provided

3. In your Flarum admin panel, enable this extension and configure:

   • MediaWiki Base URL: Your MediaWiki REST API base URL (e.g., https://yourwiki.example.com/w/rest.php). This is the URL where the OAuth2 endpoints are available.
   • Client Key: The client Key from step 2
   • Client Secret: The client secret from step 2

4. Log in with MediaWiki!

Links

• Packagist
• GitHub
• MediaWiki OAuth Documentation
• Help translate the extension!