Home / Documentation / Configuration

Configuration Guide

Customize Qulaxy to match your environment and requirements

🔧 Environment Variables

Configure Qulaxy using these environment variables:

Database Configuration

Variable Description Default
DB_HOST PostgreSQL database host localhost
DB_PORT Database port 5432
DB_DATABASE Database name qulaxy
DB_USERNAME Database username admin
DB_PASSWORD Database password Required

Application Settings

Variable Description Default
BACKEND_PORT Backend API HTTP port 3000
FRONTEND_PORT Frontend web HTTP port 8080
VITE_API_BASE_URL Public URL for the backend API /api/v1 on the current host
JWT_SECRET Secret key for JWT tokens Auto-generated
AGENT_SECRET Shared secret used by Qulaxy agents Required
SESSION_TIMEOUT Session timeout in minutes 60

Email Configuration

Variable Description Default
SMTP_HOST SMTP server host localhost
SMTP_PORT SMTP server port 587
SMTP_USER SMTP username Optional
SMTP_PASSWORD SMTP password Optional
EMAIL_FROM Sender email address noreply@qulaxy.com

Redis Configuration (Optional)

Variable Description Default
REDIS_HOST Redis server host localhost
REDIS_PORT Redis server port 6379
REDIS_PASSWORD Redis password Optional
⚠️ Security Warning: Never commit .env files with real credentials to version control. Use environment-specific configurations and secret management.

📝 Example Configuration

Using .env File

Create a .env file in your deployment directory:

# Database
DB_HOST=postgres.example.com
DB_PORT=5432
DB_DATABASE=qulaxy_production
DB_USERNAME=qulaxy_user
DB_PASSWORD=your_secure_password

# Application
BACKEND_PORT=3000
FRONTEND_PORT=8080
VITE_API_BASE_URL=https://qulaxy.yourcompany.com/api/v1
JWT_SECRET=your_jwt_secret_key_here
AGENT_SECRET=your_agent_secret_here

# Email
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_USER=notifications@yourcompany.com
SMTP_PASSWORD=your_email_password
EMAIL_FROM=qulaxy@yourcompany.com

# Redis (Caching)
REDIS_HOST=redis
REDIS_PORT=6379

Docker Compose Configuration

Load environment variables in your docker-compose.yml:

version: '3.8'

services:
  backend:
    image: ghcr.io/qulaxyqa/qulaxy-backend:latest
    env_file:
      - .env
    ports:
      - "${BACKEND_PORT}:3000"
    depends_on:
      - postgres
      - redis

  frontend:
    image: ghcr.io/qulaxyqa/qulaxy-frontend:latest
    ports:
      - "${FRONTEND_PORT}:80"
    depends_on:
      - backend
Runtime default: The frontend image now uses the browser's current host and calls /api/v1 by default, so the same image works on localhost, a server IP, or a production domain when Nginx proxies API traffic to the backend.

🎨 Application Settings

Admin Panel Configuration

Access the admin panel at /admin to configure:

🔗 Next Steps