WSL: Difference between revisions

From NixOS Wiki
imported>Onny
Note that NixOS is not yet officially packaged on MS store
Klinger (talk | contribs)
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
== Setup ==
== Setup ==


Ensure that WSL is installed and up to date
Ensure that WSL is installed and up to date.


<syntaxhighlight lang="bash">
<syntaxhighlight lang="powershell">
wsl --install
wsl --update
wsl --update
</syntaxhighlight>
</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].
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].
Line 13: Line 16:
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 21: Line 24:
Start it with PowerShell
Start it with PowerShell


<syntaxhighlight lang="bash">
<syntaxhighlight lang="powershell">
wsl -d NixOS
wsl -d NixOS
</syntaxhighlight>
</syntaxhighlight>
Line 27: Line 30:
== Tips and tricks ==
== Tips and tricks ==


== Run container on startup ==
=== 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
To run the distro <code>NixOS</code> on Windows startup or user login in the background, proceed with following commands in PowerShell


<syntaxhighlight lang="bash">
<syntaxhighlight lang="powershell">
echo "" > $HOME\run_wsl2_at_startup.vbs
echo "" > $HOME\run_wsl2_at_startup.vbs
notepad $HOME\run_wsl2_at_startup.vbs
notepad $HOME\run_wsl2_at_startup.vbs
Line 38: Line 41:
Inside the script we define <code>NixOS</code> as the distribution name, as imported in the setup step above
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|vbs|<nowiki>
{{file|$HOME\run_wsl2_at_startup.vbs|vbscript|<nowiki>
set object = createobject("wscript.shell")  
set object = createobject("wscript.shell")  
object.run "wsl.exe --distribution NixOS", 0
object.run "wsl.exe --distribution NixOS", 0
Line 45: Line 48:
Execute following command to open the task planer
Execute following command to open the task planer


<syntaxhighlight lang="bash">
<syntaxhighlight lang="powershell">
taskschd.msc
taskschd.msc
</syntaxhighlight>
</syntaxhighlight>


Click on <code>New 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. On the tab "Action" click on "New ..." and insert as command: <code>%USERPROFILE%\run_wsl2_at_startup.vbs</code>
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