Kézikönyv:$wgVirtualRestConfig
Egyéb beállítások: $wgVirtualRestConfig | |
---|---|
REST-szolgáltatások konfigurációja. |
|
Bevezetve: | 1.25.0 (Gerrit change 193826; git #b13bd099) |
Eltávolítva: | használatban |
Megengedett értékek: | (tömb) |
Alapértelmezett érték: | Lásd alább |
Egyéb beállítások: Betűrendben | Funkció szerint |
Részletek
A változó a REST-szolgáltatásokat a modules
altömbben tárolja, a global
altömb alapértelmezéseit pedig felülírja.
A legjobb példa erre a Parsoid, melynek beállításához a MediaWiki 1.25 óta ezen paraméter szükséges (lásd még: Extension:VisualEditor ).
A MediaWiki 1.25 verziójáról 1.26-ra való frissítéskor a 'prefix'
értéket 'domain'
-re kell átnevezni (egyszerű átmenethez utóbbit később is lehet rögzíteni az előbbivel megegyező tartalommal).
A RESTBase regisztrációja is ezen paraméterrel lehetséges.
Alapértelmezett érték
MediaWiki-verzió: | ≥ 1.28 |
$wgVirtualRestConfig = [
'paths' => [],
'modules' => [],
'global' => [
# Időtúllépés másodpercben
'timeout' => 360,
# A Setup.php-ban a 'domain' a $wgCanonicalServer-re van irányítva.
'forwardCookies' => false,
'HTTPProxy' => null
]
];
MediaWiki-verziók: | 1.26 – 1.27 |
$wgVirtualRestConfig = [
'modules' => [],
'global' => [
# Timeout in seconds
'timeout' => 360,
# 'domain' is set to $wgCanonicalServer in Setup.php
'forwardCookies' => false,
'HTTPProxy' => null
]
];
MediaWiki-verzió: | 1.25 |
$wgVirtualRestConfig = array(
'modules' => array(),
'global' => array(
# Timeout in seconds
'timeout' => 360,
'forwardCookies' => false,
'HTTPProxy' => null
)
);
Parsoid
Az alábbi értékek a Parsoid REST-szolgáltatásként történő regisztrációjakor használtak, ha egyes kulcsok nincsenek definiálva.
$wgVirtualRestConfig['modules']['parsoid'] = [
// A Parsoid-példány URL-je – a Debian-csomag esetén használd a 8142-es portot – először az „URL” paramétert használtuk, de ez később megváltozott (sztring)
'url' => 'http://localhost:8000/',
// A Parsoid „domainje” (sztring, opcionális) - MediaWiki >= 1.26
'domain' => 'localhost',
// A Parsoid „előtagja” (sztring, opcionális) - A MediaWiki 1.26 óta elavult, használd helyette a „domain”-t
'prefix' => 'localhost',
// Sütik továbbítása privát wikik esetén (sztring vagy „false”, opcionális)
'forwardCookies' => false,
// A kérés időtúllépése másodpercben (integer vagy „null”, opcionális)
'timeout' => null,
// A Parsoid HTTP-proxyja (sztring vagy „null”, opcionális)
'HTTPProxy' => null,
// Az URL RESTBase-hez kapcsolt címként kezelése (boolean vagy „null”, opcionális)
'restbaseCompat' => null,
];
RESTBase
Az alábbi értékek egy RESTBase-szolgáltatás regisztrációjakor használtak, ha egyes kulcsok nincsenek definiálva.
$wgVirtualRestConfig['modules']['restbase'] = [
// RESTBase szerver-URL (sztring)
'url' => 'http://localhost:7231/',
// Használandó wikidomain (sztring)
'domain' => 'localhost',
// A kérés időtúllépése másodpercben (integer vagy „null”, opcionális)
'timeout' => 100,
// A RESTBase vagy Parsoid felé továbbítandó sütik (sztring vagy „false”, opcionális)
'forwardCookies' => false,
// Használandó HTTP-proxyja (sztring vagy „null”, opcionális)
'HTTPProxy' => null,
// Az URL Parsoidhoz kapcsolt címként kezelése (boolean, opcionális)
'parsoidCompat' => false,
// Legyen-e a domain az URL-hez fűzve
'fixedUrl' => false,
];
Proxyk használata
Távoli RESTBase-telepítés használatakor (például kiterjesztés tesztelése a szükséges szolgáltatás telepítése nélkül) például az alábbi konfigurációt használhatod:
To use a remote RESTBase installation (e.g. for testing an extension without having to install the service), you can use a setting like this:
foreach ( $wgVirtualRestConfig['modules'] as &$module ) {
$module['url'] = 'https://en.wikipedia.org/api/rest_v1/';
$module['forwardCookies'] = false;
}
$wgVirtualRestConfig['modules']['restbase']['fixedUrl'] = true;