-
-
Notifications
You must be signed in to change notification settings - Fork 2
FAQ
- What is ɳSelf?
- Is ɳSelf free?
- What is the difference between free and Pro plugins?
- Can I run multiple ɳSelf projects on one server?
- How does ɳSelf compare to Supabase or Nhost?
- Does ɳSelf require Docker?
- What ports does ɳSelf use?
- How do I update ɳSelf?
- How do I back up my data?
- Where are config files stored?
- How do I add a custom service?
- Does ɳSelf support ARM / Apple Silicon?
- How do I reset the Hasura admin password?
- Can I use ɳSelf in CI/CD?
- How do I report a security issue?
- How do I contribute a plugin?
ɳSelf is an open-source CLI that spins up a complete self-hosted backend stack, PostgreSQL, Hasura GraphQL, Auth, and Nginx, in five minutes. You run it on your own server or local machine; there is no cloud dependency.
Yes. The core CLI and 25 free plugins are MIT licensed and free forever, including commercial use. Revenue comes from 62 paid Pro plugins starting at $9.99/year.
Free plugins (25) handle foundational use cases: monitoring, backup, cron, search, notifications, and more. Pro plugins (52) add advanced capabilities: AI, live video (LiveKit), commerce, CMS, SSO/SAML, media transcoding, DRM, WAF, and more. Pro plugins require a license key from nself.org.
Yes. Each project runs in its own Docker network and uses a different BASE_DOMAIN. Run nself init in separate directories, each with a unique PROJECT_NAME and BASE_DOMAIN, and start them independently.
ɳSelf gives you the same Postgres + Hasura + Auth stack as Supabase/Nhost, but self-hosted on your infrastructure with no vendor lock-in. You own your data, choose your server, and pay nothing per row or API call. The tradeoff is that you manage your own server.
Yes. Docker 24+ with Docker Compose v2 is required. ɳSelf generates and manages a docker-compose.yml for your stack.
Nginx binds to ports 80 and 443. All internal services bind to 127.0.0.1 only and are not directly exposed. Admin UI runs on localhost:3021.
nself updateThis checks for a newer CLI binary and a newer admin Docker image and installs them. Use nself update --check to check without installing.
nself db backupCreates a pg_dump file with a timestamped name. Store it off-server. Restore with nself db restore /path/to/backup.sql.
Project config lives in .env in your project directory. The CLI state and license key are stored in ~/.nself/. Generated files (docker-compose.yml, nginx configs, SSL certs) are created inside your project directory.
Define CS_1 through CS_10 in your .env. Choose from 40+ templates or bring your own Docker image.
CS_1=api:fastapi:3001Then run nself build && nself restart.
Yes. Binaries are published for linux/amd64, linux/arm64, darwin/amd64, and darwin/arm64. All base Docker images used by ɳSelf support ARM64.
The Hasura admin secret is stored as HASURA_GRAPHQL_ADMIN_SECRET in your .env. Change it there, then run nself build && nself restart. Hasura picks up the new value on restart.
Yes. Use --non-interactive and --quiet flags for CI:
nself init --non-interactive --name myapp
nself build -q
nself start --skip-health-checks --quickEmail security@nself.org or open a private advisory on GitHub. Do not file public issues for security vulnerabilities. See Security-Policy for full details.
Read Plugin-Dev-Guide for the plugin SDK and submission process. Free plugins are accepted via pull request to the nself-org/plugins repository. Pro plugins are reviewed privately.
ɳ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
- Utilities: cmd-exec · cmd-clean · cmd-reset · cmd-update · cmd-upgrade · cmd-version · cmd-admin · cmd-migrate · 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