Erweiterung:XenForoAuth

This page is a translated version of the page Extension:XenForoAuth and the translation is 41% complete.
MediaWiki-Erweiterungen
XenForoAuth
Freigabestatus: ohne Wartung
Einbindung Benutzeridentität
Beschreibung Provides login with a XenForo account in a configurable XenForo forum.
Autor(en) Florian Schmidt (FlorianschmidtwelzowDiskussion)
Letzte Version 0.1.0
MediaWiki 1.27+
PHP 5.5+
Datenbankänderungen Ja
Composer mediawiki/xenforoauth
Lizenz MIT-Lizenz
Herunterladen
  • $wgXenForoAuthButtonIcon
  • $wgXenForoAuthAutoCreate
  • $wgXenForoAuthBaseUrl
  • $wgXenForoAuthClientId
  • $wgXenForoAuthClientSecret
Quarterly downloads 4 (Ranked 136th)
Übersetze die XenForoAuth-Erweiterung, wenn sie auf translatewiki.net verfügbar ist

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.

Voraussetzungen

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

  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens XenForoAuth im Ordner extensions/ ablegen.
    Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/XenForoAuth
  • Folgenden Code am Ende deiner LocalSettings.php -Datei einfügen:
    wfLoadExtension( 'XenForoAuth' );
    
  • Führe das Aktualisierungsskript aus, welches automatisch die notwendigen Datenbanktabellen erstellt, die diese Erweiterung braucht.
  • Konfiguriere die benötigten Parameter
  •   Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.

Konfiguration

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/';

Zusätzliche Konfigurationsparameter

Konfigurationsvariable Standardwert Beschreibung
$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

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).