-
-
Notifications
You must be signed in to change notification settings - Fork 2
Embedded Postgres
Run the full ɳSelf stack without a Docker postgres container — PostgreSQL executes inside a WebAssembly runtime on the same host process.
nself start --embedded-pg replaces the Docker postgres container with a pglite WebAssembly module executing inside wasmtime (via wasmtime-go). A Unix-domain socket bridge proxies the Postgres wire protocol between Hasura, Auth, and the WASM runtime. From the perspective of any service that talks to postgres, the connection is identical to a standard socket connection.
Hasura / Auth
│
│ Postgres wire protocol (Unix socket)
▼
PGSocketBridge ─── intercepts unsupported commands (COPY, LISTEN, NOTIFY)
│
│ Postgres wire protocol (internal socket)
▼
EmbeddedPGRuntime (wasmtime + pglite WASM)
│
│ WASI filesystem preopen
▼
$NSELF_RUNTIME_DIR/pgdata/ ← durable Postgres data directory
pglite v0.2.17 ships with pgvector support included. No separate extension install is needed.
- macOS (darwin/amd64 or darwin/arm64) or Linux (amd64 or arm64)
- Internet access on first run to download the pglite WASM binary (cached at
~/.nself/cache/pglite/) -
CGO_ENABLED=1build (the CLI binary from Homebrew satisfies this automatically)
The Docker postgres image is NOT required. Docker is still needed for Hasura, Auth, and Nginx.
On the first nself start --embedded-pg, the CLI:
- Downloads
pglite.wasmfromping.nself.org/assets/pglite/0.2.17/pglite.wasm(verifies sha256) - Compiles the WASM module to native machine code via wasmtime (takes 5-15 seconds on cold start)
- Caches the compiled module at
~/.nself/cache/pglite/0.2.17/pglite.wasm.compiled - Starts the pglite runtime with data at
.nself/embedded-pg/pgdata/ - Starts the socket bridge at
.nself/embedded-pg/pglite.sock.bridge - Proceeds with the normal stack startup (Hasura, Auth, Nginx)
Subsequent starts reuse the compiled module cache. Warm start time is typically under 5 seconds.
| Variable | Default | Purpose |
|---|---|---|
NSELF_EMBEDDED_PG |
false |
Set to true to enable embedded PG without passing --embedded-pg every run |
NSELF_RUNTIME_DIR |
.nself/embedded-pg (project-relative) |
Override the runtime directory path |
Postgres data lives in $NSELF_RUNTIME_DIR/pgdata/ — by default .nself/embedded-pg/pgdata/ inside the project directory. This directory persists across restarts.
To start fresh, stop the stack and remove the pgdata/ directory:
nself stop
rm -rf .nself/embedded-pg/pgdata
nself start --embedded-pgnself backup works with embedded PG. When NSELF_EMBEDDED_PG=true, the backup command targets the Unix-domain socket instead of the Docker container. It attempts pg_dump --format=custom first (producing a file compatible with pg_restore), then falls back to a SQL plain-text dump if pg_dump is not on PATH.
Backup files are written to ~/.nself/backups/ by default.
- COPY TO / COPY FROM, LISTEN, and NOTIFY are not supported via the bridge. Any attempt returns
SQLSTATE 0A000(feature not supported). Standard INSERT/UPDATE/DELETE/SELECT work without restriction. - Windows is not supported. The prebuilt libwasmtime static library is available for macOS and Linux only.
- The embedded runtime uses a single-process WASM instance. High-concurrency workloads may see higher latency than a native Postgres process.
"pglite WASM not found" — run nself start --embedded-pg with internet access to trigger the download. Or set PGLITE_WASM_PATH to an existing pglite.wasm file.
"Socket already in use" — a previous embedded PG instance did not shut down cleanly. Remove the socket file: rm -f .nself/embedded-pg/pglite.sock*
Slow warm start — delete the compiled module cache to force recompile: rm -f ~/.nself/cache/pglite/*/pglite.wasm.compiled
-
cmd-start —
nself startflag reference - Architecture — full ɳSelf stack architecture
- backup — backup and restore
← Architecture | Home →
ɳSelf CLI v1.0.9. MIT licensed. Docs CC BY 4.0.
GitHub · Issues · Discussions · nself.org · docs.nself.org
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-watchdog · cmd-dogfood
- 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-security · cmd-secrets · cmd-waf
- Tenancy: cmd-tenant · cmd-billing
- Plugins: cmd-plugin · cmd-license
- 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-ɳClaw, AI Assistant
- Feature-ɳChat, Messaging
- Feature-ɳTV, Media Player
- Feature-ɳFamily, Family Social
- Feature-ɳCloud, 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-ai
- 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
- 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