Repository navigation
Come Home
Bring a project from another platform onto nSelf, or take it back out. Every path is one
command under nself db import <source> or nself db export. Start a fresh nSelf
project first (nself init, then nself start) and import into it.
An import reads the source, builds a portable bundle in a private stage, loads the
bundle into your fresh project, then verifies the result. The verify report compares
row counts, content hashes, auth users, objects, Hasura tracking, permissions and
relationships against the source. A pass means zero mismatches. Any mismatch (E523)
or a check that could not run (E522) leaves the import incomplete; the report at
.nself/import/<run-id>/report.json lists each one. Run the command with --plan
first to check the source and target without writing anything.
Each guide below ends with the failure and reset path for that source.
| Source | Guide | Command | Passwords | Fixture |
|---|---|---|---|---|
| PostgreSQL | Come-Home-Postgres | nself db import postgres --from-env SRC_URL |
No platform users. App tables only. When the source holds hasura-auth auth.users, the plan notes it looks like nhost; use the nhost command then |
test/fixtures/import/postgres |
| nhost | Come-Home-nhost | nself db import nhost --db-url-env SRC_URL --hasura-url <url> --admin-secret-env SRC_ADMIN_SECRET |
Preserved (bcrypt). A hash in another format is listed for reset | test/fixtures/import/nhost |
| Hasura Cloud | Come-Home-Hasura-Cloud | nself db import hasura-cloud --db-url-env SRC_URL --hasura-url <url> --admin-secret-env SRC_ADMIN_SECRET |
Not applicable (no platform auth). Users tables are ordinary tables | test/fixtures/import/hasura-cloud |
| Supabase | Come-Home-Supabase | nself db import supabase --db-url-env SUPA_DB --project-ref <ref> --service-key-env SUPA_KEY |
Preserved (bcrypt encrypted_password). A non-bcrypt hash is listed for reset |
test/fixtures/import/supabase |
| Firebase | Come-Home-Firebase | nself db import firebase --project <id> --credentials-file <key.json> --auth-export <users.json> |
Reset required. Firebase hashes (modified scrypt) cannot be verified, so users arrive without a password | test/fixtures/import/firebase |
| Appwrite | Come-Home-Appwrite | nself db import appwrite --endpoint <url> --project <id> --api-key-env APPWRITE_KEY |
bcrypt preserved. Argon2, scrypt and every other hash need a reset | test/fixtures/import/appwrite |
| nSelf (leave and return) | Leaving-nSelf |
nself db export --out <dir>, then nself db import nself <dir>
|
Preserved (bcrypt hashes travel in the bundle) | the round-trip script scripts/e2e/export-round-trip.sh
|
Run each with --plan first. The guides give the full flags and the failure path.
scripts/docs/check-guide-commands.sh checks that every command below is exercised by a
test or drill leg.
nself db import postgres --from-env SRC_URL --plan
nself db import nhost --db-url-env SRC_URL --hasura-url <url> --admin-secret-env SRC_ADMIN_SECRET --plan
nself db import hasura-cloud --db-url-env SRC_URL --hasura-url <url> --admin-secret-env SRC_ADMIN_SECRET --plan
nself db import supabase --db-url-env SUPA_DB --project-ref <ref> --service-key-env SUPA_KEY --plan
nself db import firebase --project <id> --credentials-file <key.json> --auth-export <users.json> --plan
nself db import appwrite --endpoint <url> --project <id> --api-key-env APPWRITE_KEY --plan
nself db export --out <dir>
nself db import nself <dir> --planLeaving-nSelf covers the export and the restore into plain PostgreSQL.
To load the same bundle into a fresh nSelf project, run nself db import nself <dir>.
It checks the whole bundle first and ends with the same verify report. In v1.4 mode the
command is nself migrate nself <dir>.
Where the table says reset, the report lists every affected user in
users.reset_required with the user id and email. The count is never silent. Send those
users through the hasura-auth password reset at /user/password/reset.
The importer drill reruns every source and the export round trip against pinned local fixtures each night. The drill evidence, not this page, is the record of what currently passes.
-
cmd-migrate: the older
nself migrate <source>spelling. - Compat-V15: v1.4 and v1.5 command behaviour.
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-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
- Shared-Proxy
- Config-Optional-Services
- Config-Custom-Services
- Config-System
Plugins (87 + 10 monitoring)
- Plugin-Overview
- Plugin-Catalog
- Plugin-Install
- Plugin-Licensing
- Plugin-Architecture
- Plugin-Dev-Guide
- Plugin-Migrations-Contract
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-analytics
- plugin-auth
- 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-ddns
- plugin-devices
- plugin-documents
- plugin-entitlements
- 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-object-storage
- plugin-observability
- plugin-photos
- plugin-podcast
- plugin-post
- plugin-realtime
- plugin-retro-gaming
- plugin-rom-discovery
- plugin-social
- plugin-sports
- 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
- Architecture
- Architecture-Guardrails
- Service-Graph
- Compose-Generation
- Nginx-Generation
- Plugin-Architecture
Reference
Machine interface
-
JSON-Output,
--jsonenvelope -
Command-Registry,
nself help --json - Exit-Codes
- error-codes, Error Codes
-
Compat-V15,
NSELF_V15gate
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 (21)
- A: cmd-add · cmd-admin
- B: cmd-backup · cmd-build
- C: cmd-clean · cmd-config
- D: cmd-db · cmd-deploy · cmd-doctor
- E: cmd-exec
- I: cmd-init
- L: cmd-license · cmd-logs
- M: cmd-mcp
- R: cmd-remove · cmd-reset · cmd-restart
- S: cmd-start · cmd-status · cmd-stop
- U: cmd-update