-
-
Notifications
You must be signed in to change notification settings - Fork 2
FEATURES OVERVIEW
Quick reference guide for the three major features introduced in v0.9.0.
Command Structure Note: v0.9.6+ uses consolidated v1.0 commands. Examples below use the new command structure.
Purpose: Monetize your application with subscriptions, usage-based pricing, and payment processing.
- ✅ Stripe integration (test and production)
- ✅ Subscription management (monthly, annual, trials)
- ✅ Usage tracking and metering
- ✅ Quota enforcement (soft and hard limits)
- ✅ Invoice generation (PDF, automatic emails)
- ✅ Tax handling (Stripe Tax, manual rates)
- ✅ Payment recovery (dunning, retry logic)
- ✅ Customer portal (self-service)
- ✅ Webhooks (event notifications)
- ✅ Analytics (MRR, churn, LTV)
billing-config-example.env (640 lines, comprehensive)
BILLING_ENABLED=true
BILLING_STRIPE_ENABLED=true
STRIPE_PUBLISHABLE_KEY=pk_test_...
STRIPE_SECRET_KEY=sk_test_PLACEHOLDER...
BILLING_DEFAULT_PLAN=free
BILLING_TRIAL_PERIOD_DAYS=14- Freemium SaaS with paid tiers
- Usage-based pricing (API calls, storage, etc.)
- Subscription box services
- Metered billing platforms
- Enterprise seat-based pricing
Purpose: Rebrand the entire platform with your company identity or enable multi-brand deployments.
- ✅ Brand identity (name, logo, colors, fonts)
- ✅ Custom domains (per service)
- ✅ Email template customization
- ✅ Custom themes and CSS
- ✅ SEO and meta tags
- ✅ Documentation rebranding
- ✅ Multi-brand mode (resellers)
- ✅ Source code rebranding (enterprise)
- ✅ Custom CLI name (enterprise)
- ✅ Remove nself branding
whitelabel-config-example.env (700 lines, comprehensive)
| Tier | Features | Best For |
|---|---|---|
| Basic | Logo, colors | Simple branding |
| Professional | + Custom domains, email templates | Agencies, white-label |
| Enterprise | + Full rebrand, source code access | Resellers, private label |
WHITELABEL_ENABLED=true
WHITELABEL_TIER=professional
WHITELABEL_BRAND_NAME=Acme Platform
WHITELABEL_LOGO_URL=https://cdn.acme.com/logo.svg
WHITELABEL_PRIMARY_COLOR=#007bff
WHITELABEL_DOMAIN=app.acme.com
WHITELABEL_SHOW_NSELF_BRANDING=false- Agency white-label products
- Partner/reseller programs
- Enterprise private deployments
- Multi-brand platforms
- Custom OEM solutions
Purpose: Serve multiple organizations/customers from a single deployment with data isolation.
- ✅ Tenant isolation (schema, database, or row-level)
- ✅ Organization management
- ✅ Team collaboration (roles, permissions)
- ✅ Resource quotas per tenant
- ✅ Custom domains per tenant
- ✅ Tenant-specific branding
- ✅ Hierarchical tenancy (sub-orgs)
- ✅ Usage tracking per tenant
- ✅ Billing per tenant
- ✅ Data export and portability
multi-tenant-example.env (717 lines, comprehensive)
| Architecture | Isolation | Scalability | Complexity | Best For |
|---|---|---|---|---|
| Schema | Good | High | Medium | Most SaaS (10-10k tenants) |
| Database | Maximum | Medium | High | Enterprise, compliance (10-1k tenants) |
| Row-level | Moderate | Unlimited | Low | Simple apps, many tenants |
| Hybrid | Flexible | High | High | Complex hierarchies |
MULTI_TENANT_ENABLED=true
MULTI_TENANT_ARCHITECTURE=schema
MULTI_TENANT_IDENTIFIER_SOURCE=subdomain
MULTI_TENANT_ORGANIZATIONS_ENABLED=true
MULTI_TENANT_TEAMS_ENABLED=true
MULTI_TENANT_QUOTAS_ENABLED=true
MULTI_TENANT_DEFAULT_STORAGE_QUOTA=1073741824 # 1GB- B2B SaaS platforms
- Enterprise team collaboration tools
- Multi-organization project management
- Agency client management
- Marketplace platforms
# Multi-tenant + Billing
MULTI_TENANT_ENABLED=true
BILLING_ENABLED=true
BILLING_BILLING_ENTITY=organization
MULTI_TENANT_BILLING_ENABLED=trueResult: Each organization has its own subscription and quotas.
# Multi-tenant + White-label
MULTI_TENANT_ENABLED=true
WHITELABEL_ENABLED=true
WHITELABEL_TIER=enterprise
WHITELABEL_MULTI_BRAND_MODE=true
MULTI_TENANT_BRANDING_ENABLED=trueResult: Each tenant can have their own branding and custom domain.
# All three features
MULTI_TENANT_ENABLED=true
BILLING_ENABLED=true
WHITELABEL_ENABLED=true
MULTI_TENANT_CUSTOM_DOMAINS_ENABLED=true
BILLING_BILLING_ENTITY=organization
WHITELABEL_TIER=professionalResult: Full-featured enterprise platform with billing, branding, and multi-tenancy.
| Feature | Billing | White-Label | Multi-Tenant |
|---|---|---|---|
| Purpose | Monetization | Branding | Data Isolation |
| Primary Users | All SaaS | Agencies, Resellers | B2B SaaS |
| Complexity | Medium | Low-Medium | High |
| Setup Time | ~30 min | ~15 min | ~1 hour |
| External Deps | Stripe | CDN (optional) | None |
| Production Ready | ✅ Yes | ✅ Yes | ✅ Yes |
File: quick-start-saas.env (397 lines)
- Multi-tenant: Basic
- Billing: Test mode
- White-label: Basic branding
- Time to launch: ~5 minutes
File: enterprise-example.env (676 lines)
- Multi-tenant: Full features
- Billing: Production Stripe
- White-label: Professional
- Monitoring: Full stack
- Security: Hardened
- Time to launch: ~2 hours (including setup)
Path A: Learning / MVP
→ Start with quick-start-saas.env
Path B: Production SaaS
→ Start with enterprise-example.env
Path C: Specific Feature → Reference individual feature files:
billing-config-example.envwhitelabel-config-example.envmulti-tenant-example.env
# Copy example to .env
cp src/examples/quick-start-saas.env .env
# Edit configuration
nano .env
# Replace placeholders:
# - Stripe API keys
# - Database passwords
# - Brand name and colors# Generate configuration
nself build
# Start services
nself start
# Check status
nself status
# View URLs
nself urls# Access your application
open http://app.local.nself.org
# Create first user (becomes admin)
# Create first organization (becomes first tenant)
# Test billing (test mode)- Documentation: https://docs.nself.org
-
Examples Directory:
/src/examples/ -
Configuration Reference:
src/examples/README.md - Community: https://discord.gg/nself
- Support: support@nself.org
- nself Version: v0.9.0
- Release Date: February 2026 (planned)
- Status: In Development
- Documentation Updated: January 30, 2025
After getting familiar with these features:
- Customize your configuration based on your specific needs
- Test in development with test Stripe keys
- Deploy to staging for team testing
- Configure production with production Stripe keys
- Launch and iterate based on user feedback
Need help? Check src/examples/README.md for detailed guides and troubleshooting.
ɳ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