Jump to content

Extension:AuthFlarum

From mediawiki.org
MediaWiki extensions manual
AuthFlarum
Release status: stable
Implementation User identity
Description Allows to connect to MediaWiki from a Flarum account.
Author(s) Guillaume Kulakowski (Llaumguitalk)
Latest version 1.0.0 (2023-04-22)
Compatibility policy Main branch maintains backward compatibility.
MediaWiki >= 1.36.0
PHP 8.0+
Database changes No
Composer llaumgui/mw-auth-flarum
AuthFlarum
  • $wgAuthFlarumAutoCreateNeedGroup
  • $wgAuthFlarumAutoCreateMinPost
  • $wgAuthFlarumUri
  • $wgAuthFlarumAutoCreate
Licence GNU General Public License 2.0 or later
Download
README

The AuthFlarum extension allows to connect to MediaWiki from an account based on the Flarum forum software. Requires Flarum 1.0.0 or later.

Installation

[edit]
  • Download and place the file(s) in a directory called AuthFlarum in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'AuthFlarum' );
    
  • Configure as necessary by adding the relevant parameters below the extension's call.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

[edit]
The $wgAuthFlarum prefix has been omitted in the parameter names for brevity.
Parameter Description Type Default
Uri URI of your Flarum instance. String http://localhost
AutoCreate Whether to allow auto creation of a MediaWiki account from Flarum. Be careful! This requires the following present in LocalSettings.php:
$wgGroupPermissions['*']['autocreateaccount'] = true;
$wgGroupPermissions['*']['createaccount'] = false;
$wgGroupPermissions['sysop']['createaccount'] = false;
Boolean true
AutoCreateMinPost Require at least this number of posts to allow auto creation of a MediaWiki account. Integer 100
AutoCreateNeedGroup Require a Flarum account to belong to an specific group to allow auto creation of a MediaWiki account. Integer 0