Příručka:$wgVirtualRestConfig
| Různá nastavení: $wgVirtualRestConfig | |
|---|---|
| Konfigurace služeb REST |
|
| Zavedeno od verze: | 1.25.0 (Gerrit change 193826; git #b13bd099) |
| Odstraněno od verze: | stále se používá |
| Povolené hodnoty: | (pole) |
| Výchozí hodnota: | Viz níže |
| Další nastavení: Podle abecedy | Podle funkce | |
Podrobnosti
Zaregistrujte služby REST v podpole modules a změňte výchozí hodnoty v podpoli global.
Hlavním příkladem je Parsoid, který by měl být konfigurován pomocí tohoto parametru od MediaWiki 1.25 (viz také Extension:VisualEditor).
Při aktualizaci z MediaWiki 1.25 na 1.26 musí být hodnota 'prefix' přejmenována na 'domain' (druhá může být pro hladký přechod přidána se stejnou hodnotou jako první).
V tomto parametru lze také zaregistrovat RESTBase.
Výchozí hodnota
| Verze MediaWiki: | ≥ 1.28 |
$wgVirtualRestConfig = [
'paths' => [],
'modules' => [],
'global' => [
# Časový limit v sekundách
'timeout' => 360,
# 'domain' je nastaven na $wgCanonicalServer v Setup.php
'forwardCookies' => false,
'HTTPProxy' => null
]
];
| Verze MediaWiki: | 1.26 – 1.27 |
$wgVirtualRestConfig = [
'modules' => [],
'global' => [
# Timeout in seconds
'timeout' => 360,
# 'domain' is set to $wgCanonicalServer in Setup.php
'forwardCookies' => false,
'HTTPProxy' => null
]
];
| Verze MediaWiki: | 1.25 |
$wgVirtualRestConfig = array(
'modules' => array(),
'global' => array(
# Timeout in seconds
'timeout' => 360,
'forwardCookies' => false,
'HTTPProxy' => null
)
);
Parsoid
Toto jsou výchozí hodnoty, když je Parsoid registrován jako služba REST, které se používají, když některé klíče nejsou definovány.
$wgVirtualRestConfig['modules']['parsoid'] = [
// URL k instanci Parsoid - použijte port 8142, pokud používáte balíček Debian - parametr 'URL' byl poprvé použit, ale nyní je zastaralý (řetězec)
'url' => 'http://localhost:8000/',
// Parsoid "doména" (řetězec, volitelné) - MediaWiki >= 1.26
'domain' => 'localhost',
// Parsoid "prefix" (řetězec, volitelné) - zastaralé od MediaWiki 1.26, použijte 'domain'
'prefix' => 'localhost',
// Přepošle soubory cookie v případě soukromých wiki (řetězec nebo false, volitelné)
'forwardCookies' => false,
// Časový limit požadavku v sekundách (celé číslo nebo null, volitelné)
'timeout' => null,
// Parsoid HTTP proxy (řetězec nebo null, volitelné)
'HTTPProxy' => null,
// Zda analyzovat URL, jako by byly určeny pro RESTBase (logická nebo null, volitelné)
'restbaseCompat' => null,
];
RESTBase
Toto jsou výchozí hodnoty při registraci služby RESTBase, které se používají, když některé klíče nejsou definovány.
$wgVirtualRestConfig['modules']['restbase'] = [
// Adresa URL serveru RESTBase (řetězec)
'url' => 'http://localhost:7231/',
// Wiki doména k použití (řetězec)
'domain' => 'localhost',
// Časový limit požadavku v sekundách (celé číslo nebo null, volitelné)
'timeout' => 100,
// Soubory cookie k předání do RESTBase/Parsoid (řetězec nebo false, volitelné)
'forwardCookies' => false,
// HTTP proxy k použití (řetězec nebo null, volitelné)
'HTTPProxy' => null,
// Zda analyzovat adresy URL, jako by byly určeny pro Parsoid (logická hodnota, volitelné)
'parsoidCompat' => false,
// Zda připojit doménu k adrese URL
'fixedUrl' => false,
];
Proxying
Chcete-li použít vzdálenou instalaci RESTBase (např. pro testování rozšíření bez nutnosti instalace služby), můžete použít toto nastavení:
foreach ( $wgVirtualRestConfig['modules'] as &$module ) {
$module['url'] = 'https://en.wikipedia.org/api/rest_v1/';
$module['forwardCookies'] = false;
}
$wgVirtualRestConfig['modules']['restbase']['fixedUrl'] = true;