Extension:XenForoAuth
This extension is currently not actively maintained! Although it may still work, any bug reports or feature requests will more than likely be ignored. If you are interested in taking on the task of developing and maintaining this extension, you can request repository ownership. As a courtesy, you may want to contact the author. You should also remove this template and list yourself as maintaining the extension in the page's {{Extension }} infobox. |
XenForoAuth Release status: unmaintained |
|
---|---|
Implementation | User identity |
Description | Provides login with a XenForo account in a configurable XenForo forum. |
Author(s) | Florian Schmidt (Florianschmidtwelzowtalk) |
Latest version | 0.1.0 |
MediaWiki | 1.27+ |
PHP | 5.5+ |
Database changes | Yes |
License | MIT License |
Download | |
|
|
Quarterly downloads | 1 (Ranked 130th) |
Translate the XenForoAuth extension if it is available at translatewiki.net | |
The XenForoAuth extension allows wiki users to login with an account of a XenForo based online-forum. The extension uses the XenForo bd Api plugin (which needs to be installed on the XenForo forum in order to work with this extension) to request basic profile information.
Requirements
[edit]To use this extension you need at least:
- MediaWiki 1.27+
- MySQL (no PostgreSQL or SQLite support for now!)
- PHP 5.5+
- An API client in the forum with which your users can authenticate
- Able to run
composer update
Installation
[edit]- Download and move the extracted
XenForoAuth
folder to yourextensions/
directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/XenForoAuth - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'XenForoAuth' );
- Run the update script which will automatically create the necessary database tables that this extension needs.
- Configure the required parameters
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Configuration
[edit]The extension provides two configuration variables to set the Client ID and Client Secret (you get this pair in the API Client settings of the XenForo forum, remove "<" and ">"). You also need to configure the base url where the api can be reached.
$wgXenForoAuthClientSecret = '<your-client-secret>';
$wgXenForoAuthClientId = '<your-client-id>';
$wgXenForoAuthBaseUrl = 'https://example.com/api/';
Additional Configuration parameter
[edit]Configuration variable | Default value | Description |
---|---|---|
$wgXenForoAuthButtonIcon | 'images/xenForo_icon.png'
|
The icon, which will be added to the "Log in with XenForo" button. Normally you would set the path to the icon of the forum here. The value has to be surrounded with ' .
|
$wgXenForoAuthAutoCreate | false
|
Whether users from XenForo should be autocreated in this wiki. If you set this to true and a user logs in with XenForo and doesn't have a local connected account, it will be created automatically. If the username is already registered, the user will get an error message, that he couldn't be logged in.
|
Settings for the API Client
[edit]Please make sure, that you created an API Client in XenForo.
Please also set your full URL to Special:UserLogin
into the Redirect Uri input field (e.g. https://www.example.com/wiki/Special:UserLogin
).
Please also add your domain to the White-listed Domains input field (e.g. *.example.com
).