MBPanel Documentation¶

Version: 1.0.0 | Last Updated: 2025-01-06 | Status: Stable

Overview¶

MBPanel is a multi-tenant WordPress hosting management platform built with modern cloud-native technologies. This documentation serves as the single source of truth for architecture, API reference, development guides, and operational procedures.

Quick Links¶

Architecture - System design, patterns, and decisions
API Reference - Complete REST API documentation with code examples
Development - Setup, testing, and contribution guidelines
Operations - Runbooks, monitoring, and error tracking
Implementation - Domain-specific implementation notes

Recent Activity¶

Latest changes from development branches:

Recent Merges¶

2025-12-18 16:54:59 UTC

Docs/observability: add make localdev helper + README guidance, align SigNoz telemetry (span.* fields + dashboard JSON) to resolve ambiguous httpMethod/httpRoute/responseStatusCode warnings....

2025-12-18 12:04:44 UTC

- Added the SigNoz/OTEL AI guide plus shared telemetry_span helper, then instrumented env provisioning, Virtuozzo service calls, and SSE broker paths so every error is traced/logged consistently for S...

2025-12-18 11:22:19 UTC

Implemented async env provisioning stack:\n- Added job log + environment tables/migration plus ORM models\n- Wired Celery worker, SSE publisher, and /api/v1/environments endpoints\n- Added worker smok...

2025-12-18 10:57:46 UTC

...

Virtuozzo endpoint centralization

...

View Full Changelog

Technology Stack¶

Backend¶

Framework: FastAPI (Python 3.12+)
Architecture: Hybrid Modular Domain-Driven Design (DDD)
Database: PostgreSQL with async SQLAlchemy
Caching: Redis
Messaging: RabbitMQ
Task Processing: Celery

Frontend¶

Framework: Next.js 16 with App Router
UI: React Server Components
State Management: TanStack Query + Zustand

Infrastructure¶

Containerization: Docker Compose
Observability: SigNoz (OpenTelemetry)
CI/CD: GitHub Actions

Getting Started¶

For Developers¶

Prerequisites
Docker and Docker Compose
Python 3.12+
Node.js 20+
Make

Setup

# Copy environment files
cp env/local-dev.example .env.local
cp env/backend-local.example backend/.env.backend.local
cp env/frontend-local.example frontend/.env.frontend.local

# Start all services
make localdev

# Run migrations
make migrate

# Seed development data
make seed

Access Services
Backend API: http://localhost:8000
API Docs: http://localhost:8000/docs
Frontend: http://localhost:3000
SigNoz: http://localhost:3301

For Operations¶

See the Operations section for deployment, monitoring, and troubleshooting guides.

Documentation Structure¶

Architecture¶

Contains high-level system design, architectural decision records (ADR), and architectural design documents (ADD).

API Reference¶

Auto-generated API documentation using mkdocstrings, covering all FastAPI endpoints organized by domain.

Development¶

Guides for local development, testing strategies, coding standards, and contribution workflows.

Operations¶

Production runbooks, deployment procedures, monitoring dashboards, test reports, and error tracking.

Implementation Notes¶

Detailed documentation of business logic implementation for each domain and module.

Support¶

Issues: GitHub Issues
Discussions: GitHub Discussions
Documentation: This Site