Add project scaffolding and documentation

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
This commit is contained in:
2026-06-21 09:31:47 +02:00
parent cfeeccbf53
commit d694c8b8e3
197 changed files with 8583 additions and 56 deletions
+78
View File
@@ -0,0 +1,78 @@
# ============================================================
# NexaDash Environment Configuration
# ============================================================
# -----------------------------------------------------------
# General
# -----------------------------------------------------------
NODE_ENV=production
NEXADASH_API_URL=http://localhost:8000
NEXADASH_WEB_URL=http://localhost:3000
NEXADASH_SECRET_KEY=change-this-to-a-random-32-byte-secret-key!!!!
NEXADASH_ENCRYPTION_KEY=change-this-to-a-random-32-byte-fernet-key!!
# -----------------------------------------------------------
# Database
# -----------------------------------------------------------
POSTGRES_HOST=postgres
POSTGRES_PORT=5432
POSTGRES_USER=nexadash
POSTGRES_PASSWORD=change-this-strong-password
POSTGRES_DB=nexadash
DATABASE_URL=postgresql+asyncpg://nexadash:change-this-strong-password@postgres:5432/nexadash
# -----------------------------------------------------------
# Redis
# -----------------------------------------------------------
REDIS_HOST=redis
REDIS_PORT=6379
REDIS_PASSWORD=change-this-redis-password
REDIS_URL=redis://:change-this-redis-password@redis:6379/0
CELERY_BROKER_URL=redis://:change-this-redis-password@redis:6379/1
CELERY_RESULT_BACKEND=redis://:change-this-redis-password@redis:6379/2
# -----------------------------------------------------------
# Security
# -----------------------------------------------------------
ACCESS_TOKEN_EXPIRE_MINUTES=15
REFRESH_TOKEN_EXPIRE_DAYS=7
ARGON2_TIME_COST=2
ARGON2_MEMORY_COST=65536
ARGON2_PARALLELISM=1
MAX_LOGIN_ATTEMPTS=5
LOGIN_LOCKOUT_MINUTES=15
RATE_LIMIT_DEFAULT=100
RATE_LIMIT_LOGIN=10
# -----------------------------------------------------------
# Mail (SMTP)
# -----------------------------------------------------------
SMTP_HOST=
SMTP_PORT=587
SMTP_TLS=true
SMTP_STARTTLS=true
SMTP_USER=
SMTP_PASSWORD=
SMTP_FROM=nexadash@localhost
# -----------------------------------------------------------
# Worker
# -----------------------------------------------------------
WORKER_CONCURRENCY=4
# -----------------------------------------------------------
# Plugins / Sandboxing
# -----------------------------------------------------------
PLUGIN_DIR=/app/plugins
PLUGIN_SANDBOX_ENABLED=true
# -----------------------------------------------------------
# Optional: Sentry / Monitoring
# -----------------------------------------------------------
SENTRY_DSN=
# -----------------------------------------------------------
# Ports used by docker-compose
# -----------------------------------------------------------
API_PORT=8000
WEB_PORT=3000