Oliver/forge
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Docs: Add Scalability and Queuing section to README

Browse source
This commit is contained in:
DJP 2025-12-10 21:28:39 -05:00
parent 5ee2082b88
commit 136f92f6f2
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -97,6 +97,18 @@ FORGE AI is built on a **Microservices Architecture** using **Docker Compose**.
---
## ⚡️ Scalability & Performance
FORGE AI is architected to handle high user concurrency (e.g., 200+ simultaneous users) without degrading API performance.
* **Asynchronous Job Queue**: All heavy compute tasks (Video Generation, Upscaling) are offloaded to **Celery** workers via **Redis**. The API responds immediately with a `Queued` status, ensuring the interface remains snappy.
* **Horizontal Scaling**:
* The `forge-worker` service can be scaled horizontally to process more jobs in parallel.
* Command: `docker-compose up -d --scale worker=3` (Starts 3 worker containers).
* **Fault Tolerance**: If a worker crashes or an API fails, the job status is tracked in Postgres, and broken jobs can be automatically retried or flagged.
---
## 💾 Database Schema Overview
| Table | Description | Key Fields |