Manual:$wgVirtualRestConfig

From MediaWiki.org
Jump to: navigation, search

Other languages:
English • ‎español • ‎日本語 • ‎polski
Global Objects: $wgVirtualRestConfig
REST services configuration
Introduced in version: 1.25.0
Removed in version: still in use
Allowed values: array
Default value: See below
Other settings: Alphabetical | By function

Details[edit]

Register REST services in the subarray modules, and change the default values in the subarray global.

The main example is Parsoid, which should be configured using this parameter since MediaWiki 1.25 (see also Extension:VisualEditorExtension:VisualEditor). When upgrading from MediaWiki 1.25 to 1.26, the 'prefix' value must be renamed 'domain' (the latter can be added with the same value as the former for a smooth transition).

RESTBase can also be registered in this parameter.

Default value[edit]

MediaWiki version: 1.25
$wgVirtualRestConfig = array(
        'modules' => array(),
        'global' => array(
                # Timeout in seconds
                'timeout' => 360,
                # 'domain' is set to $wgCanonicalServer in Setup.php since MediaWiki 1.26
                'forwardCookies' => false,
                'HTTPProxy' => null,
        ),
);

Parsoid[edit]

These are the default values when Parsoid is registered as a REST service, used when some keys are not defined.

$wgVirtualRestConfig['modules']['parsoid'] = array(
  // URL to the Parsoid instance - use port 8142 if you use the Debian package - the parameter 'URL' was first used but is now deprecated (string)
  'url' => 'http://localhost:8000/',
  // Parsoid "domain" (string, optional) - MediaWiki >= 1.26
  'domain' => 'localhost',
  // Parsoid "prefix" (string, optional) - deprecated since MediaWiki 1.26, use 'domain'
  'prefix' => 'localhost',
  // Forward cookies in the case of private wikis (string or false, optional)
  'forwardCookies' => false,
  // request timeout in seconds (integer or null, optional)
  'timeout' => null,
  // Parsoid HTTP proxy (string or null, optional)
  'HTTPProxy' => null,
  // whether to parse URL as if they were meant for RESTBase (boolean or null, optional)
  'restbaseCompat' => null,
);

RESTBase[edit]

These are the default values when a RESTBase service is registered, used when some keys are not defined.

$wgVirtualRestConfig['modules']['restbase'] = array(
  // RESTBase server URL (string)
  'url' => 'http://localhost:7231/',
  // Wiki domain to use (string)
  'domain' => 'localhost',
  // request timeout in seconds (integer or null, optional)
  'timeout' => 100,
  // cookies to forward to RESTBase/Parsoid (string or false, optional)
  'forwardCookies' => false,
  // HTTP proxy to use (string or null, optional)
  'HTTPProxy' => null,
  // whether to parse URL as if they were meant for Parsoid (boolean, optional)
  'parsoidCompat' => false,
);

See also[edit]