Manual:Running MediaWiki on Windows Subsystem for Linux

This is documentation for running  on Windows 10 with the Windows Subsystem for Linux (WSL). See  for documentation on running MediaWiki directly on Windows.

Background
Windows 10 includes a Linux compatibility layer, the [https://docs.microsoft.com/en-us/windows/wsl/about Windows Subsystem for Linux], designed to help web developers needing a Linux/Unix development environment on a Windows computer. This can be used to run MediaWiki as if on a Linux machine, with less overhead and better integration compared to setting up and running a virtual machine.

This may make it a good option for Windows 10 laptops with limited RAM and CPU resources. However, WSL requires a 64-bit edition of Windows 10 (x64 or ARM64), and cannot run on 32-bit x86 Windows 10 installations.

Security notes
MediaWiki is a web application, and following these directions will set up a web server that runs on your computer and can be exposed to other computers on the network. In particular, note that PHP and other Linux code running in the web server may have access to your Windows  drive and may be able to read or modify files or run Windows programs.

It is strongly recommended to use this for development purposes only, not for server deployments, and to limit network access to the web server to avoid accidentally opening anything to the network. Only run MediaWiki and extensions that you trust.

WSL versions
There are two major versions of WSL available: the original which emulates the Linux kernel ABI as a Windows driver, and the newer WSL2 which uses a specialized Hyper-V virtual machine to run a native Linux kernel. The original WSL1 is available on Windows 10 version 1709 to 1909 and is likely to have problems trying install to mysql-server. The [https://www.microsoft.com/en-us/software-download/windows10 May 2020 Update] upgrades to WSL 2.

WSL2 is compatible with more software, but can complicate some integration scenarios a little as the VM has its own IP address separate from  . (Servers are port-forwarded to  , so this mostly works ok for setting up a web server.)

Note that WSL2 requires hardware support for virtualization and uses Hyper-V under the hood, but is available on Windows 10 Home as well as Windows 10 Pro. This will make it easier for developers to install on existing machines without spending money on a Pro upgrade, but may have compatibility problems with other VM software like VirtualBox. WSL1 doesn't require virtualization.

Setup

 * Go to Control Panel, Programs and Features, then the link on the left side Turn Windows features on or off, or run  .
 * Check "Windows Subsystem for Linux" and, for WSL2, "Virtual Machine Platform"
 * let it install and reboot
 * Go to 'Microsoft Store' and search for the latest [https://www.microsoft.com/en-gb/search/shop/apps?q=ubuntu "Ubuntu" Linux distribution]
 * install it!
 * Debian is also available, but might be slightly different in some respects.
 * Click on the "<tvar|1>Ubuntu</>" icon in Start menu or enter <tvar|2> </> from a <tvar|3>PowerShell</> session, (notice how the prompt changes from Windows to Linux style).
 * follow the on-screen prompts about setting up a Linux username and password
 * let it extract

WSL Setup
To use WSL2 mode, exit and run in a PowerShell session:



This may take a few minutes to convert filesystems.

To verify which version of WSL is in use do:



Dependency setup
First, ensure the system image is up to date: run <tvar|1> </> in the Ubuntu terminal. This may take a few minutes after first installation.

Install deps: <tvar|1> </>

Running services
You may have to manually start up services:


 * on WSL1 this may prompt Windows Firewall about the listening port. Allow it, but consider limiting to "private" networks for safety.
 * on WSL1 this may prompt Windows Firewall about the listening port. Allow it, but consider limiting to "private" networks for safety.
 * on WSL1 this may prompt Windows Firewall about the listening port. Allow it, but consider limiting to "private" networks for safety.

You may have to jump through some hoops to set the root password on mysql:


 * Run mysql as root:
 * In the mysql terminal run:
 * - If that fails try <tvar|1> </> instead.
 * - This must match with the wiki database in the install process
 * Now you can use username 'root', password 'your-password-here' when logging in from the installer
 * - This must match with the wiki database in the install process
 * Now you can use username 'root', password 'your-password-here' when logging in from the installer
 * Now you can use username 'root', password 'your-password-here' when logging in from the installer
 * Now you can use username 'root', password 'your-password-here' when logging in from the installer
 * Now you can use username 'root', password 'your-password-here' when logging in from the installer
 * Now you can use username 'root', password 'your-password-here' when logging in from the installer

MediaWiki setup
1>Special:MyLanguage/Download from Git</>|Clone things from git as you would on a Linux server.

Apache on Ubuntu is set by default to point at <tvar|1> </> for the docroot, you can create a dir under there to check out or reconfigure Apache with a custom path. I recommend <tvar|1> </> for consistency with convention that <tvar|2> </> is the main script path.


 * - Don't miss the dot at the end.
 * - Don't miss the dot at the end.
 * - Don't miss the dot at the end.
 * - Don't miss the dot at the end.
 * - Don't miss the dot at the end.

If git has trouble checking out over https, use a ssh developer login. Set up your SSH key in gerrit as with a Linux system, and check out as:



Extensions
For example (from <tvar|1>skins/</>):



Don't forget to run <tvar|1> </> in the MW directory, and for any extension dirs that require it.

Run the web installer in a browser at <tvar|url> </>; use your name and database here for installation.

When the installer prompts you to download <tvar|1> </> at the end, save it into <tvar|2> </> or equivalent and you will be able to access your wiki!

Job queue
You may want or need to manually run the 1>Special:MyLanguage/Manual:Job queue</>|job queue runner. Ideally this should be done via the web server, but in a pinch you can fire up the Ubuntu terminal and run:



Other configuration
For the most part the WSL environment will look like any other Ubuntu or Debian system, except that services won't automatically start and must be manually run on every boot. See 1>Special:MyLanguage/Manual:Running MediaWiki on Debian or Ubuntu</>|Running MediaWiki on Debian or Ubuntu for general instructions on running on these operation systems.

Editing files
From the Windows side you can access Linux files in <tvar|1> </>, so Windows text editors that are ok with Unix line endings can be used to work with your code and config.

[<tvar|url1>https://code.visualstudio.com/</> Visual Studio Code] also has a [<tvar|url2>https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl</> WSL remoting extension] which can integrate more directly with the WSL environment, which might be good for using PHP linting in the editor.

However note the warnings at [<tvar|url>https://devblogs.microsoft.com/commandline/do-not-change-linux-files-using-windows-apps-and-tools/</> Do not change Linux files using Windows apps and tools]

Or, you can use your favorite terminal-based editors.

Open issues

 * is the process timeout issue in TimedMediaHandler a common prob or unique to ARM64? (test me)