nessi
d694c8b8e3
Add .env.example with configuration for database, Redis, security, SMTP, workers, and plugins. Add .gitignore for Python, Node.js, Next.js, Docker volumes, and IDE files. Add MIT License. Update README.md with feature overview, quick start guide, architecture description, plugin system documentation, security details, backup/restore instructions, and developer setup. Add Alembic configuration files and placeholder directories for API, web, worker, and plugin components
NexaDash Deployment Guide
Quick Start with Docker Compose
- Copy the example environment:
cp .env.example .env
-
Edit
.envand set strong passwords and secrets. -
Start the stack:
docker compose up -d
- Open
http://localhost:3000and complete the setup wizard.
Services
web— Next.js frontend (port 3000).api— FastAPI backend (port 8000).worker— Celery background worker.postgres— PostgreSQL database.redis— Redis for cache, jobs and sessions.
Reverse Proxy
Set NEXADASH_WEB_URL and NEXADASH_API_URL to your public URLs. Use a reverse proxy with HTTPS. The API expects the web origin in its CORS allowlist.
Healthchecks
- API:
GET /health - Web: built-in Docker healthcheck
Backup and Restore
Database Backup
docker compose exec postgres pg_dump -U nexadash nexadash > backup.sql
Restore
docker compose exec -T postgres psql -U nexadash nexadash < backup.sql
Volumes
Important Docker volumes:
postgres_data— database files.redis_data— Redis persistence.plugin_data— uploaded plugin files.
Updates
git pull
docker compose build
docker compose up -d
Run migrations after updates:
docker compose exec api alembic upgrade head
Development
See README.md for developer setup.