https://github.com/pxlrbt/move-wsl

Easily move your WSL distros VHDX file to a new location.
https://github.com/pxlrbt/move-wsl

bash-script batch-script maintainer-wanted powershell powershell-script windows wsl wsl2

Last synced: 25 days ago
JSON representation

Easily move your WSL distros VHDX file to a new location.

• Host: GitHub
• URL: https://github.com/pxlrbt/move-wsl
• Owner: pxlrbt
• License: gpl-3.0
• Created: 2020-03-20T15:04:25.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-24T13:56:41.000Z (5 months ago)
• Last Synced: 2024-09-29T04:06:47.759Z (about 1 month ago)
• Topics: bash-script, batch-script, maintainer-wanted, powershell, powershell-script, windows, wsl, wsl2
• Language: PowerShell
• Homepage:
• Size: 111 KB
• Stars: 1,433
• Watchers: 22
• Forks: 149
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - pxlrbt/move-wsl - Easily move your WSL distros VHDX file to a new location. (PowerShell)

README

        
> [!Warning]

> As I switched the OS, I am not updating this script or fixing bugs anymore.  

> Have a look at the issue tab for some known issues.  

> Happy to merge PRs with fixes.

# Move WSL

PowerShell script to move WSL 1 and WSL 2 distros VHDX file to a different location.

![Interactive Example](screencast.gif)

## Usage

> **Warning**

> 

> This script uses official `wsl` commands and was used by a lot of people. Nevertheless some people had weird issues that resulted in broken WSL disks.

> Make sure you have a backup of your data, so you can restore in case of an error.

Interactive way of moving wsl for Windows PowerShell.

1) `./move-wsl.ps1`

2) Select your distro

3) Enter your target (i.e. `D:\wsl target\ubuntu`)

## Moving Docker WSL

Before moving Docker WSL make sure to stop the Docker service. Otherwise Docker will crash and you may need to reset it to factory defaults.

## FAQ

### Default user was switched to root when moving a distro

Set your default user inside your distro by adding the following configuration to your `/etc/wsl.conf`.

```ini

[user]

default=YOUR_USERNAME

```

If the file doesn't exist create it manually. Then exit your distro, terminate it (`wsl -t YOUR_DISTRO`) and start it again. For further options see [Microsoft Docs](https://docs.microsoft.com/en-us/windows/wsl/wsl-config#user).

Some distributions also allow settings the default user via command line with `YOUR_DISTRO config --default-user YOUR_USER` (e.g. `ubuntu config --default-user johndoe`). Make sure to shutdown your distro before (`wsl -t YOUR_DISTRO`).

### Standard distro switched when moving it

Since we need to unregister to import it with the same name, the standard distro can be switched. Just set your standard distro again:

```sh

wsl -s YOUR_DISTRO

```

### WSL version was switched when moving distro

On import the distro will be registered with the current default WSL version. You can set your default WSL version with `wsl --set-default-version `.

When the WSL version was accidentally changed while moving, you can set the version with `wsl --set-version  `.