Extension:SteamAuth

From mediawiki.org
Jump to navigation Jump to search
PluggableAuth Icon.svg This extension requires the PluggableAuth extension to be installed first.
MediaWiki extensions manual
OOjs UI icon advanced-invert.svg
Steam Auth
Release status: stable
Implementation User identity
Description SteamAuth is a MediaWiki extension that allows users to sign in with Steam.
Author(s) Banakin (Banakin900talk)
Latest version 1.2 (2020-08-27)
Compatibility policy Master maintains backward compatibility.
MediaWiki 1.34+
PHP 7.0+
Database changes No
License MIT License
Download
README on GitHub

  • $wgSteamAuth_Key
  • $wgSteamAuth_AppID

Check usage and version matrix.

SteamAuth is a MediaWiki extension that allows users to sign in with Steam. This plugin uses PluggableAuth.

The extension is designed to be used as the only form of authentication for your wiki.

Special thanks to LightOpenID.

Installation[edit]

Note Note: This extension requires PluggableAuth to be installed first.

  • Download and place the file(s) in a directory called SteamAuth in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'SteamAuth' );
    
  • Configure as required.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Recommended Settings[edit]

Disabling normal account creation is strongly recommended. You can do so by adding the following lines to the bottom of your LocalSettings.php:

$wgGroupPermissions['*']['createaccount'] = false;
$wgGroupPermissions['*']['autocreateaccount'] = true;

It is also recommended to use a plugin such as Realnames to display the user's display name rather than their ID.

Configuration[edit]

Flag Default Description
$wgSteamAuth_Key "key" Your steam developer API key (Available from https://steamcommunity.com/dev/apikey)
$wgSteamAuth_AppID null (Optional) If set, only users that have this app/game in their Steam library can login and create accounts.

Release Notes[edit]

Version 1.2
Bring up Steam on button click rather than when the login page is opened.
Version 1.1
Fixed major security issue (The user's ID is now used as the username. The user's persona name is now the real name)
Version 1.0
Initial release