-
-
Notifications
You must be signed in to change notification settings - Fork 2
raspberry pi
Install the ɳSelf CLI on Raspberry Pi. Tested on Raspberry Pi 4B and Pi 5 running Raspberry Pi OS 64-bit (Debian Bookworm).
| Requirement | Minimum | Notes |
|---|---|---|
| Raspberry Pi | Pi 4B or Pi 5 | Pi 3B+ is too slow for the full stack |
| OS | Raspberry Pi OS 64-bit | 32-bit OS is NOT recommended (limited RAM + architecture) |
| Docker Engine | 24.0+ | See install steps below |
| Docker Compose | v2.20+ | Bundled with Docker Engine v24+ |
| RAM | 2 GB minimum | 4 GB recommended; 8 GB for full stack with monitoring |
| Storage | 8 GB+ free | SSD strongly recommended over SD card for database I/O |
Full ɳSelf stack at idle:
| Service set | RAM usage |
|---|---|
| Minimal (Postgres + Hasura + Nginx) | ~350–500 MB |
| Standard (+ Auth + Redis) | ~550–750 MB |
| Full (+ Mail + Search + MinIO) | ~900 MB–1.2 GB |
| Full + Monitoring bundle (10 services) | ~1.8–2.5 GB |
Use the minimal services preset on Pi 4B 2GB or 4GB:
nself init --preset minimalDo not install the monitoring bundle on Pi, it adds 10 services and exceeds the 2 GB model's capacity.
curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER
newgrp dockerVerify:
docker --version # 24+
docker compose version # v2+curl -sSL https://install.nself.org | bashThe installer detects aarch64 automatically and downloads nself-linux-arm64.tar.gz.
Manual download (64-bit):
VERSION=$(curl -s https://api.github.com/repos/nself-org/cli/releases/latest | grep '"tag_name"' | cut -d'"' -f4)
curl -L "https://github.com/nself-org/cli/releases/download/${VERSION}/nself-linux-arm64.tar.gz" -o nself.tar.gz
tar -xzf nself.tar.gz
sudo mv nself /usr/local/bin/nself
chmod +x /usr/local/bin/nselfnself version
# nself v1.0.9 (linux/arm64)
nself doctorExpected (all green):
✓ Docker: running (v24.x.x)
✓ Docker Compose: v2.x.x
✓ curl: available
✓ bash: available
✓ Architecture: arm64
mkdir my-project && cd my-project
nself init --preset minimal # minimal preset for Pi
nself build
nself startPostgres writes are I/O intensive. SD cards degrade quickly under database write load and are 3–10x slower than SATA SSD. Boot from USB SSD for any persistent project.
# Check storage type
lsblk -d -o NAME,ROTA # ROTA=1 = rotational/slow; ROTA=0 = SSDIf you must use an SD card, minimize swap writes:
echo 'vm.swappiness=10' | sudo tee -a /etc/sysctl.conf
sudo sysctl -pUnder sustained Docker load, Pi can thermal-throttle. Use a heatsink + fan for server deployments. Check throttling:
vcgencmd get_throttled
# 0x0 = no throttling; non-zero = thermal or voltage issueAll ɳSelf plugin images ship with linux/arm64 manifests. Docker pulls the arm64
variant automatically, no flags needed.
- Monitoring bundle (10 extra services), exceeds 2 GB and 4 GB models' comfortable RAM
- armv7 (32-bit) OS, use Raspberry Pi OS 64-bit (Pi 4/5 only)
| Problem | Fix |
|---|---|
exec format error |
Downloaded the amd64 binary , re-download nself-linux-arm64.tar.gz
|
| Stack OOM | Use nself init --preset minimal; skip monitoring bundle |
Slow first nself start
|
Normal , first pull caches images. Subsequent starts: 10–30 seconds |
| SD card I/O slow | Move the project and Docker data root to an SSD |
| Docker pull fails | Ensure Pi is connected to internet; try docker pull hello-world as a test |
ɳ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-sentry · 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
- nself-ai-gateway
- nself-ai-cc
- 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
- 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