MediaWiki-Vagrant/cs





MediaWiki-Vagrant je přenosné vývojové prostředí MediaWiki. Skládá se ze sady konfiguračních skriptů pro programy Vagrant a VirtualBox, které automatizují vytvoření virtuálního počítače /v dalším textu VM (virtual machine)/, na kterém běží MediaWiki. Konfigurace je zaměřena spíše na snadný vývoj než na bezpečnost. Z tohoto důvodu nedoporučujeme používat MediaWiki-Vagrant jako veřejně přístupnou wiki!

Virtuální nástroj (dále v textu jako "VM"), který MediaWiki-Vagrant vytváří, usnadňuje získávání informací, úpravy a vylepšování kódu MediaWiki. Ve výchozím nastavení se zobrazují užitečné informace o ladění a různé vývojářské nástroje speciálně nastavené pro kontrolu a interakci s kódem MediaWiki, včetně výkonného debuggeru a interaktivního tlumočníka. Je nejlepší ze všech, protože konfigurace je automatizovaná a obsažená ve virtuálním prostředí, chyby lze snadno vrátit zpět.

Systémové požadavky

 * CPU: 64bitový procesor x86
 * OS: Linux nebo macOS nebo Windows
 * Paměť: Celkem 4 GB RAM ve vašem systému, nejlépe 8 GB případně i více, aby bylo možné spustit hostitelský operační systém i VM. Nepokoušejte se spustit systém s pouhými 2 GB RAM, protože nakonec to vždy selže.
 * Disk: Na primární jednotce musí být volných několik gigabajtů (/home partition pro Linux, C: drive for Windows). Zejména mějte na paměti, že obsahy disků VM budou ve výchozím nastavení uloženy ve vašem domovském adresáři.
 * Síť: Aktivní síťové připojení s dostatečnou šířkou pásma pro stahování aktualizací systému Debian Linux a zdrojového kódu MediaWiki
 * Čas pro nastavení: 20 minut až 2 hodiny, v závislosti na podmínkách a případných potížích

Rychlý start
(Pokud instalujete MediaWiki-Vagrant z distribuce USB, postupujte podle kroků v README místo prvních pěti kroků.)


 * 1) Stáhněte Git
 * 2) (Pouze Linux) Nainstalujte  NFS, pokud ještě není nainstalován. V Ubuntu použijte  . Fedora obvykle přichází s nainstalovaným NFS; pokud není spuštěn.
 * 3) Stáhněte VirtualBox
 * 4) Získejte nejnovější Vagrant
 * 5) Získejte kód a vytvořte svůj stroj:
 * (Tím se spustí klonování do vašeho domovského adresáře.)
 * Až budete vyzváni, zadejte své uživatelské jméno Gerrit (doporučeno) nebo stačí stisknout Enter.
 * Pokud chcete místo nejnovější verze použít větev vydání, můžete ji nyní zadat pomocí
 * 1) Povolte další funkce MediaWiki, např.:
 * 2) Po dokončení konfigurace počítače Vagrant přejděte na adresu http://dev.wiki.local.wmftest.net:8080/ a vyhledejte instanci MediaWiki. Můžete se přihlásit jako uživatel Admin s heslem vagrant.
 * 1) Povolte další funkce MediaWiki, např.:
 * 2) Po dokončení konfigurace počítače Vagrant přejděte na adresu http://dev.wiki.local.wmftest.net:8080/ a vyhledejte instanci MediaWiki. Můžete se přihlásit jako uživatel Admin s heslem vagrant.
 * 1) Po dokončení konfigurace počítače Vagrant přejděte na adresu http://dev.wiki.local.wmftest.net:8080/ a vyhledejte instanci MediaWiki. Můžete se přihlásit jako uživatel Admin s heslem vagrant.
 * 1) Po dokončení konfigurace počítače Vagrant přejděte na adresu http://dev.wiki.local.wmftest.net:8080/ a vyhledejte instanci MediaWiki. Můžete se přihlásit jako uživatel Admin s heslem vagrant.

Pokud používáte Windows
Získejte Git for Windows a spusťte příkazy  v jeho schránce Git Bash. Namísto  spusťte   ze schránky.

Pokud používáte prostředí kompatibilní s WSL Linux na Windows 10: spusťte příkazy s  namísto. Spusťte  namísto , který v bash schránce Linuxu nefunguje.

Účet, ve kterém běží Vagrant, bude pravděpodobně potřebovat oprávnění „Vytvořit symbolické odkazy“ (snadný způsob, jak toho dosáhnout, je být spuštěn jako správce).

Odstraňování potíží při spuštění
Vaše problémy nejsou níže zodpovězeny? Využijte IRC, konkrétně kanál.

Jakýkoli počítač
Jestliže budete chtít porovnat výstup prvního spuštění aplikace vagrant up ve vašem terminálu s tímto vzorkem. Počáteční nastavení může trvat dlouho! Jestli se zdá, že někde "visí", ale nedochází k žádným chybám, chvíli počkejte. Například:
 * Zkuste nainstalovat verze VirtualBox a Vagrant, které vaše distribuce Linuxu poskytuje. Pokud používáte nejnovější Debian nebo Ubuntu, zkuste sudo apt-get install virtualbox vagrant a nainstalujte balíčky pro VirtualBox a Vagrant.
 * Pokud se vám objeví chyby z vagrant up, nainstalujte nejnovější verze VirtualBox a Vagrant.
 * Při zobrazení chybové zprávy jako je „Couldn't open file $CLONED_REPOSITORY/trusty-cloud“, zkuste následující příkaz: vagrant up --provider=virtualbox
 * Pokud narazíte na nějaké puppet chyby, možná budete muset iniciovat puppet submoduly. V adresáři s Vagrantem spusťte příkaz git submodule update --init
 * Pomocí odkazu http://127.0.0.1:8080/info.php zkontrolujte, zda je Apache / PHP funkční.
 * Pomocí odkazu http://127.0.0.1:8080/info.php zkontrolujte, zda je Apache / PHP funkční.
 * Když se zobrazí upozornění, že je verze programu VirtualBox Guest Additions nesprávná, můžete zkusit nainstalovat plugin vagrant-vbguest, který se aktualizuje automaticky.
 * Párování Vagrantu s vaším VM se zřídkakdy rozbije. Toto vlákno popisuje některé způsoby, jak to obejít (např. připojit starý pevný disk VM k novému profilu)
 * Ujistěte se, že úložiště  je aktuální:
 * Ujistěte se, že jste povolili virtualizaci v systému BIOS. Někdy je to v nastavení zabezpečení.
 * Ujistěte se, že vaše nastavení kódování jazyka je UTF-8. Pokud se zobrazí „invalid byte sequence in US-ASCII“, zkuste (znovu) nastavit proměnné prostředí LANG a LC_ALL na něco vhodnějšího.


 * Nefunkční instalace např.: "Nebyla nalezena žádná wiki..."(No wiki found...) můžete opravit spuštěním, který obnoví virtuální počítač bez opakování časově nejnáročnějších části instalačního procesu.

Specifické pro Windows

 * If you are on Windows and you get "guest machine entered an invalid state" - "poweroff", try downloading a 4.3.15 build of VirtualBox (there is a known problem with 4.3.14 on Windows). If that does not help, make sure you enable Hardware Virtualization Technology (VT-x or AMD-V) in BIOS. Hardware Virtualization is required. It is not an optional performance enhancement. (Some laptops require you to remove the power cable and battery for 30 seconds )
 * VirtualBox není kompatibilní s Hyper-V společnosti Microsoft. Pokud máte povolenou technologii Hyper-V (což může být výchozí nastavení při nainstalované aplikaci Visual Studio) a zobrazí se při spouštění virtuálního počítače ve VirtualBoxu výše uvedené chyby. Máte tři možnosti:
 * V příkazovém řádku spusťte bcdedit/set hypervisorlaunchtype off. Tím vypnete Hyper-V a restartujete počítač. Chcete-li Hyper-V opět zapnout, přepněte jej zpět z off na auto.
 * Zakažte Hyper-V pomocí ovládacího panelu 'Přidat nebo odebrat funkce systému Window' (Add/Remove Windows Features) a restartujte počítač. Virtuální modul bude fungovat, ale znemožní vám používat jakékoli virtuální počítače Hyper-V, například emulátory Windows Phone.
 * Nebo pro Vagrant použijte systém Hyper-V namísto VirtualBoxu. Toto řešení může být nestabilní.

Specifické pro Mac
Abyste se vyhnuli chybám NFS, během instalace, zajistěte aby firewall akceptoval připojení: Apple> Předvolby systému> Zabezpečení a soukromí > Firewall > Možnosti brány Firewall (Apple > System Preferences > Security & Privacy > Firewall > Firewall Options). Budete muset zrušit zaškrtnutí políčka „Blokovat všechna příchozí připojení“ (Block all incoming connections) a pravděpodobně také zrušit zaškrtnutí políčka „Povolit tajný režim“ (Enable stealth mode), pro akceptování následujících: netbiosd, nfsd, rpc.lockd, rpc.rquotad, rpcbind, VBoxHeadless. Během několika  vteřin budete možná muset restartovat počítač a změnit stav na „Povolit příchozí připojení“ (Allow incoming connections). Po instalaci, jakmile jsou pravidla brány firewall aktualizována, budete pravděpodobně muset znovu zkontrolovat "Blokovaní všechna příchozí připojení" (Block all incoming connections) a "Povolit tajný režim" (Enable stealth mode).
 * Chyby NFS
 * Alternativně můžete vypnout sdílení NFS pomocí

Debian a Ubuntu

 * MediaWiki-Vagrant používá systém síťových souborů NFS ke sdílení některých složek s hostitelským (vaším) počítačem. Počítač musíte nastavit jako „server NFS“, viz např. příkazy Ubuntu Ubuntu instructions. Na Debianu bude fungovat sudo apt-get install nfs-kernel-server ; možná budete muset také nastavit . Server NFS Debianu se nespustí bez nastavení v  . Pravděpodobně se to děje, pokud   nespustí služby „nfs“. Přidání domovského adresáře jako posledního řádku do   a poté /etc/init.d/nfs-kernel-server restart bude stačit pro odstranění tohoto problému.


 * Sdílení NFS, které používá MediaWiki-Vagrant, nelze spouštět z šifrovaného adresáře. Což se může stát, pokud používáte Ubuntu a používáte šifrovaný domovský adresář. Chcete-li spustit MediaWiki-Vagrant, můžete buď:
 * Před spuštěním  přesuňtte adresář MediaWiki-Vagrant do nezašifrované složky (např.  ).
 * Alternativně můžete vypnout sdílení NFS pomocí
 * Nastavení NFS někdy uvízne (počáteční  visí na "Připojování sdílených složek NFS"). Restartování démona NFS na hostiteli pomáhá. (Viz #5802.)


 * Pokud dochází k chybám při přesměrování portů, kdy jsou porty používány, budete možná muset otevřít virtuální box, úplně odebrat virtuální počítač a akci opakovat.

Fedora

 * Zobrazí-li se Vám hláška, že síť není k dispozici Network 10.11.12.13 is not available. po spuštění, deaktivujte SELinux pomocí   nebo opravte nastavení SELinux.
 * Jestliže poskytovatel tohoto nástroje řízeného Vagrantem po spuštění  hlásí, že ještě není připraven na SSH "The provider for this Vagrant-managed machine is reporting that it is not yet ready for SSH.", ujistěte se, že je správně nastaven poskytovatel, například prostřednictvím   a poté
 * Objeví-li se hláška mount.nfs: mount to NFS server '10.11.12.13:download-directory/vagrant' failed: RPC Error: Unable to receive (mount.nfs: připojte se k serveru NFS '10 .11.12.13: adresář ke stažení nelze přijmout), spusťte.

Základní použití
Nástroj příkazového řádku vagrant na hostitelském počítači poskytuje několik základních příkazů pro ovládání virtuálního počítače. Již jste použili jeden: vagrant up zapínající virtuální počítač. Stejně jako většinu příkazů vagrant je spusťte z adresáře MediaWiki-Vagrant nebo některého z jeho podřízených adresářů. Při prvním spuštění načte Vagrant nastavení systému a nastaví potřebný software pro spuštění MediaWiki. Může to trvat 1 až 2 hodiny času procesoru a hodin na širokopásmovém připojení, ale pouze jednou. Při následujícím spuštění vagrant up, se jednoduše spustí jenom počítač.

vagrant ssh spustí interaktivní přihlašovací schránku na virtuálním počítači. Přihlašte se jako uživatel vagrant. Root přístup je dostupný prostřednictvím sudo. Přístup je bez hesla. Virtuální počítač, zcela izolovaný v počítači, je nakonfigurován pro pohodlí, nikoli pro zabezpečení. Kdykoli narazíte na výzvu k zadání hesla, je zpravidla heslo.

Po přihlášení byste měli vidět barevný banner MediaWiki a připomenutí několik užitečných příkazů.

Příkaz phpsh spustí interaktivní PHP interpret s již načtenou kódovou základnou MediaWiki. Můžete zadat jakýkoli kód, stisknout 'enter' a kód bude okamžitě vyhodnocen. Pokud začnete řádek s '=', jeho vypočítaná hodnota bude zobrazena. Pro rychlou pomoc zadejte "?" nebo "help start" (pomoc při spuštění). Zobrazí se Vám další pokyny.

Složka  odpovídá složce MediaWiki-Vagrant na hostitelském počítači a její obsah je sdílen. Kód MediaWiki je nainstalován v. To vám umožní k úpravě kódu MediaWiki použít normální prostředí editoru na hostitelském počítači, který běží na Vašem virtuálním počítači.

Aktualizace
Pomocí vagrant git-update můžete aktualizovat svůj git repozitář, externí knihovny a databázová schémata. Příkaz odpovídá spuštění:


 * 1) git pull v adresáři   a všech adresářích rozšíření a vzhledů
 * 2) composer update, zajišťuje, že jsou k dispozici nejnovější knihovny spravované Composrem
 * 3) spuštění skriptu.

Měli byste také příležitostně (nebo když budete potřebovat novou funkci) aktualizovat samotnou aplikaci MediaWiki-Vagrant, což příkaz vagrant git-update nezahrnuje. Můžete to udělat spuštěním:

… V kořenovém adresáři MediaWiki-Vagrant. Aktualizace se projeví při spuštění příkazu:

Příkaz můžete spustit okamžitě po spuštění git pull nebo kdykoliv později.

Z virtuálního počítače se odhlašte zadáním logout nebo stisknutím CTRL + D. Nyní, když jste zpět ve standardním příkazovém řádku, můžete spustit vagrant halt a vypnout virtuální počítač. Příkazm vagrant up ho můžete znovu spustit. Příkazem vagrant destroy můžete smazat všechny soubory virtuálního počítače. Příkaz je užitečný, pokud chcete vrátit svou instanci do původního stavu.

Používání rolí
MediaWiki-Vagrant standardně nastavuje základní instanci MediaWiki, ale dokáže také nakonfigurovat řadu doplňkového softwaru, včetně některých oblíbených rozšíření MediaWiki a jejich závislostí. Tyto volitelné softwarové balíčky jsou souhrnně známé jako „role“ a MediaWiki-Vagrant nabízí snadné a výkonné rozhraní příkazového řádku pro jejich správu.

 $ vagrant roles list


 * 1) Zobrazit seznam dostupných rolí.

 $ vagrant roles enable role


 * 1) Zapněte pro tento stroj roli.

 $ vagrant roles disable role


 * 1) Vypněte roli tohoto stroje.

 $ vagrant provision


 * 1) Poté, co jste dokončili povolení nebo zakázání rolí, spusťte toto, aby se změna projevila.

Podívejte se na krátkou ukázku screencast demonstrující, jak používat role. Roles obsahuje více informací o některých rolích.

Pokud přidáte mnoho rolí, budete asi muset zvětšit paměť dostupnou pro Vagrant VM. Zejména nastavení role „browsertests“ zahrnuje kompilaci  ruby Gem, což je úkol vyčerpávající paměť. Pokud to bude nutné, uvolnite paměť ve virtuálním počítači nebo zvýšte přidělenou paměť.

Pokud máte zájem o přidání rolí do MediaWiki-Vagrant, přečtěte si níže uvedenou část Autorské role.

centralauth
Existují některé role, které vyžadují zvláštní pozornost, role centralauth nespustí migrace db automaticky přes puppet a vyžaduje ruční spuštění. Pokud se při přidělování této role vyskytnou chyby, zkuste spustit tento skript za příponou a podívejte se na chyby, které z něj vyplynou:

mwscript extensions/CentralAuth/maintenance/migrateAccount.php --username 'Admin' --auto

Jakmile získáte konkrétnější chybu, budete pravděpodobně potřebovat vědět, kterou z těchto migrací musíte spustit:

extensions/CentralAuth/db_patches

Wikidata
Jednoduché vagrantské role  (umožňující využívat wikidata jejichž poskytování Vagrantem by selhalo). Zde je kompletní sada příkazů, které zajistí, aby role Wikidata byla spuštěna a provozována.

$ vagrant up $ vagrant git-update $ vagrant ssh $ sudo apt-get update && sudo apt-get upgrade $ composer selfupdate --update-keys $ composer config --global process-timeout 9600 Odhlašte se z Vagrantu a poté data můžete v pohodě spustit: $ vagrant roles enable wikidata $ vagrant provision

Upozorňujeme, že první příkaz může hlásit chybu, takže vypadá jako selhání. Pokud však provedete druhý příkaz, bude vše v pořádku.

Pak můžete svůj prohlížeč odkázat na http://wikidata.wiki.local.wmftest.net:8080/. Chcete-li vytvořit novou položku wikidata, načíst http://wikidata.wiki.local.wmftest.net:8080/wiki/Special:NewItem a vytvořit novou vlastnost, přejděte na http://wikidata.wiki.local.wmftest.net:8080/wiki/Special:NewProperty

Jak importovat výpis z Wikidata
Příkaz Vagrant, který  , zpracovává pouze výchozí wiki (viz phab:T183274). Spusťte skript  v boxu Vagrant.

Zde je postup importu výpisů XML.

$ mkdir wikidata_dumps $ cd wikidata_dumps $ wget https://dumps.wikimedia.org/wikidatawiki/latest/wikidatawiki-latest-pages-articles10.xml-p5264684p6341661.bz2 $wgWBRepoSettings['allowEntityImport'] = true;
 * stáhněte jakékoli  (stránky nebo články). Například:
 * Povolte import entit Wikibase (viz phab:T72898). Připojte následující řádek k :
 * Následující skript BASH vám pomůže monitorovat proces. Můžete jej vložit do souboru . Zvýrazněný řádek volá skutečný skript pro import:

$ vagrant ssh $ cd /vagrant $ sudo chmod +x import_wikidata.sh $ ./import_wikidata.sh   $ tail -f wd_import.log
 * přihlaste se do pole Vagrant a spusťte skript. Zde by se měly zobrazovat ladící zprávy:
 * můžete sledovat průběh protokolu mimo box Vagrant:

Základní kopie Local MediaWiki
Někdy můžete chtít začít od nuly. Odstraněním celého adresáře vagrant nebo vyčištěním adresáře vagrant/mediawiki. Chcete-li urychlit proces zajišťování vagrantu, zvažte zachování lokálního aktualizovaného klonu jádra MediaWiki, který zkopírujete do vagrant/mediawiki.

Například v případě, že klonujete repozitáře MediaWiki do ~/projects/mediawiki/ :

Aktualizování klonovaného úložiště
Aktualizujte klonovaný repozitář tak často, jak jen je to možné, případně nutné.

Nebo aktualizujte všechny klonované repozitáře:

Opětovné načtení Vagrant
Pokud změníte konfiguraci (např. $Ram) váš web VM/MediaWiki zamrzne/zatuhne nebo se vyskytne jiný problém, může to vyřešit vagrant reload. Tím se váš host restartuje. Některé úlohy také vyžadují opětovné načtení, ke kterému by mělo dojít automaticky.

Kdy povolit role
Role povolte pouze po úspěšném spuštění prvního vagrant up.

Všimněte si, že vagrant destroy neresetuje povolené role. Po spuštění vagrant destroy vypněte všechny role a poté spusťte vagrant up. Nyní můžete znovu povolit jakékoli role a spustit vagrant provision.

Vagrant za proxy
Pokud jste za proxy, Vagrant by mohl hlásit některé errors (chyby). Nainstalujte vagrant-proxyconf. Je to plugin, který umožňuje vašemu virtuálnímu počítači používat určené proxy. Toto je rychlý průvodce nastavením. Podrobnou dokumentaci najdete na stránce zde.

Nainstalujte plugin:

Chcete-li nakonfigurovat nastavení proxy pro všechny programy ve všech vagrantových virtuálních počítačích, přidejte následující řádky do  (výchozí  ).

Nahraďte adresy číslem ip a portem vašeho proxy serveru. Pomocí config.proxy.no_proxy vyjmenujte všechny weby / domény, pro které byste mohli chtít obejít proxy. Například,

Nyní, když spustíte kód vagrant up, neměla by se objevit žádná varování.

Chcete-li zakázat plugin, nastavte config.proxy.enabled na false nebo prázdný řetězec (""). Můžete jej také zakázat pro konkrétní aplikace. Například,

MediaWiki-Vagrant prep
Možná budete chtít zvážit použití shellového skriptu, například mw-vagrant-prep, k přípravě adresáře pro instalaci MediaWiki-Vagrant.

Poskytování
Proces spuštění můžete ladit spuštěním

PHP
Můžete ladit PHP pomocí Xdebugu. Ladění v PHP se liší od ostatních ladění na straně klienta. Vaše IDE poslouchá příchozí připojení a když přistoupíte k serveru pomocí prohlížeče, dá PHP hlavičce pokyn, aby se připojil k vašemu IDE. Další informace viz MediaWiki-Vagrant/Advanced usage.

HHVM
Viz Návod:Jak debugovat#HHVM pro ladění pod HHVM.

Chrome

 * Pro uživatele prohlížeče Chrome byste měli získat XDebug Helper a volitelně Clear Cache, HTTP header a Mod Headers. Konfigurace vymazání mezipaměti tak, aby se po vymazání automaticky znovu načítala, a nastavení klávesových zkratek (např. Ctrl+R pro vymazání a opětovné načtení, Ctrl+Shift+D pro zapnutí / vypnutí XDebuggeru)

Firefox

 * Uživatelé Firefoxu by se měli podívat na easy Xdebug.
 * Nainstalujte a nakonfigurujte xdebug-compatible IDE na vašem počítači (Eclipse, PhpStorm, Emacs atd.)
 * V IDE začněte poslouchat příchozí ladicí spojení
 * V IDE stanovte bod zlomu na místě, které vás zajímá
 * V prohlížeči povolte XDebug a přejděte k vagrantské instalaci ( http://127.0.0.1:8080/... )

Soubory protokolu
Protokoly mediawiki lze nalézt v /vagrant/logs. V /var/log/apache2/ jsou soubory protokolu pro Apache, ale zdá se, že na ně nejsou zapsány. V /var/log/hhvm/ je soubor protokolu pro HHVM HHVM zaznamenává upozornění, varování, chyby a nevhodné výjimky v PHP do syslogu, který můžete vidět v /var/log/syslog. Protokol dotazů MySQL lze získat vydáním SET GLOBAL general_log = 'ON'; v klientovi a poté prohlížením /var/lib/mysql/*.log.

Spouštění a ladění testů jednotek
Pro spuštění testů pro všechna rozšíření:

Spuštění testů jednotky pro jedno rozšíření:

Můžete připojit cestu/k/testy/ke_spuštění.

Některé testy mohou vyžadovat spuštění oprávněným uživatelem pro vytvoření souborů zámku. Proto se tento příkaz spustí jako „user“ (uživatel), který zpracovává webové požadavky.

Informace o vytváření reportů o pokrytí viz Manual:PHP unit testing/Code coverage - příručka: Testování jednotek PHP / pokrytí kódu # MediaWiki-Vagrant.

Ladění phpunit testů je trochu složitější. Tato metoda je trochu hackerská, ale lze ji použít, dokud se nezlepší možnosti vzdáleného interpretu (např. V phpStorm 8 EAP). Toto řešení umožňuje spustit unit testy MediaWiki přímo z prohlížeče.
 * Stáhněte soubor phpunit.phar do kořenového adresáře vagrant.
 * Vytvořte soubor php  v kořenovém adresáři  . Neukládejte tento soubor do repozitáře. Vložte do něj následující kód:


 * Ve výše uvedeném souboru změňte parametr argv na název souboru s testy
 * Apache mapuje kořenový adresář mediawiki na . Chcete-li tento soubor spustit, přejděte na http://127.0.0.1:8080/w/unittest.php
 * Pro připojení debuggeru postupujte podle pokynů #Debugging

Pouštění browser testů
Viz.

Tento odkaz ukazuje na zastaralou dokumentaci. Prosíme o aktualizaci někoho, kdo ví více o testování MediaWiki:

Pushing commits
Pokud pro vývoj používáte MediaWiki-Vagrant, pravděpodobně budete chtít poslat nějaké potvrzení do jádra MediaWiki nebo úložiště rozšíření pomocí git review. Ve výchozím nastavení všechny dálkové ovladače odkazují na URL. Chcete-li se vyhnout tomu, aby toto bylo případ od případu potlačeno, spusťte:

$ git config --global url."ssh:// @gerrit.wikimedia.org:29418/".insteadOf "https://gerrit.wikimedia.org/r/"

Musíte také mít nastaveny své ssh klíče v.

Jak na to?

 * Check PHP version and settings
 * http://127.0.0.1:8080/info.php


 * Upravte LocalSettings.php?
 * Nejprve se ujistěte, že neexistuje žádná úloha ( vagrant list-roles ), která již dělá to, co potřebujete. Pokud ne, vytvořte soubor v adresáři . Viz README a příklad souboru 00-debug.php.


 * Aktualizovat kód MediaWiki?
 * Nejjednodušší je použít  od hostitele. Nebo, chcete-li aktualizovat kód bez závislostí, můžete použít běžné příkazy git ,   atd. V   a   adresáře. Tyto příkazy můžete spouštět na virtuálním počítači, ale přístup k souborům bude na hostitelském počítači rychlejší. MediaWiki-Vagrant stahuje kód z hlavního serveru git, když jste původně nastavili nebo přidali úlohu, ale poté automaticky neaktualizuje kód.


 * Spusťte překladač MediaWiki PHP
 * ssh pro vagrant a spusťte . Možná jej budete muset spustit pomocí


 * Spusťte interpretátor SQL MediaWiki
 * ssh pro vagrant a spuštění . Možná jej budete muset spustit pomocí

''Balíčky NN lze aktualizovat. Aktualizace NN jsou aktualizace zabezpečení.'' Ve vagrant ssh:
 * Aktualizovat softwarové balíčky virtuálních strojů?
 * neaktualizuje systémové balíčky ve virtuálním počítači. Když se spojíte s vagrantem ssh, přihlašovací zpráva vás informuje, že:
 * * Chcete-li aktualizovat všechny balíčky, zadejte
 * * pro automatickou instalaci bezpečnostních (a dalších) upgradů, podobně jako v případě cloudových VPS, zadejte
 * * pro aktualizaci na stejné balíčky, které jsou na produkčních serverech WMF ... TODO


 * Přizpůsobte Vagrant
 * Nikdy byste neměli měnit Vagrantfile přímo. Existuje několik aspektů, které můžete přizpůsobit:
 * Základní nastavení (uživatel git, porty, RAM, IP, přeposílání portů) lze upravit pomocí souboru .settings.yaml. Pokyny viz  a  . Můžete tedy například spustit   a povolit předávání portů z hostitele: 1234 na hosta:80.
 * Po načtení souboru Vagrantfile proveďte další kroky vytvořením souboru s názvem Vagrantfile-extra.rb a jeho umístěním do stejné složky jako Vagrantfile - bude automaticky načten. V případě konfliktu nahradí hodnoty v souboru „extra“ hodnoty v tomto souboru. Viz příklad v adresáři support/directory.


 * Přidat vlastní puppet kód?
 * To je ideální, pokud chcete pracovat na svém vlastním webu MediaWiki místně a nechat MediaWiki-Vagrant nainstalovat vaše závislosti za vás. Je ideální, pokud máte vlastní vidličku. Existuje rozdíl mezi rolí a tímto případem použití. Role jsou určeny k instalaci v libovolném pořadí a bez přerušení. Pokud vaše vidlička potřebuje různé hovory a dostane se do potíží s rolemi, vytvořte si vlastní třídu a zvolte, co potřebujete, včetně rolí.
 * Chcete-li, vložte svůj vlastní puppet kód do  s vaší vlastní třídou, například:

Chcete-li použít svou třídu, přidejte ji do klíče "třídy" (classes) v souboru. Soubor můžete vytvořit, pokud neexistuje.

Poté spusťte  a udělejte změnu prostřednictvím systému Puppet.


 * Aktualizujete MediaWiki-Vagrant sám?
 * (Například pro použití nových rolí.) V terminálu přejděte do hostitelského počítače do adresáře vagrant a zadejte příkaz git, například . Obvykle budete chtít po aktualizaci spustit kód , abyste na svůj virtuální stroj použili všechny nové puppet změny.


 * Spouštějte GUI aplikace na virtuálním stroji?
 * Pokud máte nainstalovaný X server, SSH do virtuálního počítače pomocí  pro povolení X forwardingu. (Uživatelé Mac by měli aktualizovat na nejnovější verzi XQuartz.)


 * Alternativně můžete spustit virtuální stroj v režimu GUI, což vám umožní komunikovat s VM, jako by měl fyzický displej. Chcete-li povolit režim GUI, vytvořte soubor s názvem  ve složce kořenového úložiště, jehož obsah je:


 * Uložte soubor a spusťte  následovaný  . Displej virtuálního stroje se objeví v okně na ploše.


 *  Upravit zdroje přidělené VM?
 * Pokud chcete VM přidělit více či méně CPU / RAM, pokyny najdete v.

Alternativně to můžete udělat vytvořením souboru Vagrantfile-extra.rb (příklad viz podpora / pro příklad):


 * Změnit editor používaný pro zprávy git commit?

Přejděte na Horizon, vyberte Web Proxies a zadejte název hostitele DNS, řekněte Zobrazit novou wiki na " http:// /wiki/ "
 * Nastavit vlastní název hostitele?

Vytvořte soubor local.yaml v adresáři /vagrant/puppet/hieradata. V něm přidejte: Spusťte.
 * Nastavit vlastní název hostitele, aby místo domovské stránky wiki ukazoval na domovskou stránku mého vanrant?


 * Provozujete pobočku MediaWiki jinou než master?
 * V klíči  nastavte klíč "". Soubor můžete vytvořit, pokud neexistuje.

{{Note|1=Změnu je třeba provést PŘED prvním spuštěním {{kbd|1=vagrant up}}. Pokud se rozhodnete, že to chcete udělat později, proveďte změnu, zrušte svůj současný virtuální počítač pomocí, odstraňte stávající checkout na Mediawiki a nakonec vytvořte nový virtuální počítač s

Nastavení MediaWiki
Zvažte seskupení vašich konfigurací jako alternativu ke správě všech nastavení MediaWiki v jednom velkém souboru LocalSettings.php. Konfigurace můžete seskupit podle komponenty nebo tématu a vytvořit pro každou skupinu samostatný soubor PHP v. Zjednodušíte si takto údržbu vašich nastavení, dočasné deaktivovace konkrétní konfigurace a sdílní nastavení s ostatními. MediaWiki automaticky načte všechny soubory PHP v  v lexikálním pořadí. Pořadí, ve kterém jsou vaše konfigurace nastaveny, můžete ovládat tak, že budete přidávat dvoumístnou předponu ke každému názvu souboru.

Například:

 settings.d/   ├── 10-RunFirst.php ├── 20-SomeExtension.php └── 99-RunLast.php Mějte na paměti, že soubory nastavení v  jsou automaticky vytvořeny a zrušeny podle Vaší konfigurace Puppet. Nenastavujte sem své vlastní nastavení, protože Puppet jej smaže nebo přepíše. Místo toho si ponechejte soubory vlastních nastavení v.

Vagrant flags
Příkaz vagrant config --list zobrazí seznam všech aktuálních vagrantských flags.

Po počátečním  můžete v adresáři vagrant nastavit vagrant flags, který se zobrazí v seznamu konfigurací, např.

Fronta úloh
V případě, že testujete něco, co potřebuje prověřit frontu úloh, možná budete muset zvýšit počet běžících úloh. V současné době to není dostupné prostřednictvím LocalSettings.php, ale musí být toto nastaveno v konfiguračním souboru pro spouštěče úloh.


 * 1) Otevřít
 * 2) Změňte hodnotu klíče ' ' z   na požadovanou hodnotu (řekněme  )
 * 3) Opětovné spuštění s
 * 4) Pozor! Bude se to lišit od git masteru ve vašem kódu

Viz instrukce pro úpravu počtu jader CPU (velmi doporučeno pro úlohy vázané na CPU, jako je například video transkódování).

Další úložný prostor
Ve výchozím nastavení je v kořenovém oddílu v rámci VM relativně málo volného místa. Pokud plánujete otestovat nahrávání a zpracování velkých obrazových a video souborů, může to být nedostatečné.

Postup změny:
 * Vypněte VM
 * Otevřete VirtualBox Manager
 * Vyberte VM a přejděte do Nastavení
 * V části Úložiště (Storage) vyberte „Řadič: SATA“ (Controller: SATA) a klikněte na ikonu „Přidat pevný disk“ (Add hard disk).
 * Vyberte výchozí typ zobrazení disku.
 * Pojmenujte disk 'VagrantImageSpace' nebo podobně a přidělte mu dostatek místa (řekněme 80 GB) - ve výchozím nastavení bude soubor malý a rozšíří se na velikost pro skutečné využití, takže poskytněte tolik místa, kolik byste mohli potřebovat
 * Zavřete dialogy a restartujte VM
 * Spusťte  a získejte shell uvnitř terminálu
 * Spusťte  a vytvořte nové oddíly ...
 * Zadejte,  ,   a pro výchozí velikost dvakrát stiskněte (enter - zadejte)
 * Chcete-li uložit tabulku oddílů, zadejte
 * Spusťte  a vytvořte souborový systém
 * Spusťte  a upravte seznam připojení
 * Přidejte řádek na konec:
 * Uložte
 * Spusťte  a připojte souborový systém
 * Spusťte  a nastavte oprávnění souboru
 * Opusťte shell
 * Restartujte VM

Autorské role
The virtual machine created by MediaWiki-Vagrant resembles Wikimedia's production environment in key respects, and it uses the same tool—Puppet—that Wikimedia's technical operations team uses to manage production servers and Wikimedia Cloud VPS instances. Puppet is a configuration management tool that provides a domain-specific language for expressing software configurations in a declarative fashion. Files containing Puppet code are called 'manifests'. When Puppet runs, it interprets the manifests you feed it and configures the machine accordingly. A Vagrant role is a set of Puppet manifests.

MediaWiki-Vagrant's Puppet codebase contains abstractions that make it easy to automate the configuration of MediaWiki extensions and related software. If you are a developer working on a software project that relates to MediaWiki, you are encouraged to submit a patch with a Puppet role for your project. Adding a Vagrant role for your project makes it easy for other developers to check out your work. Using a managed virtual machine as a development sandbox for your project reduces the chance of "works-on-my-machine" errors that often result from geographically remote developers working in incompatible environments.

The easiest way to get started with custom roles is to look at how existing roles are implemented in. These roles depend on Puppet modules in  (usually,   translates to a call to  ) and use files and templates from the other   directories. The Puppet code is generally well-documented and contains examples that demonstrate its proper usage.

Some of the more useful puppet modules are:
 * mediawiki::extension: install and configure an extension (example)
 * mediawiki::import::text: create a documentation or test page on the wiki (example: declaration, page)
 * mediawiki::import::dump: import a wiki dump (example)
 * require_package: install a system package (example)
 * exec: execute a shell command (example)

Setting up an instance on Cloud VPS
You can use MediaWiki-Vagrant in Cloud VPS to install MediaWiki on a Wikimedia Cloud VPS instance and enable MediaWiki-Vagrant roles in it.

Bugs
If you spot a bug in MediaWiki-Vagrant, please report it. First, make sure the bug is not a known Vagrant or VirtualBox bug by searching the Vagrant issue tracker on GitHub and the VirtualBox bugtracker. If it is not, go ahead and submit the bug to Wikimedia Phabricator. Clearly describe the issue and include steps to reproduce, whenever possible.

Links

 * Project page on Ohloh
 * MediaWiki-Vagrant on GitHub
 * Issue tracker on Phabricator
 * HHVM/Vagrant steps necessary to enable the hhvm role on older MediaWiki-Vagrant installs
 * Bash commands needed for quick start on Ubuntu
 * Bash commands needed for quick start on Ubuntu