From 9901c9cd9f60a07a34256639776d8311fbc06e4b Mon Sep 17 00:00:00 2001 From: Benedict Balogun <50557035+wolfyres@users.noreply.github.com> Date: Tue, 16 Jun 2026 10:41:36 +0100 Subject: [PATCH 1/2] Add production deployment guide for Quantara application This document outlines the standard operating procedure for deploying the Quantara application to a production environment, including prerequisites, environment setup, and deployment steps. --- docs/deployment.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/deployment.md diff --git a/docs/deployment.md b/docs/deployment.md new file mode 100644 index 000000000..45ccbc5f8 --- /dev/null +++ b/docs/deployment.md @@ -0,0 +1,30 @@ + +# Production Deployment Guide + +This document outlines the standard operating procedure for deploying the Quantara application to a production environment. All commands should be executed by an authorized DevOps engineer with production access. + +> **⚠️ Security Warning:** Never hardcode sensitive credentials (passwords, IP addresses, private keys) in this repository. Use a secure vault/secret manager to inject variables at runtime. + +## 1. Prerequisites & Environment Setup +Before initiating a deployment, ensure the target environment meets the following specifications: +* **Server Specs:** Minimum 4 vCPUs, 8GB RAM, and 50GB NVMe storage. +* **Dependencies:** Docker (v24+), Docker Compose (v2+), and Node.js (v18+). +* **Network Setup:** Configured domain name (e.g., `api.quantara.internal`) and provisioned SSL certificates. + +### 1.1 Environment Variables Checklist +The application relies on a strictly defined `.env.production` file. +Ensure your environment contains all required secrets. +*🔗 See [docs/environment_variables.md](./environment_variables.md) for the complete configuration reference.* + +--- + +## 2. Deployment Steps + +### Step 2.1: Pull and Build the Docker Images +Navigate to the application root on the production server and pull the latest changes, then build the images: +```bash +git checkout main +git pull origin main + +# Build the containers using the production overrides +docker compose -f docker-compose.yml -f docker-compose.prod.yml build From 910dc35564a9236bb8ffd5a80a0408e6909bc35c Mon Sep 17 00:00:00 2001 From: Benedict Balogun <50557035+wolfyres@users.noreply.github.com> Date: Tue, 16 Jun 2026 10:49:52 +0100 Subject: [PATCH 2/2] Update README with enhanced project details --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 56a0c196a..dcd6bed7f 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,9 @@ make dev make back ``` +```markdown +* 🚀 **[Production Deployment Guide](docs/deployment.md)** - Step-by-step instructions for deploying Quantara to production environments. + ### Services | Service | URL | Description |