MediaWiki-Vagrant

This page is a translated version of the page MediaWiki-Vagrant and the translation is 34% complete.

Outdated translations are marked like this.

Брайан Дэвис объясняет в интервью на Викимании, что такое MediaWiki Vagrant

TechTalk про MediaWiki-Vagrant от Брайна Дэвиса и Дэна Дюваля

MediaWiki-Vagrant — это портативная среда разработки MediaWiki. Она состоит из набора скриптов конфигурации для Vagrant и VirtualBox, которые автоматизируют создание виртуальной машины, на которой запускается движок MediaWiki. Поскольку конфигурация ориентирована на легкую разработку, а не на безопасность, MediaWiki-Vagrant не рекомендуется для общедоступных вики.

Виртуальная машина, создаваемая MediaWiki-Vagrant, позволяет легко узнать, изменить и улучшить код MediaWiki: полезная информация об отладке отображается по умолчанию, а различные инструменты разработчика настроены специально для проверки и взаимодействия с кодом MediaWiki, включая мощный отладчик и интерактивный интерпретатор. А самое лучшее, что поскольку конфигурация автоматизирована и содержится в виртуальной среде, ошибки легко отменять.

Системные требования

Процессор: 64-битный x86 процессор
Операционная система: Linux, macOS, или Windows
Память: At least 4 GiB RAM total on your system, preferably 8 GiB or more, in order to run both the host operating system and the VM. Do not attempt to run on a system with only 2 GiB RAM, it will eventually fail.
Диск: For complex installations, you must have 10–12 GB free on the primary drive (/home partition for Linux, C: drive for Windows). Note in particular that the VM disk images will be stored under your home directory by default.
Сеть: Active network connection with sufficient bandwidth to download Debian Linux updates and the MediaWiki source code.
Время установки: От 20 минут до 2 часов, в зависимости от условий и наличия проблем

Быстрый старт

(Если вы устанавливаете MediaWiki-Vagrant через USB-дистрибутив, выполните действия, описанные в файле README, а не первые пять шагов.)

Скачайте Git
(только Linux) Install NFS if it is not already installed.
- В Ubuntu используйте sudo apt-get install nfs-kernel-server.
- Fedora usually comes with NFS installed; if not, run sudo dnf install nfs-utils.
Скачайте VirtualBox^[1]
Скачайте Vagrant. Note that Vagrant v2.3.7 is the last version licensed under a free license.^[2]

Clone code into your current directory (don't clone into a folder in WSL)^[3]

$ git clone --recursive https://gerrit.wikimedia.org/r/mediawiki/vagrant

Enter vagrant directory to run vagrant commands in:
```
$ cd vagrant
```
Run setup script to setup vagrant before starting the machine:
Linux/macOS:
```
$ ./setup.sh
```
Windows:
```
$ .\setup.bat
```
При появлении запроса введите ваш логин в Gerrit (рекомендуется) или просто нажмите ↵ Enter.

Если вы хотите использовать релизную ветку вместо последней версии, вы можете указать это при помощи vagrant hiera mediawiki::branch REL1_27
Запустите виртуальную машину:
```
$ vagrant up
```
Doing this for the first time might ask for your password as setting up directory sharing via NFS requires sysadmin rights. You can avoid that by setting the appropriate sudo permissions, as described here.

Pay attention to the console output to make sure that there are no errors. If you bump into errors, the #Troubleshooting startup section may be helpful.
Запустите команду vagrant open, чтобы открыть свой экземпляр MediaWiki. Вы можете войти с учётной записью Admin и паролем vagrant.
Включите дополнительные возможности MediaWiki и расширения.
To see a list of features (vagrant roles) you can enable, run:
```
$ vagrant roles list
```
To enable a feature, for example the VisualEditor , run:
```
$ vagrant roles enable visualeditor
```
To apply the roles you've enabled to your wiki, run:
```
$ vagrant provision
```

vagrant up fails if the default VirtualBox provider is used and the number of virtual CPUs on the host exceeds 32. Use vagrant config vagrant_cores <number of cores> to assign less than 32 of the cores to the VM.

Выполнение vagrant up в первый раз может занять час и более.

Подсистема Windows для Linux (WSL)

If you are using the WSL Linux-compatible shell on Windows: run commands with vagrant.exe instead of vagrant. Run vagrant.exe config --required instead of ./setup.bat, which does not work in the Linux bash shell.

The account running Vagrant will probably need the "Create Symbolic Links" permission (the easy way to achieve that is running as administrator).

Поиск и устранение неисправностей

Если на ваши вопросы нет ответа здесь, то хорошим вариантом будет IRC, особенно канал #wikimedia-tech ^{подключиться}.

Sometimes you can fix broken installations (e.g. one saying "No wiki found..." by running vagrant destroy; vagrant up which will rebuild the virtual machine without repeating the most time-consuming parts of the installation process.

Любой хост

You can try installing the versions of VirtualBox and Vagrant that your Linux distribution provides. If you're running recent Debian or Ubuntu, try sudo apt-get install virtualbox vagrant to install the packages for VirtualBox and Vagrant.

If you get errors from vagrant up, instead install the most recent versions of VirtualBox and Vagrant.

If you run into error message like "Couldn't open file $CLONED_REPOSITORY/trusty-cloud", try the following command:

vagrant up --provider=virtualbox

If you got any puppet errors you might need to init puppet submodules, on vagrant directory run git submodule update --init

- Error: Puppet::Parser::AST::Resource failed with error ArgumentError: Could not find declared class

Use http://127.0.0.1:8080/info.php to check that Apache/PHP is up and running.

You might want to compare the output of the initial run of vagrant up in your terminal with this sample. The initial setup may take a long time; if it seems to hang somewhere but there are no errors, just give it a while.

If you get warnings that your VirtualBox Guest Additions are the wrong version, you can try installing the vagrant-vbguest plugin which updates them automatically.

Vagrant rarely loses pairing with your VM. This thread discusses some ways to work around it (e.g. attaching old VM harddrive to the new profile)

Make sure that vagrant/mediawiki repository is up to date:

$ cd vagrant/mediawiki
$ git pull

Make sure that you have enabled virtualization in the BIOS. Sometimes this is under the Security settings.

Make sure your language encoding settings are UTF-8. If you get "invalid byte sequence in US-ASCII", try (re)setting your LANG and LC_ALL environment variables to something suitable.

Например:

export LANG=en_US.UTF-8
export LC_ALL=en_US.UTF-8

Если вы удаляли какие-либо старые виртуальные машины, то увидите сообщение об ошибке вроде "...path contains non-directory or non-existent components..." и vagrant up не завершится. Если вы используете NFS (в операционной системе, отличной от Windows), вы можете исправить это, удалив $export: введите sudo rm -i /etc/exports Vagrant воссоздает файл /etc/exports при следующем запуске vagrant up.

MediaWiki-Vagrant will not run on a host that doesn't support VT-X because it specifies a 64bit guest (virtual machine). MediaWiki-Vagrant needs to run on a 64-bit virtual machine, in part because it uses use deb packages from WMF production that are only built for the amd64 architecture.

Специфично для 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 [1])

VirtualBox несовместим с Hyper-V от Microsoft. If you have Hyper-V enabled – which may be the default if you have installed Visual Studio – you'll get the above errors trying to boot up a VM in VirtualBox. Есть три возможности:

- In command prompt, run bcdedit /set hypervisorlaunchtype off to turn off Hyper-V and reboot.

Чтобы включить обратно Hyper-V, верните его в auto вместо off

- Отключите Hyper-V через 'Add/Remove Windows Features' в панели управления и перезагрузитесь. This will get VirtualBox working, but will prevent you from using any Hyper-V VMs you may have, such as Windows Phone emulators.

- or, use the Hyper-V provider for Vagrant instead of VirtualBox.

Это может быть нестабильно.

Специфично для Mac

NFS errors To avoid NFS errors, while installing, ensure the firewall will accept connections: Apple > System Preferences > Security & Privacy > Firewall > Firewall Options.

You will need to UNcheck "Block all incoming connections" and probably also UNcheck "Enable stealth mode" in order to accept the following: netbiosd, nfsd, rpc.lockd, rpc.rquotad, rpcbind, VBoxHeadless. Note, you may need to restart your computer and change the status to "Allow incoming connections" during a couple vagrant ups. After installation, you may be able to re-check "Block all incoming connections and "Enable stealth mode" now that the firewall rules have been updated.

- В качестве альтернативы, вы можете отключить NFS при помощи vagrant config nfs_shares off

Debian и Ubuntu

MediaWiki-Vagrant uses NFS to share some folders with the host machine (your computer).

You need to set up your computer as an "NFS server", see e.g., Ubuntu instructions. On Debian, sudo apt-get install nfs-kernel-server will work; you may need to modprobe nfsv3 as well. Note that Debian's NFS server will not start without an entry in /etc/exports. If sudo rpcinfo -p doesn't show "nfs" services running, this is likely what's going on. Adding your home directory as the last line in /etc/exports and then /etc/init.d/nfs-kernel-server restart will usually be good enough to get you past this chicken-and-egg problem.

The NFS shares used by MediaWiki-Vagrant cannot be run from an encrypted directory, as may be the case if you are running on Ubuntu and using an encrypted home directory. To run MediaWiki-Vagrant, you can either:

- Move the MediaWiki-Vagrant directory to an unencrypted volume (e.g., /opt) before running vagrant up

- Alternatively, you can turn off NFS shares via vagrant config nfs_shares off

NFS setup seems to get stuck sometimes (initial vagrant up hangs at "Mounting NFS shared folders").

Restarting the NFS daemon on the host helps. (See #5802.)

If you are getting port forwarding errors saying the ports are in use, you may need to open up VirtualBox, entirely remove the virtual machine, and try again.

vagrant up may tell you that "The executable 'bsdtar' Vagrant is trying to run was not found in the PATH variable." You can fix this on Ubuntu with sudo apt install libarchive-tools.
On Ubuntu with Secure Boot enabled, you will have a difficult time installing VirtualBox. Your machine may give you guff when you run /sbin/vboxconfig. If it does, you can rectify the situation by signing the associated kernel module. Step-by-step instructions can be found in this askubuntu post.

Fedora

If you get Network 10.11.12.13 is not available. after running vagrant up, disable SELinux via sudo setenforce 0 or fix your SELinux setup.

If you get The provider for this Vagrant-managed machine is reporting that it is not yet ready for SSH. after running vagrant roles enable mediawiki --provision, make sure to explicitly set the provider, for example via vagrant destroy followed by vagrant up --provider=virtualbox

If you get mount.nfs: mount to NFS server '10.11.12.13:download-directory/vagrant' failed: RPC Error: Unable to receive, run vagrant config nfs_shares

Базовое использование

Инструмент командной строки vagrant на машине-хосте предоставляет некоторые подкоманды для контроля вашей виртуальной машины. Вы уже пользовались одной из них: vagrant up, которая включила виртуальную машину. Как и большинство подкоманд vagrant, вам нужно запускать их из директории MediaWiki-Vagrant или одной из её дочерних. Когда вы запускаете её в первый раз, Vagrant получит образ системы и настроит необходимое программное обеспечение для запуска MediaWiki. Это может занять 1–2 часа времени CPU и настенных часов на широкополосном соединении, но это нужно всего один раз. Когда вы запустите vagrant up в будущем, он просто загрузит машину. You've already used one: vagrant up, which turns on the virtual machine. Like most vagrant subcommands, you need to run it from the MediaWiki-Vagrant directory or one of its children. When you first run it, Vagrant will fetch a system image and set up requisite software for running MediaWiki. This can take 1–2 hours of CPU and wall clock time on a broadband connection, but it only needs to happen once. When you run vagrant up in the future, it will simply boot up the machine.

vagrant ssh запускает интерактивную оболочку входа (login shell) на виртуальной машине. Он авторизует вас как пользователя vagrant; root-доступ возможен через sudo, который выполняется без пароля. Поскольку виртуальная машина целиком находится в песочнице внутри вашего компьютера, то она настроен для удобства, а не безопасности. Как правило, когда вы встречаете запрос пароля, этот пароль vagrant.

После авторизации вы должны увидеть цветной баннер MediaWiki и несколько напоминаний о полезных командах.

Команда phpsh запускает интерактивный PHP-интерпретатор с уже загруженным кодом MediaWiki. Вы можете ввести какой-либо код, нажать «Enter», и код будет моментально выполнен. Если вы начнёте строку с «=», её расчётное значение будет красиво отформатировано и выведено. Введите ? для быстрой справки или help start для дополнительных инструкций. You can type in some code, hit 'enter', and the code will be evaluated immediately. If you start a line with '=', its computed value will be pretty-printed. Type ? for quick help or help start for additional instructions.

Папка /vagrant соответствует папке MediaWiki-Vagrant на вашей машине-хосте, и её содержимое общее. Код MediaWiki установлен в /vagrant/mediawiki. Это позволяет вам использовать свою обычную среду редактирования на машине-хосте, чтобы редактировать MediaWiki-код, который запускается на вашей виртуальной машине.

Обновление

Используйте vagrant git-update, чтобы сохранять актуальность ваших git-репозиториев, внешних библиотек и схемы базы данных. Это команда эквивалентна запуску This command is equivalent to running

git pull в core и директориях всех расширений и тем отображения

composer update, чтобы убедиться, что доступны последние версии библиотек, устанавливаемых через Composer

и наконец скрипт update.php.

Вам также следует периодически (или когда потребуется новая функциональность) обновлять сам MediaWiki-Vagrant, vagrant git-update это не включает. Запустите:

git pull

… в вашей корневой директории MediaWiki-Vagrant. Это возымеет эффект после запуска:

vagrant provision

You can run that command immediately after you run git pull, or sometime after.

Внимание: Если вы обновите из git'а вручную, вам также может потребоваться запустить composer update для загрузки внешних библиотек, необходимых MediaWiki. Вы можете запустить скрипт checkComposerLockUpToDate.php, чтобы узнать, требуется ли composer update.

Some projects have NPM dependencies, often for development usage only, that are not installed by Composer. These may be approximately identified with find -not $ -name node_modules -prune $ -name package.json and manually installed as needed after an update by executing npm install in each directory wanted.

Log out of your virtual machine by typing logout or by pressing Ctrl+D. Now that you're back in a standard command prompt, you can run vagrant halt to shut down the virtual machine and vagrant up to bring it back up. vagrant destroy will delete the virtual machine's files; this command is useful if you want to return your instance to a pristine state. (You'll need to follow up with vagrant up to provision a fresh instance.)

Использование ролей

MediaWiki-Vagrant sets up a basic MediaWiki instance by default, but it also knows how to configure a range of complementary software, including some popular MediaWiki extensions and their dependencies. These optional software stacks are collectively known as 'roles', and MediaWiki-Vagrant offers an easy and powerful command-line interface for managing them.

$ vagrant roles list # Показать список доступных ролей. $ vagrant roles enable роль # Включить role для машины. $ vagrant roles disable роль # Выключить role для машины. $ vagrant provision # После того, как вы закончите включение и/или отключение ролей, запустите это, чтобы изменения вступили в силу.

Посмотрите короткий скринкаст, демонстрирующий, как использовать роли. Страница о ролях содержит больше информации о некоторых ролях.

If you add many roles, you may need to increase memory available to the Vagrant VM. In particular, setting up the "browsertests" role involves compiling the ffi ruby Gem which is a memory-hungry task; if it fails try freeing some memory in the VM or increasing its memory allocation (bug 53864).

Смотрите раздел Создание ролей ниже, если вы заинтересованы в добавлении ролей в MediaWiki-Vagrant.

Устранение ошибок в определенных ролях

centralauth

There are some roles that require special attention, centralauth role does not run db migrations automatically via puppet and requires running those by hand. If you get errors on provisioning this role try to run this script on the extension and see the errors it outputs:

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

Once you get a more concrete error you probably need to know what migration you need to run from the ones here:

extensions/CentralAuth/db_patches

wikidata

A simple vagrant roles enable wikidata && vagrant provision would fail. Here is a complete set of commands to make the Wikidata role up and running.

$ 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
$ exit
$ vagrant roles enable wikidata
$ vagrant provision

Note that the first provision may complain, thus looking like a failure. However, if you run a second provision, you will see that everything goes fine.

You may then point your browser to http://wikidata.wiki.local.wmftest.net:8080/. To create a new wikidata item load http://wikidata.wiki.local.wmftest.net:8080/wiki/Special:NewItem and to create a new property navigate to http://wikidata.wiki.local.wmftest.net:8080/wiki/Special:NewProperty

Как импортировать дамп Викиданных

The Vagrant command import-dump, which imports an XML file into MediaWiki, does not handle wikis other than the default one (see phab:T183274#3893785). You need to run the importDump.php script inside the Vagrant box.

Здесь описана процедура импорта XML-дампов.

$ mkdir wikidata_dumps
$ cd wikidata_dumps

скачайте части pages-articles. Например:

$ wget https://dumps.wikimedia.org/wikidatawiki/latest/wikidatawiki-latest-pages-articles10.xml-p5264684p6341661.bz2

enable the import of Wikibase entities (see phab:T72898#1588002). Append the following line to your LocalSettings.php:

$wgWBRepoSettings[ 'allowEntityImport' ] = true;

the following BASH script can help you monitor the process. You can paste it in a import_wikidata.sh file. Note that the highlighted line calls the actual import script:

#!/usr/bin/env bash

chunks=$(find wikidata_dumps -type f)
for chunk in $chunks
do
    now=$(date)
    echo "$now: started import of $chunk" >> wd_import.log
    echo "-------------------------------------------" >> wd_import.log
    bzcat $chunk | mwscript importDump.php --wiki=wikidatawiki --uploads --debug --report 10000 2>>wd_import.log
    now=$(date)
    echo "-------------------------------------------" >> wd_import.log
    echo "$now: completed import of $chunk" >> wd_import.log
    echo "===========================================" >> wd_import.log
done

log into the Vagrant box and run the script. Debug messages should show up there:

$ vagrant ssh
$ cd /vagrant
$ sudo chmod +x import_wikidata.sh
$ ./import_wikidata.sh

you can follow the progress log from outside the Vagrant box:

$ tail -f wd_import.log

Дополнительные предложения

Ускорение работы MediaWiki в Windows

MediaWiki out-of-the-box will likely run slow (page loads take 5+ seconds). This is because the virtual machine uses a shared file system that retrieves the files very slowly. Enabling NFS on Windows by installing the Vagrant WinNFSd plugin with vagrant plugin install vagrant-winnfsd, enabling NFS shares with vagrant config nfs_shares true, and restarting the machine with vagrant reload should significantly speed up page load times. You should make sure that the plugin is installed every time you run the machine as well.^[4] You can further speed it up by enabling nfs_cache, however, be warned that your wiki may run into weird errors because some files may not be updated completely when using the cache.

You can also speed up Mediawiki by using smb_shares. Make sure not to enable it at the same time as nfs_shares. Enable it with vagrant config smb_shares yes and run vagrant reload in an shell run as an administrator. If you don't run it as an administrator, you will be warned with an error when vagrant goes up and when you go to the wiki address, you will see a Wiki not found. When prompted, type in the username of your account (the name of your home user directory) and password (your Microsoft account password if your account is not a local account with a normal password).

Локальная копия ядра MediaWiki

Sometimes you may want to start over from scratch by removing the entire vagrant directory or cleaning out the vagrant/mediawiki directory. In order to speed up the vagrant provisioning process, you may want to consider keeping a local, updated clone of the MediaWiki core that you copy into vagrant/mediawiki.

например, предположим, что вы клонируете репозитории MediaWiki в ~/projects/mediawiki/:

# склонируйте и сохраните чистую копию ядра MediaWiki в ~/projects/mediawiki/core
cd ~/projects/mediawiki/
git clone ssh://<your-gerrit-username>@gerrit.wikimedia.org:29418/mediawiki/core

# склонируйте чистую копию vagrant в ~/projects/mediawiki/vagrant
cd ~/projects/mediawiki
git clone ssh://<your-gerrit-username>@gerrit.wikimedia.org:29418/mediawiki/vagrant

# создайте поддиректорию mediawiki, если она не существует
cd ~/projects/mediawiki/vagrant
mkdir ~/projects/mediawiki/vagrant/mediawiki

# скопируйте чистое ядро MediaWiki в чистую директорию vagrant/mediawiki
cp -r ~/projects/mediawiki/core/ ~/projects/mediawiki/vagrant/mediawiki

Обновление склонированных репозиториев

Обновляйте склонированные репозитории так часто, как это возможно/необходимо.

cd ~/projects/mediawiki/core
git pull

cd ~/projects/mediawiki/vagrant
git pull
git submodule update --init --recursive

Или для обновления всех склонированных репозиториев:

vagrant git-update

Перезапуск Vagrant

If you change configuration (e.g. vagrant_ram, your VM/MediaWiki website freezes, or you experience a problem, vagrant reload may resolve it. This will restart your guest. Some roles also require reloading, which should happen automatically.

Когда включать роли

Включайте роли только после того, как вы успешно выполнили свой первый vagrant up.

Обратите внимание, что vagrant destroy не сбросит включённые роли. Убедитесь, что отключили все роли после выполнения vagrant destroy, затем выполните vagrant up. Теперь вы можете заново включить любые роли и запустить vagrant provision. Be sure to disable all roles after running vagrant destroy, then run vagrant up. Then you can re-enable any roles and run vagrant provision.

Vagrant за прокси

Если вы находитесь за прокси, Vagrant может бросить несколько ошибок. Вы можете установить vagrant-proxyconf. Это плагин, который позволяет вашей виртуальной машине использовать определённые прокси. Это руководство по быстрой установке. Подробную документацию смотрите здесь.

Установите плагин:

vagrant plugin install vagrant-proxyconf

To configure proxy settings for all pieces of software on all vagrant VMs, add the following lines to your $VAGRANT_HOME/Vagrantfile (default ~/.vagrant.d/Vagrantfile).

Vagrant.configure("2") do |config|
  if Vagrant.has_plugin?("vagrant-proxyconf")
    config.proxy.http     = "http://192.168.0.2:3128/"
    config.proxy.https    = "http://192.168.0.2:3128/"
    config.proxy.no_proxy = "localhost,127.0.0.1,.example.com"
  end
  # ... other stuff
end

Замените адреса на ip и номер порта вашего прокси-сервера. Используйте настройку config.proxy.no_proxy, чтобы перечислить все сайты/домены, для которых вы хотите обойти прокси-сервер. Например,

config.proxy.no_proxy = "localhost,127.0.0.1,.example.com,.someinternaldomain.com"

Now when you run a vagrant up, there shouldn’t be any warnings.

To disable the plugin, set config.proxy.enabled to false or empty string (""). You can also disable it for specific applications. For example,

config.proxy.enabled         # → all applications enabled(default)
config.proxy.enabled = true  # → all applications enabled
config.proxy.enabled = { svn: false, docker: false }
                             # → specific applications disabled
config.proxy.enabled = ""    # → all applications disabled
config.proxy.enabled = false # → all applications disabled

MediaWiki-Vagrant prep

You may want to consider using a shell script such as mw-vagrant-prep to prepare a directory for a MediaWiki-Vagrant install.

Отладка

Vagrant

You can debug MediaWiki-Vagrant itself (e.g. the errors that happen during vagrant up) with VAGRANT_LOG:

VAGRANT_LOG=debug vagrant up

Provisioning

You can debug the provisioning process by running

PUPPET_DEBUG=1 vagrant provision

PHP

You can debug PHP with Xdebug. Debugging in PHP is different from other client-side debugging. Your IDE listens for incoming connections, and when you access the server with a browser, a special header instructs PHP to connect to your IDE. For lack of better documentation, see the (old and overly verbose) MediaWiki-Vagrant/Advanced usage#MediaWiki debugging using Xdebug and an IDE in your host for further information.

Chrome

For Chrome users, you should get XDebug Helper, and optionally Clear Cache, HTTP headers, and Mod Headers.

Configure clear cache to automatically reload after clearing, and set up keyboard shortcuts (e.g. Ctrl+R for clear&reload, Ctrl+⇧ Shift+D to switch XDebugger on/off)

Firefox

Firefox users should check out easy Xdebug.

Install and configure an xdebug-compatible IDE on your machine (Eclipse, PhpStorm, Emacs, etc.)

In IDE, start listening for the incoming debug connection

In IDE, set break point at the spot that interests you

Enable XDebug in the browser and navigate to your vagrant installation ( http://127.0.0.1:8080/... )

CLI

For maintenance scripts and other code executed from CLI, you can use the xdebug_on and xdebug_off shell commands to enable/disable debugging.

Файлы журналов (логи)

Логи mediawiki находятся в /vagrant/logs. Файлы логов для Apache находятся в /var/log/apache2/, но похоже, что они не пишутся. Лог запроса MySQL может быть получен выполнением SET GLOBAL general_log = 'ON'; на клиенте и затем просмотром /var/lib/mysql/*.log.

Запуск и отладка юнит-тестов

Чтобы запустить (run) тесты PHPUnit для ВСЕХ расширений:

$ vagrant ssh
$ sudo -u www-data env PHPUNIT_WIKI=wiki PHPUNIT_LOGS=0 composer --working-dir=/vagrant/mediawiki phpunit

To run unit tests for a single extension:

$ sudo -u www-data env PHPUNIT_WIKI=wiki PHPUNIT_LOGS=0 composer --working-dir=/vagrant/mediawiki composer phpunit /vagrant/mediawiki/extensions/ExtensionName/tests/phpunit/

Some tests may require running as the proper user to create lock files and such, hence this command runs as the "user" www-data that handles web requests.

For building coverage reports, see Manual:PHP unit testing/Code coverage#MediaWiki-Vagrant.

Отладка тестов phpunit немного сложнее. This method is a bit hacky, but can be used until debugging remote interpreter improves (e.g. in phpStorm 8 EAP). Этот обходной пусть позволяет вам запускать юнит-тесты MediaWiki из браузера.

Загрузите файл phpunit.phar в вашу корневую директорию vagrant.

Create a php file unittest.php in the root of the mediawiki directory.

Do not commit this file to the repository. Paste the following code into it:

unittest.php

<html><body><pre>
<?php
error_reporting(E_ALL);
ini_set('display_errors', 1);
require_once 'includes/WebStart.php';
$_SERVER[ 'argv' ] = array(
	'--configuration', '/vagrant/mediawiki/tests/phpunit/suite.xml',
	'/vagrant/mediawiki/extensions/JsonConfig/tests/phpunit/JCObjContentTest.php',
);
require_once '/vagrant/mediawiki/tests/TestsAutoLoader.php';
require_once '/vagrant/phpunit.phar';
PHPUnit_TextUI_Command::main(false);

In the above file, change argv parameter to the name of your test file

Apache maps the root of the MediaWiki directory to /w.

So navigate to http://127.0.0.1:8080/w/unittest.php to run this file

Follow #Debugging instructions to attach your debugger

Запуск браузерных тестов

For JavaScript unit tests (QUnit), see Manual:JavaScript unit testing .

For browser end-to-end tests (Selenium), see Quality Assurance/Browser testing/Running tests#Running VisualEditor browser tests via Vagrant

Отправка (push) коммитов

Если вы используете MediaWiki-Vagrant для разработки, то вы, вероятно, захотите отправить (запушить) некоторые коммиты в репозиторий ядра MediaWiki или расширения, используя git review. По умолчанию все удалённые репозитории указывают на URL'ы с https://. Чтобы избежать переопределения этого на каждом конкретном случае, выполните:

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

Вам также необходимо иметь свои ssh-ключи в ~/.ssh.

Gerrit

To submit changes, use cd to navigate to your extensions folder. Then follow the instructions on submitting a patch via gerrit.

Разрешение проблем

Проверить версию и настройки PHP: http://127.0.0.1:8080/info.php

Отредактировать LocalSettings.php?: Сначала проверьте, что нет роли (vagrant list-roles), которая уже делает то, что вам нужно.

Если нет, создайте файл в директории settings.d/. Смотрите README и файл 00-debug.php-example.

Update MediaWiki code?: The easiest is to use vagrant git-update from the host.

Or, to just update the code without dependencies, you can use regular git fetch, pull, etc. commands in vagrant/mediawiki and vagrant/mediawiki/extensions/SomeExtension directories. You can run these commands on the virtual machine, but the file access will be faster on the host machine. MediaWiki-Vagrant pulls code from git master when you initially set up and/or add a role, but doesn't automatically update code after that.

Запустить интерпретатор PHP для MediaWiki: Подключитесь по ssh к vagrant и запустите mwscript eval.php. Вам может потребоваться запустить это с sudo

Запустить интерпретатор SQL для MediaWiki: Подключитесь по ssh к vagrant и запустите mwscript sql.php. Вам может потребоваться запустить это с sudo

Update virtual machine software packages?: vagrant provision does not update system packages in the VM.

When you connect with vagrant ssh the login message will inform that you:
NN packages can be updated.
NN updates are security updates.
In vagrant ssh:

to update all packages, enter sudo apt-get update && sudo apt-get upgrade

for "automatic installation of security (and other) upgrades", similar to Cloud VPS instances, enter sudo unattended-upgrade

to update to the same packages that are on production WMF servers... TODO

Customize Vagrant: You should never need to change Vagrantfile directly.

There are several aspects of vagrant you can customize:

Core settings (git user, ports, ram, ip, port forwarding) can be customized via .settings.yaml file.

See vagrant config --help and vagrant forward-port --help for instructions. So for example you may run vagrant forward-port 1234 80 to enable port forwarding from host:1234 to guest:80.

Perform additional steps after Vagrantfile load by creating a file called Vagrantfile-extra.rb and placing it in the same folder as Vagrantfile - it will be automatically loaded.

In case of conflict, values in the 'extra' file will supersede values in this file. See example in support/ directory.

Добавить собственный код Puppet?

This is ideal if you want to work on your own MediaWiki site locally and let the MediaWiki-Vagrant install your dependencies for you.

It's ideal if you have your own fork. There is a distinction between a role and this use case. Roles are meant to be installed in any order and without breaking. If your fork needs different calls and get in trouble with roles, create your own class and call what you need, including roles.

To do so, place your custom puppet code in puppet/modules/local/manifests/myown.pp with your own class, like so:

class local::myown {
    include ::role::svg
}

To apply your class, add it to the "classes" key in puppet/hieradata/local.yaml. Вы можете создать файл, если он не существует.

classes:
  - local::myown

Затем запустите vagrant provision, чтобы применить изменения используя Puppet.

Update MediaWiki-Vagrant itself?: (For example, to use new roles.) In a terminal, change to the vagrant directory on the host computer and enter a regular git command such as git pull --ff-only.

You will typically want to run vagrant provision after updating to apply any new puppet changes to your virtual machine.

Run GUI applications on the virtual machine?: If you have an X server installed, SSH into the virtual machine using ssh -- -X to enable X forwarding.

(Mac users should update to the latest version of XQuartz.)

As an alternative, you can run the virtual machine in GUI mode, which allows you to interact with the VM as though it had a physical display.

To enable GUI mode, create a file called Vagrantfile-extra.rb in the root repository folder, with this as its content:

Vagrant.configure('2') do |config|
    config.vm.provider :virtualbox do |vb|
        vb.gui = true
    end
end

Save the file and run vagrant halt followed by vagrant up.

The virtual machine's display will appear in a window on your desktop.

Adjust the resources allocated to the VM?: If you'd like to allocate more or less CPU / RAM to the VM, see vagrant config --help for instructions.

Alternatively, you can do it by creating Vagrantfile-extra.rb (see support/ dir for an example):

Vagrant.configure('2') do |config|
    config.vm.provider :virtualbox do |vb|
        # See http://www.virtualbox.org/manual/ch08.html for additional options.
        vb.customize ['modifyvm', :id, '--memory', '768']
        vb.customize ['modifyvm', :id, '--cpus', '2']
    end
end

Change the editor used for git commit messages?

git config --global core.editor "vim"

Настроить другое имя хоста?: Go to Horizon, choose Web Proxies, and enter a DNS hostname, say <hostname>

View your new wiki at "http://<hostname>/wiki/"

Make the custom hostname point to homepage of my vagrant role instead of wiki homepage?

Создайте файл local.yaml в папке /vagrant/puppet/hieradata. В нём добавьте:

<rolename>::vhost_name:<hostname>
role::mediawiki::hostname: localhost

Выполнить vagrant provision.

Run a branch of MediaWiki other than master?: Set the mediawiki::branch key in puppet/hieradata/local.yaml.

You can create the file if it doesn't exist.

mediawiki::branch: "wmf/1.24/wmf18"

This change has to be made BEFORE running vagrant up for the first time. If you decide you want to do it later, make the change, destroy your current VM with vagrant destroy -f, delete your existing mediawiki checkout and finally build a new VM with vagrant up.

Vagrant is designed to run with the master branch, and may not work perfectly, or at all with older versions of core and/or extensions^[5].

For the MediaWiki 1.35 release branch, it requires some modification to adjust PHP version requirements that are currently not met. See Topic:W05qhsn58ztktod8 for instructions.

Расширенное использование

Настройки MediaWiki

As an alternative to managing all MediaWiki settings in a single, large LocalSettings.php file, consider grouping your configurations by component or theme, and creating a separate PHP file in settings.d/ for each group. This makes it quite easy to keep your settings organized, to temporarily disable specific configurations, and to share settings with others.

MediaWiki will automatically load any PHP files in settings.d/ in lexical order. You can control the order in which your configurations are set by adopting the habit of adding a two-digit prefix to each file name.

Например:

    settings.d/
    ├── 10-RunFirst.php
    ├── 20-SomeExtension.php
    └── 99-RunLast.php

Note that the settings files in settings.d/puppet-managed are automatically created and destroyed in response to your Puppet configuration. Don't put your custom settings there, because Puppet will erase or override them. Keep your custom settings files in settings.d/ instead.

Флаги Vagrant

vagrant config --list выводит список всех текущих флагов Vagrant.

After the initial ./setup.sh, in your vagrant directory, you can then set one of the vagrant flags that appears in the config list, e.g. vagrant config nfs_shares no

Очередь задач

If you're testing something that needs to churn the job queue, you may need to increase the number of job runners. Currently this is not available through LocalSettings.php, but must be set in the config file for the job runner.

Open puppet/modules/mediawiki/templates/jobrunner.json.erb

Change the value for the runners key from 1 to the desired value (say, 4)

Re-provision with vagrant --provision

Beware this will be a difference from the git master in your code

See instructions above for adjusting CPU core count appropriately (highly recommended for CPU-bound task such as video transcoding).

Дополнительное пространство для хранения

By default, there is relatively little free space on the root partition within the VM. If you plan to test uploading and processing of large image and video files, this may be insufficient.

Manual steps:

Shut down the VM (vagrant halt)

Open VirtualBox Manager

Select the VM and go into Settings

- Under Storage, select "Controller: SATA" and click the "Add hard disk" icon.

- Select the default disk image type.

- Name the disk 'VagrantImageSpace' or similar, and give it enough space (say, 80GB) -- by default the file will start small and expand to actual usage, so give as much space as you might need

- Close out the dialogs and restart the VM (vagrant up)

Run vagrant ssh to get a shell inside the terminal

- Run sudo fdisk /dev/sdb to set up new partitions...

- Type n, p, 1, and hit (enter) twice for default size

- Type w to save the partition table

Run sudo mke2fs /dev/sdb1 to create the filesystem

Run sudo vi /etc/fstab to edit the mounts list

- Add line at end: /dev/sdb1 /srv/images ext4 errors=remount-ro 0 2

- save out

Run sudo mount /srv/images to mount the filesystem

Run sudo chown www-data:www-data /srv/images to set the file permissions

Exit the shell exit

Reboot the VM (vagrant halt; vagrant up)

Создание ролей

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 puppet/modules/role/manifests/*.pp. These roles depend on Puppet modules in puppet/modules (usually, foo::bar { ... } translates to a call to puppet/modules/foo/manifests/bar.pp) and use files and templates from the other puppet/modules/role/*/rolename/ 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)

Установка инстанса в 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.

Баги

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 a bug report to Wikimedia Phabricator. Clearly describe the issue and include steps to reproduce, whenever possible.

Ссылки

Страница проекта на Ohloh
MediaWiki-Vagrant на GitHub
Трекер задач на Phabricator
Watch 2014-11-25 Tech talk on "Что нового с MediaWiki Vagrant".
Команды bash, необходимые для быстрого старта в Ubuntu
OS upgrade

Примечания

↑ Если вы используете Fedora, не следуйте инструкциям Oracle. Вместо этого включите репозитории RPMfusion (например, через конфигурацию Apper), затем выберите sudo dnf install VirtualBox VirtualBox-kmodsrc akmod-VirtualBox kmod-VirtualBox (обратите внимание на чувствительность к регистру, а иногда и к версии! Если вы не найдёте пакет, поищите вместо этого в Apper). В качестве альтернативы вы можете следовать этому руководству. You may get an error about your kernel being too recent. If you do, install akmods-VirtualBox, and run sudo akmods to make sure the module builds.
↑ On Fedora, you can run sudo dnf install vagrant.
↑ https://github.com/hashicorp/vagrant/issues/10576#issuecomment-452793401
↑ https://peshmerge.io/how-to-speed-up-vagrant-on-windows-10-using-nfs/
↑ Vagrant dependent on MediaWiki 1.21+

[fedora-1] Если вы используете Fedora, не следуйте инструкциям Oracle. Вместо этого включите репозитории RPMfusion (например, через конфигурацию Apper), затем выберите sudo dnf install VirtualBox VirtualBox-kmodsrc akmod-VirtualBox kmod-VirtualBox (обратите внимание на чувствительность к регистру, а иногда и к версии! Если вы не найдёте пакет, поищите вместо этого в Apper). В качестве альтернативы вы можете следовать этому руководству. You may get an error about your kernel being too recent. If you do, install akmods-VirtualBox, and run sudo akmods to make sure the module builds.

[2] On Fedora, you can run sudo dnf install vagrant.

[3] ttps://github.com/hashicorp/vagrant/issues/10576#issuecomment-452793401

[4] ttps://peshmerge.io/how-to-speed-up-vagrant-on-windows-10-using-nfs/

[5] Vagrant dependent on MediaWiki 1.21+

[1]

[2]

[3]

[4]

[5]