Extension:IPBAuthLogin

MediaWiki extensions manual

IPBAuthLogin Release status: beta
Implementation	User access , User identity , User rights
Description	IPBAuthLogin is a MediaWiki extension which authenticates users through an IPB forums database.
Author(s)	Jordan Songer (LordInquisitortalk)
Latest version	1.0.3-beta (2023-02-11)
MediaWiki	1.35+
Database changes	No
License	GNU General Public License 3.0
Download	Download release GitHub: project page git repository URL [help ] commit history Note: No localisation updates are provided by translatewiki.net .
Hooks used UserLoggedIn

The IPBAuthLogin extension makes it possible to authenticates users through an Invision Power Board forums database. Currently the extension supports IPB versions 3.x and 4.x.

Installation

• Download and place the file(s) in a directory called IPBAuthLogin in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'IPBAuthLogin' );
  $wgIPBDBHost = 'forum_db_host';
  $wgIPBDBUsername = 'forum_db_username'; // this account only needs SELECT access to forum DB
  $wgIPBDBPassword = 'forum_db_password';
  $wgIPBDBDatabase = 'forum_db_name';
  $wgIPBDBPrefix = ''; // Leave as empty string unless you have a db prefix for your forum DB tables
  //$wgGroupPermissions['*']['createaccount'] = false; // If uncommented, the only way to create a new wiki account will be logging in via the forum
  $wgIPBVersion = 4.6; // comment this out if you are using IPB v3, chage to 4 if you're using IPB <4.6
  

• Configure as required.
•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

User groups

The extension will assign local MediaWiki users to the sysop usergroup when they are part of the IPB Administrators usergroup, which has ID 4 by default. The extension provides an array mapping allowing different and/or custom assignments to be made. (Or none at all given an empty array.) This functionality provides support for custom IPB usergroups, as well as custom MediaWiki usergroups. The default:

$wgIPBGroupMap = array(
    'sysop' => 4,
    'rollbacker' => array(10,11,12) // It also supports arrays, any user in any of these groups will get the usergroup
);

THIS WAS DEPRECIATED WITH IPB4.6 By default the extension will set local MediaWiki accounts as (email) confirmed when they are not part of the "Validating" usergroup in IPB. This should be usergroup ID 1 by default, but this can be changed by assing a different value to $wgIPBGroupValidating. The default:

$wgIPBGroupValidating = 1;

Account recovery link

As the extension does not currently support account recovery, the account recovery link shown on the MediaWiki login page may be disabled/removed by adding the following line to LocalSettings:

$wgPasswordResetRoutes = array( 'username' => false, 'email' => false );

Usage

When a user logs in, the extension will authenticate them through the IPB database and assign them the appropriate usergroups. Beware that these usergroups assignments are stored locally for the MediaWiki instance and will not reflect updates on the IPB installation until the user logs out and in again in MediaWiki. If changes have to be immediate, an administrator should manually update the permissions for the local MediaWiki account.