feat: remap ports to 9000/9010, update documentation, and add Mermaid ERD
This commit is contained in:
1 parent
8ad35ed9d1
commit
cf4c3370e1
8 files changed
+457
-179
No files matched your search
@@ -101,13 +101,13 @@ docker compose up -d --build
|
||||
```
|
||||
|
||||
**Access Points**:
|
||||
- 🌐 **Web Studio UI**: [http://localhost:8080](http://localhost:8080)
|
||||
- 📑 **Interactive REST API Docs**: [http://localhost:8000/docs](http://localhost:8000/docs)
|
||||
- 🩺 **Health & GPU Telemetry Endpoint**: [http://localhost:8000/api/health](http://localhost:8000/api/health)
|
||||
- 🌐 **Web Studio UI**: [http://localhost:9000](http://localhost:9000)
|
||||
- 📑 **Interactive REST API Docs**: [http://localhost:9010/docs](http://localhost:9010/docs)
|
||||
- 🩺 **Health & GPU Telemetry Endpoint**: [http://localhost:9010/api/health](http://localhost:9010/api/health)
|
||||
|
||||
Verify system health and GPU VRAM availability:
|
||||
```bash
|
||||
curl http://localhost:8000/api/health
|
||||
curl http://localhost:9010/api/health
|
||||
```
|
||||
```json
|
||||
{
|
||||
@@ -528,8 +528,9 @@ All configuration parameters are defined via environment variables in `.env`:
|
||||
| `VIDEO_ARCHIVE_HOST` | `Path` | `./data/archive` | Docker Compose | Host filesystem directory path containing raw CCTV video recordings (structured as `<date>/<batch>.mp4`). Mounted read-only (`:ro`). |
|
||||
| `APP_DATA_DIR` | `Path` | `./data` (or `/data` in Docker) | Backend | Base directory for application persistent data, SQLite database (`app.db`), projects, extracted frames, datasets, and model weights. |
|
||||
| `VIDEO_ARCHIVE` | `Path` | `/videos` (or `data/archive`) | Backend | Internal container/local filesystem path where the video archive is browsed by FastAPI. |
|
||||
| `WEB_PORT` | `Integer` | `8080` | Docker / Nginx | Host HTTP port mapped to the Nginx frontend web UI. |
|
||||
| `CORS_ORIGINS` | `String` | `http://localhost:5173,http://localhost:8080` | FastAPI Backend | Comma-separated list of allowed origins for Cross-Origin Resource Sharing. |
|
||||
| `WEB_PORT` | `Integer` | `9000` | Docker / Nginx | Host HTTP port mapped to the Nginx frontend web UI. |
|
||||
| `API_PORT` | `Integer` | `9010` | Docker / FastAPI | Host HTTP port mapped to the FastAPI backend API. |
|
||||
| `CORS_ORIGINS` | `String` | `http://localhost:5173,http://localhost:9000,http://localhost:9010` | FastAPI Backend | Comma-separated list of allowed origins for Cross-Origin Resource Sharing. |
|
||||
| `API_URL` | `URL` | `http://localhost:8000` | Vite Dev Server | Backend target endpoint for Vite development proxy (`frontend/vite.config.js`). |
|
||||
| `MEDIAMTX_WHEP_PATH` | `String` | `/whep` | Backend Live Count | WHEP WebRTC endpoint path on the streaming media server (MediaMTX). |
|
||||
| `MEDIAMTX_RTSP_PORT` | `Integer` | `8554` | Backend Live Count | RTSP stream port used to translate WHEP browser streams into backend video processing feeds. |
|
||||
@@ -605,6 +606,7 @@ Comprehensive technical specifications, operational SOPs, and architecture diagr
|
||||
| **Architecture Flow Diagram (4K)** | `PNG` (1.5 MB) | 4K Ultra-HD raster export of the 8-stage end-to-end retraining pipeline. | [**⬇️ Download 4K**](docs/diagram-alur.png) |
|
||||
| **Architecture Flow Diagram (Vector)** | `SVG` (34.6 KB) | Scalable vector graphic diagram for high-resolution display. | [**⬇️ Download SVG**](docs/diagram-alur.svg) |
|
||||
| **Architecture Flow Diagram (Source)** | `FODG` (24.8 KB) | Native LibreOffice Draw Flat XML editable source file. | [**⬇️ Download FODG**](docs/diagram-alur.fodg) |
|
||||
| **Entity Relationship Diagram (ERD)** | `MD` (8.5 KB) | Relational database schema, foreign keys, indexes, and Mermaid ERD diagram. | [**📖 View ERD**](ERD.md) |
|
||||
| **System Requirements Specification** | `MD` (23.6 KB) | Numbered technical requirements (`REQ-001` through `REQ-042`). | [**📖 View Spec**](docs/requirements.md) |
|
||||
| **System Design & Architecture** | `MD` (22.7 KB) | Database schema, REST API contracts, disk layouts, and backend invariants. | [**📖 View Design**](docs/design.md) |
|
||||
| **UI/UX Design Specification** | `MD` (79.7 KB) | Dark theme design tokens, hotkey maps, and component specifications. | [**📖 View UI Spec**](docs/ui-spec.md) |
|
||||
|
||||
Reference in new issue
Block a user