-
-
Notifications
You must be signed in to change notification settings - Fork 2
windows wsl2 setup
This is the operations runbook for running ɳSelf on Windows. The full step-by-step user guide lives at windows-wsl2 — this page covers the operational decisions, prerequisites, and troubleshooting checklist.
Native Windows binaries ship from v1.0.12 (P97 G3-T01). They build, run nself --version, and execute pure-Go commands. They do not support the trust subsystem:
| Subsystem | Native Windows | WSL2 |
|---|---|---|
nself init / build
|
Yes | Yes |
nself plugin |
Yes | Yes |
nself trust install (DNS, mkcert, ports) |
No (returns "unsupported OS") | Yes |
nself start (Docker) |
Requires Docker Desktop with WSL backend | Yes |
*.local.nself.org resolution |
Requires manual hosts edits | Automatic via dnsmasq |
WSL2 is required for any local-dev workflow that involves Docker containers or local TLS.
- Windows 10 22H2 (build 19045+) or Windows 11
- Hyper-V capable CPU (most x64 / arm64 since 2017)
- 8 GB RAM minimum, 16 GB recommended
- 20 GB free disk
-
Enable WSL2. Elevated PowerShell:
wsl --install. Reboot when prompted. -
Install Ubuntu 22.04 LTS.
wsl --install -d Ubuntu-22.04. Launch once to set username + password. - Install Docker Desktop. Enable "Use WSL 2 based engine" during install. After install: Settings -> Resources -> WSL Integration -> toggle Ubuntu-22.04 ON.
-
Install ɳSelf inside Ubuntu.
brew tap nself-org/nself && brew install nself(Linuxbrew). -
Verify.
nself version-> expectnself v1.0.12 (linux/amd64)(or current).
Full transcript: windows-wsl2.
When a Windows user reports an issue, confirm in this order:
-
wsl --versionshowsWSL version: 2.x.xandKernel version: 5.15+. -
wsl -l -vlists Ubuntu-22.04 with VERSION 2. -
docker psruns inside Ubuntu withoutpermission denied(user is indockergroup). -
nself doctorinside Ubuntu reports clean. - DNS:
dig ummat.local.nself.org @127.0.0.1returns 127.0.0.1 (afternself trust install). - Network: from Windows browser,
https://ummat.local.nself.org:8443loads through WSL2 port forwarding.
| Symptom | Cause | Fix |
|---|---|---|
docker: command not found inside WSL |
WSL Integration not enabled in Docker Desktop | Settings -> Resources -> WSL Integration -> toggle target distro |
localhost:8443 not reachable from Windows browser |
WSL2 NAT didn't forward port | Restart Docker Desktop, or wsl --shutdown then relaunch |
nself trust install runs on native binary and reports "unsupported OS" |
User installed via install.ps1 and ran outside WSL |
Re-run inside Ubuntu shell |
File ops on /mnt/c/... are 10x slower |
WSL2 9P filesystem overhead | Move project to ~/projects inside WSL home |
The Windows binary released at v1.0.12 is a thin shim that supports:
-
nself --version,nself --help -
nself init,nself build(generates compose; does not start it) -
nself plugin list,install,remove(registry + license operations) - All commands that don't shell out to
mkcert,dnsmasq,pfctl,iptables,osascript, orlaunchctl
It is intended for CI smoke tests, plugin-author tooling, and users who already have a remote Linux nself stack and only need the CLI client. For local-dev, WSL2 is required.
- windows-wsl2 — full user-facing install guide
- Installation — multi-platform install matrix
-
.github/wiki/operations/release-cascade.md— release workflow including Windows artifact publishing -
cli/.github/workflows/windows-smoke.yml— manual CI smoke
ɳSelf CLI v1.0.9. MIT licensed. Docs CC BY 4.0.
GitHub · Issues · Discussions · nself.org · nself.org/docs
Getting Started
Commands
- Commands, Overview
- Lifecycle: cmd-init · cmd-build · cmd-start · cmd-stop · cmd-restart · cmd-dev
- Monitoring: cmd-status · cmd-logs · cmd-health · cmd-urls · cmd-doctor · cmd-monitor · cmd-alerts · cmd-sentry · cmd-watchdog
- Data: cmd-db · cmd-backup · cmd-dr · cmd-queue · cmd-webhooks
- Config: cmd-config · cmd-service · cmd-env · cmd-promote
- Networking: cmd-ssl · cmd-trust · cmd-dns-setup
- Security: cmd-access · cmd-security · cmd-secrets
- Tenancy: cmd-tenant · cmd-billing
- Plugins: cmd-plugin · cmd-license · cmd-dogfood (extracted, CLI-R11) · cmd-k8s (extracted, CLI-R11) · cmd-encryption (extracted, CLI-R11) · cmd-waf (extracted, CLI-R11) · cmd-federation (extracted, CLI-R11) · cmd-mail (extracted, CLI-R11) · cmd-dlq (extracted, CLI-R11)
- AI: cmd-ai · cmd-claw · cmd-model
- Templates: cmd-template
- Utilities: cmd-exec · cmd-clean · cmd-reset · cmd-update · cmd-upgrade · cmd-version · cmd-admin · cmd-migrate · cmd-migrate-firebase · cmd-migrate-supabase · cmd-completion
Features
- Features, Overview
- Feature-Auth
- Feature-Storage
- Feature-Search
- Feature-Functions
- Feature-Email
- Feature-Monitoring
- Feature-Plugins
- Feature-nClaw, AI Assistant
- Feature-nChat, Messaging
- Feature-nTV, Media Player
- Feature-nFamily, Family Social
- Feature-nCloud, Managed Hosting
- Feature-Memory-Rooms, Knowledge Organization
- Feature-Agent-Dashboard, Agent Metrics
- Feature-Image-Generation, AI Image Generation
Configuration
- Configuration, Overview
- Config-Env-Vars
- Config-Postgres
- Config-Hasura
- Config-Auth
- Config-Nginx
- Config-Optional-Services
- Config-Custom-Services
- Config-System
Plugins (87 + 10 monitoring)
Free (25)
- plugin-backup
- plugin-content-acquisition
- plugin-content-progress
- plugin-cron
- plugin-donorbox
- plugin-feature-flags
- plugin-github
- plugin-github-runner
- plugin-invitations
- plugin-jobs
- plugin-link-preview
- plugin-mdns
- plugin-mlflow
- plugin-monitoring
- plugin-notifications
- plugin-notify
- plugin-paypal
- plugin-search
- plugin-shopify
- plugin-stripe
- plugin-subtitle-manager
- plugin-tokens
- plugin-torrent-manager
- plugin-vpn
- plugin-webhooks
Pro (62)
- plugin-access-controls
- plugin-activity-feed
- plugin-admin-api
- plugin-nself-ai-gateway
- plugin-nself-ai-mcp
- plugin-nself-ai-mcp
- plugin-analytics
- plugin-auth
- plugin-backup-pro
- plugin-bots
- plugin-browser
- plugin-calendar
- plugin-cdn
- plugin-chat
- plugin-claw
- plugin-claw-budget
- plugin-claw-news
- plugin-claw-web
- plugin-cloudflare
- plugin-cms
- plugin-compliance
- plugin-cron-pro
- plugin-ddns
- plugin-devices
- plugin-documents
- plugin-donorbox-pro
- plugin-entitlements
- plugin-epg
- plugin-file-processing
- plugin-game-metadata
- plugin-geocoding
- plugin-geolocation
- plugin-google
- plugin-home
- plugin-idme
- plugin-knowledge-base
- plugin-linkedin
- plugin-livekit
- plugin-media-processing
- plugin-meetings
- plugin-moderation
- plugin-mux
- plugin-notify-pro
- plugin-object-storage
- plugin-observability
- plugin-paypal-pro
- plugin-photos
- plugin-podcast
- plugin-post
- plugin-realtime
- plugin-recording
- plugin-retro-gaming
- plugin-rom-discovery
- plugin-shopify-pro
- plugin-social
- plugin-sports
- plugin-stream-gateway
- plugin-streaming
- plugin-stripe-pro
- plugin-support
- plugin-tmdb
- plugin-voice
- plugin-web3
- plugin-workflows
Planned (26)
plugin-auditplugin-blogplugin-checkoutplugin-commerceplugin-drmplugin-exportplugin-flowplugin-importplugin-ldapplugin-mailgunplugin-mediaplugin-oauth-providersplugin-pagesplugin-postmarkplugin-rate-limitplugin-reportsplugin-samlplugin-schedulerplugin-sendgridplugin-ssoplugin-subscriptionplugin-thumbplugin-transcoderplugin-twilioplugin-wafplugin-watermark
Guides
- Guide-Production-Deployment
- Guide-SSL-Setup
- Guide-Multi-Tenancy
- Guide-Security-Hardening
- Guide-Monitoring-Setup
- Guide-Backup-Restore
- Guide-Custom-Services
- Guide-Migration-from-v1
Architecture
Reference
- API-Reference
- error-codes, Error Codes
Licensing
Security
Brand
Operations
- operations/release-cascade, Release Cascade
- operations/self-healing, Self-Healing Schema
- operations/redis-tuning, Redis Pool Tuning
- operations/meilisearch-warmup, MeiliSearch Warm-Up
- operations/jwt-rotation, JWT Key Rotation
- operations/windows-wsl2-setup, Windows / WSL2 Setup
- operations/gemini-oauth-reauth, Gemini OAuth Reauth
Contributing
Admin
- USER-ACTION-QUEUE, Pending Admin Actions
All commands (52)
- A: cmd-access · cmd-account · cmd-admin
- B: cmd-backup · cmd-build · cmd-bundle
- C: cmd-ci · cmd-clean · cmd-completion · cmd-config
- D: cmd-db · cmd-deploy · cmd-dev · cmd-doctor
- E: cmd-env · cmd-exec
- F: cmd-functions
- G: cmd-generate
- H: cmd-health · cmd-help-topics
- I: cmd-init · cmd-install
- L: cmd-license · cmd-login · cmd-logout · cmd-logs
- M: cmd-man · cmd-mcp · cmd-migrate
- O: cmd-oauth · cmd-ops
- P: cmd-plugin · cmd-promote
- R: cmd-remove · cmd-reset · cmd-restart · cmd-runner
- S: cmd-secrets · cmd-security · cmd-self-heal · cmd-server · cmd-service · cmd-start · cmd-status · cmd-stop
- T: cmd-telemetry · cmd-template · cmd-trust
- U: cmd-update · cmd-urls
- V: cmd-verify-sbom · cmd-version