|
| 1 | +# Deployment Guide |
| 2 | + |
| 3 | +This guide covers how to deploy Constellation Hub to production environments. |
| 4 | + |
| 5 | +## Docker Compose Deployment |
| 6 | + |
| 7 | +The root `docker-compose.yml` is production-ready and can be used with Docker Swarm, Coolify, or Portainer. |
| 8 | + |
| 9 | +### Environment Variables |
| 10 | + |
| 11 | +Configure these variables in your deployment environment (e.g., `.env` file or CI/CD secrets). |
| 12 | + |
| 13 | +#### Database Configuration |
| 14 | + |
| 15 | +| Variable | Default | Description | |
| 16 | +| ------------------- | ------------------- | ----------------- | |
| 17 | +| `POSTGRES_USER` | `constellation` | Database username | |
| 18 | +| `POSTGRES_PASSWORD` | `constellation` | Database password | |
| 19 | +| `POSTGRES_DB` | `constellation_hub` | Database name | |
| 20 | + |
| 21 | +#### Security & App Settings |
| 22 | + |
| 23 | +| Variable | Default | Description | |
| 24 | +| ---------------- | ------------------------- | ------------------------------------------------------------------ | |
| 25 | +| `JWT_SECRET_KEY` | `change-me-in-production` | **Required.** Secret for signing auth tokens. | |
| 26 | +| `DEMO_MODE` | `true` | Set to `false` to disable the `/demo/seed` endpoint in production. | |
| 27 | +| `DEBUG` | `false` | Set to `true` for verbose logging. | |
| 28 | + |
| 29 | +#### Frontend Configuration (Build Time) |
| 30 | + |
| 31 | +These variables must be set when building the frontend container or passed to the runtime if using the provided Docker image which handles env injection. |
| 32 | + |
| 33 | +| Variable | Default | Description | |
| 34 | +| --------------------------- | ----------------------- | ----------------------------- | |
| 35 | +| `VITE_CORE_ORBITS_URL` | `http://localhost:8001` | Public URL of Core Orbits API | |
| 36 | +| `VITE_ROUTING_URL` | `http://localhost:8002` | Public URL of Routing API | |
| 37 | +| `VITE_GROUND_SCHEDULER_URL` | `http://localhost:8003` | Public URL of Scheduler API | |
| 38 | +| `VITE_AI_AGENTS_URL` | `http://localhost:8004` | Public URL of AI Agents API | |
| 39 | + |
| 40 | +### Coolify Deployment |
| 41 | + |
| 42 | +1. **Source**: Connect your GitHub repository. |
| 43 | +2. **Configuration**: |
| 44 | + - **Base Directory**: `/` |
| 45 | + - **Docker Compose Location**: `/docker-compose.yml` |
| 46 | +3. **Environment Variables**: |
| 47 | + Add the variables listed above. Ensure `VITE_*_URL` point to the actual domains (e.g., `https://api.yourdomain.com`). |
| 48 | + |
| 49 | +## Kubernetes Deployment |
| 50 | + |
| 51 | +_(Coming soon. See `infra/helm` for experimental charts.)_ |
0 commit comments