Optional services extend your ɳSelf deployment with additional capabilities. Enable only what you need to keep your stack lean and efficient.

Complete observability stack with metrics, logs, traces, and alerting. Note: This is a bundle of 10 optional services that can be enabled together.

• MailPit - Email testing for development
• SMTP - Production email sending

• MeiliSearch - Fast, typo-tolerant search
• Typesense - Lightning-fast search engine
• Sonic - Lightweight search backend

• MinIO - S3-compatible object storage
• nHost Storage - File management API

• Redis - In-memory data structure store
• KeyDB - Redis-compatible with better performance

• ɳAdmin - Web-based ɳSelf project management

• MLflow - ML experiment tracking
• Label Studio - Data labeling platform
• BentoML - ML model serving

# Typical development services
REDIS_ENABLED=true           # Caching and sessions
MAILPIT_ENABLED=true         # Email testing
MEILISEARCH_ENABLED=true     # Search
NSELF_ADMIN_ENABLED=true     # Admin dashboard

# Production essentials
REDIS_ENABLED=true           # Required for scaling
MINIO_ENABLED=true           # File storage
MONITORING_ENABLED=true      # Full monitoring bundle

# Everything enabled for testing
MONITORING_ENABLED=true      # All monitoring services
REDIS_ENABLED=true
MINIO_ENABLED=true
MLFLOW_ENABLED=true
MAILPIT_ENABLED=true
MEILISEARCH_ENABLED=true
NSELF_ADMIN_ENABLED=true

Purpose: In-memory caching and session storage

REDIS_ENABLED=true
REDIS_VERSION=7-alpine
REDIS_PORT=6379
REDIS_PASSWORD=your-redis-password

• Used by: Auth service, Custom services, BullMQ
• Memory: 256MB minimum
• Persistence: Optional (AOF/RDB)

Purpose: S3-compatible object storage

MINIO_ENABLED=true
MINIO_VERSION=latest
MINIO_PORT=9000
MINIO_ROOT_USER=minioadmin
MINIO_ROOT_PASSWORD=minioadmin
MINIO_DEFAULT_BUCKETS=uploads,public,private

• Web Console: https://storage-console.<domain>
• API: https://storage.<domain>
• Used for: File uploads, backups, ML artifacts

Purpose: Typo-tolerant instant search

MEILISEARCH_ENABLED=true
MEILISEARCH_VERSION=v1.5
MEILISEARCH_MASTER_KEY=your-master-key-32chars
MEILISEARCH_PORT=7700

• Dashboard: https://search.<domain>
• Features: Faceting, filtering, synonyms
• Index size: Unlimited documents

Purpose: Email testing and debugging

MAILPIT_ENABLED=true
MAILPIT_SMTP_PORT=1025
MAILPIT_UI_PORT=8025

• Web UI: https://mail.<domain>
• Catches all outgoing emails
• No emails leave your system

Purpose: ML experiment tracking and model registry

MLFLOW_ENABLED=true
MLFLOW_VERSION=2.9.2
MLFLOW_PORT=5005
MLFLOW_DB_NAME=mlflow
MLFLOW_ARTIFACTS_BUCKET=mlflow-artifacts

• UI: https://mlflow.<domain>
• Tracks: Parameters, metrics, artifacts
• Model registry included

Purpose: Comprehensive web-based management interface for your entire nself deployment

NSELF_ADMIN_ENABLED=true
NSELF_ADMIN_PORT=3021
NSELF_ADMIN_ROUTE=admin.${BASE_DOMAIN}

• URL: https://admin.<domain>
• Features: Service monitoring, configuration management, database admin, log viewing
• Real-time status updates via WebSocket
• → Full Documentation

graph LR
    Auth --> Redis[Redis - Sessions]
    Custom[Custom Services] --> Redis
    Custom --> MinIO[MinIO - Files]
    MLflow --> MinIO
    MLflow --> PostgreSQL
    BullMQ --> Redis
    Monitoring[Monitoring] --> All[All Services]

✅ Yes if:

• Using Auth with sessions
• Need caching
• Using BullMQ for jobs
• Scaling horizontally

❌ No if:

• Single instance deployment
• JWT-only authentication
• No background jobs

✅ Yes if:

• Handling file uploads
• Need S3-compatible storage
• Using MLflow
• Want backup storage

❌ No if:

• No file handling
• Using external S3
• Text-only application

✅ Yes if:

• Production deployment
• Need observability
• Want alerts
• Debugging issues

❌ No if:

• Local development only
• Resource constrained
• Using external monitoring

# Just Redis for sessions
REDIS_ENABLED=true
MAILPIT_ENABLED=true

# Most common services
REDIS_ENABLED=true
MINIO_ENABLED=true
MEILISEARCH_ENABLED=true
MONITORING_ENABLED=true

# Everything you might need
REDIS_ENABLED=true
MINIO_ENABLED=true
MEILISEARCH_ENABLED=true
MONITORING_ENABLED=true
MLFLOW_ENABLED=true
NSELF_ADMIN_ENABLED=true

• Services Overview
• Required Services
• Custom Services
• Monitoring Bundle