docs: update architecture documentation and manifests
Refine technical documentation to reflect current architecture, component structure, and routing conventions for the vcon console.
This commit is contained in:
1 parent
bb938c33c0
commit
367dd819f8
64 files changed
+910
-2661
No files matched your search
@@ -1,17 +1,15 @@
|
||||
# Admin Settings Manifest
|
||||
# Admin Settings Engine Manifest
|
||||
|
||||
## Purpose
|
||||
Global administrative configuration store and live subsystem parameter tuning.
|
||||
Manages global runtime configuration (`core/adminSettings/settingsManager.ts`), persisting settings to the PostgreSQL `admin_settings` table and applying live updates across backend engines.
|
||||
|
||||
## Managed Parameters
|
||||
- Ports: Ingestion (:4000) and Web (:3000)
|
||||
- Rate limiting and maximum payload size bounds
|
||||
- Buffer flush thresholds (count & timer)
|
||||
- CSV rotation limits (100MB / per-day)
|
||||
- JWT signature secret keys
|
||||
|
||||
## Dependencies
|
||||
- `core/Security/security`
|
||||
- `core/data/buffer`
|
||||
- `core/auth/jwt`
|
||||
- `core/Storage/csvStorage`
|
||||
- `serverPort` (`4000`) and `webPort` (`3000`)
|
||||
- `maxEventsPerSec`: Default per-client throughput ceiling (events/sec)
|
||||
- `maxPayloadSizeKb`: Maximum event payload size in kilobytes
|
||||
- `batchFlushThreshold`: Number of queued events that triggers an immediate CSV flush
|
||||
- `batchFlushIntervalMs`: Background timer interval for periodic CSV flushes
|
||||
- `fileRotationMb`: Maximum CSV partition file size before rotating to `-part2.csv`
|
||||
- `autoPruneDays`: Retention window in days for automatic CSV partition pruning
|
||||
- `enableIdempotency`: 5-minute TTL duplicate event filtering toggle
|
||||
- `jwtSecret`: HMAC secret used to sign and verify Client SDK JWT tokens (updating this automatically re-signs existing client tokens)
|
||||
Reference in new issue
Block a user