Jump to content

Extension:GlobalUserPage

From mediawiki.org
MediaWiki extensions manual
GlobalUserPage
Release status: stable
Implementation User interface
Description Enables global (shared between wikis) user pages on a wiki farm.
Author(s) Jack Phoenix, Kunal Mehta
Latest version 0.11.1 (2017-09-18)
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.42+
PHP 5.5.9+
License GNU General Public License 3.0 or later
Download
Help Help:Extension:GlobalUserPage/en
Example ShoutWiki
  • $wgGlobalUserPageAPIUrl
  • $wgGlobalUserPageTimeout
  • $wgGlobalUserPageDBname
  • $wgGlobalUserPageFooterKey
  • $wgGlobalUserPageCacheExpiry
Quarterly downloads 25 (Ranked 115th)
Public wikis using 2,011 (Ranked 198th)
Translate the GlobalUserPage extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

GlobalUserPage

2020 Coolest Tool
Award Winner

in the category
Reusable


The GlobalUserPage extension enables global (shared between wikis) user pages on a wiki farm.

This extension was developed by Jack Phoenix for ShoutWiki , originally based on the Extension:HelpPages by Kunal Mehta (the extensions no longer share any code).

User documentation

See Help:Extension:GlobalUserPage .

Caveats

Using this extension comes with a few security risks. You must absolutely trust the central wiki and its admins, as they can easily insert raw HTML into your wiki, opening up XSS holes and other bad things.

Installation

  • Download and move the extracted GlobalUserPage folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/GlobalUserPage
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'GlobalUserPage' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

  • $wgGlobalUserPageAPIUrl - the URL to the central wiki's api.php . This URL is internally used to fetch the global user page's text.
  • $wgGlobalUserPageCacheExpiry - controls how long to cache the rendered HTML for. The default is 60 * 60 * 24 * 7 (one week). The HTML is usually invalidated upon editing, but this is a worst case fallback.
  • $wgGlobalUserPageDBname - the name of the database where global user page data is stored, i.e. usually this should be set to the same value as $wgSharedDB .
  • $wgGlobalUserPageFooterKey - message key to add as a footer to the bottom of global user pages, or false if no footer should be added.
  • $wgGlobalUserPageTimeout - Timeout for internal API requests, to use $wgHTTPTimeout set this to the string "default".