Skip to content

Add WSL2 setup tutorial [Docs]#661

Open
abhaygoudannavar wants to merge 1 commit into
urunc-dev:mainfrom
abhaygoudannavar:docs/wsl2-tutorial
Open

Add WSL2 setup tutorial [Docs]#661
abhaygoudannavar wants to merge 1 commit into
urunc-dev:mainfrom
abhaygoudannavar:docs/wsl2-tutorial

Conversation

@abhaygoudannavar
Copy link
Copy Markdown

Add a tutorial describing how to set up and run urunc on WSL2, covering KVM verification, snapshotter configuration (overlayfs vs devmapper), and nerdctl usage.

Refs: #643

Description

Add a new tutorial (docs/tutorials/Running-urunc-on-wsl2.md) that guides Windows/WSL2 users through running urunc on their environment. The tutorial covers:

  • Verifying KVM availability and enabling nested virtualization
  • Why nerdctl is recommended over Docker Desktop on WSL2
  • Using the overlayfs snapshotter since WSL2 lacks the dm_thin_pool kernel module
  • Running a sample unikernel container end-to-end

The tutorial links back to the main installation guide for standard steps to avoid documentation drift, as discussed in #643.

Also updates docs/tutorials/index.md to list the new tutorial.

Related issues

How was this tested?

Verified the tutorial steps manually on a WSL2 (Ubuntu) instance running on Windows 11 with KVM enabled. Confirmed that the markdown renders correctly and all links resolve properly.

LLM usage

no LLM usage.

Checklist

  • I have read the contribution guide.
  • The linter passes locally (make lint).
  • The e2e tests of at least one tool pass locally (make test_ctr, make test_nerdctl, make test_docker, make test_crictl).
  • If LLMs were used: I have read the llm policy.

Add a tutorial describing how to set up and run urunc on WSL2,
covering KVM verification, snapshotter configuration (overlayfs
vs devmapper), and nerdctl usage.

Refs: urunc-dev#643
Signed-off-by: abhaygoudannavar <abhaysgoudnvr@gmail.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

Deploy Preview for urunc ready!

Name Link
🔨 Latest commit 738064c
🔍 Latest deploy log https://app.netlify.com/projects/urunc/deploys/6a031cfcb8b7900008ce6634
😎 Deploy Preview https://deploy-preview-661--urunc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@abhaygoudannavar
Copy link
Copy Markdown
Author

@cmainas referd 1c9c720 ,any changes needed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add WSL2 setup guide — urunc works on WSL2 but is completely undocumented [Docs]

1 participant