WSL: Difference between revisions

From NixOS Wiki
imported>Onny
m Restructuring page
Klinger (talk | contribs)
 
(6 intermediate revisions by 3 users not shown)
Line 3: Line 3:
== Setup ==
== Setup ==


Download the latest release of <code>nixos-wsl.tar.gz</code> from the [https://github.com/nix-community/NixOS-WSL/releases NixOS-WSL Github page].
Ensure that WSL is installed and up to date.
 
<syntaxhighlight lang="powershell">
wsl --install
wsl --update
</syntaxhighlight>
 
Sometimes you'll have to install WSL2 manually by [https://github.com/microsoft/WSL/releases downloading the msi-installation package].
 
NixOS is [https://github.com/microsoft/WSL/issues/11206 not yet packaged] as a official WSL distribution or on the Microsoft store. Download the latest release of <code>nixos-wsl.tar.gz</code> from the [https://github.com/nix-community/NixOS-WSL/releases NixOS-WSL Github page].


Import the WSL container using PowerShell
Import the WSL container using PowerShell


<syntaxhighlight lang="bash">
<syntaxhighlight lang="powershell">
wsl --import NixOS .\NixOS\ nixos-wsl.tar.gz --version 2
wsl --import NixOS .\NixOS\ nixos-wsl.tar.gz --version 2
</syntaxhighlight>
</syntaxhighlight>
Line 15: Line 24:
Start it with PowerShell
Start it with PowerShell


<syntaxhighlight lang="bash">
<syntaxhighlight lang="powershell">
wsl -d NixOS
wsl -d NixOS
</syntaxhighlight>
</syntaxhighlight>
== Tips and tricks ==
=== Run container on startup ===
To run the distro <code>NixOS</code> on Windows startup or user login in the background, proceed with following commands in PowerShell
<syntaxhighlight lang="powershell">
echo "" > $HOME\run_wsl2_at_startup.vbs
notepad $HOME\run_wsl2_at_startup.vbs
</syntaxhighlight>
Inside the script we define <code>NixOS</code> as the distribution name, as imported in the setup step above
{{file|$HOME\run_wsl2_at_startup.vbs|vbscript|<nowiki>
set object = createobject("wscript.shell")
object.run "wsl.exe --distribution NixOS", 0
</nowiki>}}
Execute following command to open the task planer
<syntaxhighlight lang="powershell">
taskschd.msc
</syntaxhighlight>
Click on <code>Create task</code> on the right pane, set name to <code>WSL</code>. On the tab "Triggers" click on "New ..." and select run task on user login in the dropdown menu. On the tab "Action" click on "New ..." and insert as command: <code>%USERPROFILE%\run_wsl2_at_startup.vbs</code>
[[Category:Container]]

Latest revision as of 20:36, 24 April 2024

Notes on running NixOS on the Windows Subsystem for Linux (WSL, WSL2)

Setup

Ensure that WSL is installed and up to date.

wsl --install
wsl --update

Sometimes you'll have to install WSL2 manually by downloading the msi-installation package.

NixOS is not yet packaged as a official WSL distribution or on the Microsoft store. Download the latest release of nixos-wsl.tar.gz from the NixOS-WSL Github page.

Import the WSL container using PowerShell

wsl --import NixOS .\NixOS\ nixos-wsl.tar.gz --version 2

Usage

Start it with PowerShell

wsl -d NixOS

Tips and tricks

Run container on startup

To run the distro NixOS on Windows startup or user login in the background, proceed with following commands in PowerShell

echo "" > $HOME\run_wsl2_at_startup.vbs
notepad $HOME\run_wsl2_at_startup.vbs

Inside the script we define NixOS as the distribution name, as imported in the setup step above

$HOME\run_wsl2_at_startup.vbs
set object = createobject("wscript.shell") 
object.run "wsl.exe --distribution NixOS", 0

Execute following command to open the task planer

taskschd.msc

Click on Create task on the right pane, set name to WSL. On the tab "Triggers" click on "New ..." and select run task on user login in the dropdown menu. On the tab "Action" click on "New ..." and insert as command: %USERPROFILE%\run_wsl2_at_startup.vbs