A production-grade, containerized local AI ecosystem for Linux.
Warning
Use at your own risk. This project allows AI models to read local files and browse the internet. Ensure you review all code and run in a safe environment.
Complete documentation available in the Nebulus Wiki
- Setup and Installation - Get started in minutes
- CLI Reference - Master the
nebuluscommand - Features - Explore all capabilities
- Architecture - Understand the system design
- Troubleshooting - Common issues and solutions
| Component | Technology | Purpose |
|---|---|---|
| Frontend | Open WebUI | Chat Interface & Model Management |
| Inference | TabbyAPI | ExLlamaV2 Local LLM Runtime |
| Vector DB | ChromaDB | Persistent embeddings storage |
| Tools | Custom MCP Server | Extended AI capabilities |
| Monitoring | Dozzle | Real-time log viewer |
| Automation | Ansible | Configuration Management |
| Infrastructure | Terraform | Cloud Provisioning (GCP/AWS/Azure) |
bartowski/Meta-Llama-3.1-8B-Instruct-exl2(General Chat - 8.0bpw)bartowski/Qwen2.5-Coder-14B-Instruct-exl2(Coding Agent - 4.25bpw)bartowski/Phi-3.5-mini-instruct-exl2(Lightweight)
- Docker & Docker Compose
- (Recommended) NVIDIA GPU with Container Toolkit
Please refer to the Setup and Installation Guide for complete installation instructions.
- Open WebUI: http://localhost:3000
- MCP Server: http://localhost:8002
- ChromaDB: http://localhost:8001
- TabbyAPI: http://localhost:5000/docs
- Dozzle (Logs): http://localhost:8888
First-time setup: The first account created becomes the admin.
Nebulus includes a unified command-line tool:
nebulus --helpCommon Commands:
nebulus up # Start all services
nebulus down # Stop all services
nebulus status # Service health dashboard
nebulus logs # Stream logs
nebulus model list # List downloaded models
nebulus model get # Download specific model
nebulus backup # Backup data volumes
nebulus restore # Restore from backupSee CLI Reference for complete documentation.
Nebulus supports multi-cloud deployment via Terraform. Scaffolding is provided for:
- GCP (Compute Engine)
- AWS (EC2)
- Azure (Virtual Models)
Usage:
- Navigate to
terraform/<provider>. - Copy
terraform.tfvars.exampletoterraform.tfvarsand edit. - Run
terraform init && terraform apply.
The custom MCP server provides AI agents with extended capabilities:
- Read, write, and edit files in the workspace
- List directories and search code
- DuckDuckGo web search
- URL scraping and content extraction
- Safe command execution (whitelisted commands only)
- Git operations, pytest, grep, find
- PDF text extraction
- DOCX document reading
- Image analysis with
llama3.2-vision
- Schedule recurring AI tasks with cron
- Email reports automatically
- Web dashboard for task management
See MCP Server for complete tool documentation.
Nebulus uses ChromaDB to provide persistent memory for the AI:
- Conversation Storage: Histories are indexed for semantic retrieval.
- User Preferences: Remembers user-specific settings across sessions.
- Contextual Recall: Automatically retrieves relevant past interactions.
- Ansible-driven setup - Reproducible infrastructure
- Scheduled tasks - Recurring AI workflows with email delivery
- Automated backups - Data persistence and recovery
- Health monitoring - Service status checks
- Fine-tuning pipeline - Export chat logs to ShareGPT format
- Unit tests - Comprehensive test coverage
- Code formatting - Black and Flake8 integration
- Pre-commit hooks - Automated quality checks
See Features for the complete feature catalog.
| Topic | Link |
|---|---|
| Getting Started | Setup and Installation |
| System Design | Architecture |
| CLI Tool | CLI Reference |
| All Features | Features |
| Docker Config | Docker Services |
| Tool Server | MCP Server |
| Contributing | Development Guide |
| Model Management | Models |
| Infrastructure | Ansible Automation |
| API Docs | API Reference |
| Support | Troubleshooting |
Contributions are welcome! Please see the Development Guide for:
- Coding standards (unit tests, type hints, documentation)
- Git workflow (Git Flow)
- Adding new MCP tools
- Testing practices
This project is licensed under the MIT License - see the LICENSE file for details.
- Documentation: Nebulus Wiki
- Issues: GitHub Issues
- Troubleshooting: Common Issues