Deployment Architecture
qOntology separates the frontend from the backend. Nginx serves frontend resources and forwards requests; the qOntology API handles business logic and connects to MySQL, Redis, Neo4j, and other services. The default deployment runs on a single server with Docker Compose. kkFileView provides file previews, while AI model and vector services can be connected as needed.
Deployment architecture
Solid arrows show the default connections; dashed arrows show optional integrations. The default deployment contains six services. AI models require separate configuration, and Weaviate is not included in the default Compose stack and must be prepared separately when needed.
Components
| Component | Main responsibility |
|---|---|
| Nginx | Serves frontend static resources and forwards API, WebSocket, and file preview requests to the corresponding services |
| qOntology API | Handles basic management, ontology modeling, and ontology applications; accesses databases, caches, and configured external services |
| MySQL | Stores system configuration and business data |
| Redis | Provides caching |
| Neo4j | Stores and queries graph data, supporting entity and relationship reads and writes |
| kkFileView | Provides online file previews |
| AI model service (optional) | Supplies model inference for enabled AI features; requires an available endpoint and credentials |
| Weaviate (optional) | Provides vector storage and retrieval; deploy separately or connect to an existing service |
Request flows
- Page access: the browser opens
http://<SERVER_IP>:8897, and Nginx returns frontend pages and static resources. If the entry port is changed, use the configured port. - Business APIs: the frontend calls business endpoints through
/prod-apiand establishes real-time connections through/websocket/. Nginx forwards requests toqontology-api:8097; the API accesses MySQL, Redis, Neo4j, or optional services as required. - File previews: the browser requests previews through
/kkfileview/, which Nginx forwards tokkfileview:8012. The preview service must also be able to access the URL of the file being previewed.
These service names and internal ports are used for communication within the Compose network; browsers use the Nginx entry point. The diagram describes the default single-server deployment. For production, plan component separation, persistent storage, and backup and recovery according to resource and availability requirements.