Cutlery/Kyoo
1
0
Fork 0
mirror of https://github.com/zoriya/Kyoo.git synced 2025-11-22 22:43:09 -05:00
Code Issues Packages Projects Releases Wiki Activity

update SSR notes + api downloads media images

Browse Source
This commit is contained in:
Arlan Lloyd 2025-11-18 18:10:13 +00:00
parent 851ae9eb9d
commit df26dbca63
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
DIAGRAMS.md
View File

@ -85,6 +85,8 @@ C4Context
``` ```
## Container ## Container
Kyoo leverages the [API Gateway](https://learn.microsoft.com/en-us/azure/architecture/microservices/design/gateway) approach to microservices and [offloads](https://learn.microsoft.com/en-us/azure/architecture/patterns/gateway-offloading) authentication at the gateway.
```mermaid ```mermaid
C4Container C4Container
UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1") UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1")
@ -111,6 +113,7 @@ C4Container
Rel(apigateway, auth, "") Rel(apigateway, auth, "")
Rel(frontend, api, "") Rel(frontend, api, "")
Rel(api, tracker, "") Rel(api, tracker, "")
Rel(api, content, "")
Rel(scanner, api, "") Rel(scanner, api, "")
Rel(scanner, media, "") Rel(scanner, media, "")
Rel(scanner, content, "") Rel(scanner, content, "")
@ -118,9 +121,7 @@ C4Container
``` ```
## Component ## Component
#### Auth #### Auth
Kyoo leverages the [API Gateway](https://learn.microsoft.com/en-us/azure/architecture/microservices/design/gateway) approach to microservices and [offloads](https://learn.microsoft.com/en-us/azure/architecture/patterns/gateway-offloading) authentication at the gateway. Auth microservice is implicitly used by each other microservice for both end user authentication and microservice to microservice communications. Auth microservice is implicitly used by each other microservice for both end user authentication and microservice to microservice communications. Auth microservice will not be directly represented in the other component diagrams. Instead in their relationsihp will specify "auth via middleware".
*Auth microservice will not be directly represented in the other component diagrams. Instead in their relationsihp will specify "auth via middleware".
```mermaid ```mermaid
C4Component C4Component
@ -151,20 +152,23 @@ C4Component
Container_Boundary(scanner, "scanner") { Container_Boundary(scanner, "scanner") {
Component(scanner_c1, "kyoo_scanner", "Python", "") Component(scanner_c1, "kyoo_scanner", "Python", "")
} }
Container_Boundary(front, "front") {
Component(front_c1, "kyoo_front", "TypeScript", "")
}
System_Boundary(external, "") { System_Boundary(external, "") {
System_Ext(tracker, "ActivityTracker", "") System_Ext(tracker, "ActivityTracker", "")
System_Ext(content, "ContentDatabase", "")
}
Container_Boundary(front, "front") {
Component(front_c1, "kyoo_front", "TypeScript", "")
} }
Rel(user, api_c1, "auth via middleware") Rel(user, api_c1, "auth via middleware")
Rel(api_c1, api_db1, "") Rel(api_c1, api_db1, "")
Rel(api_c1, api_c2, "") Rel(api_c1, api_c2, "")
Rel(api_c1, content, "http(s) <br/> retries media images")
Rel(api_c1, tracker, "") Rel(api_c1, tracker, "")
Rel(scanner_c1, api_c1, "auth via middleware") Rel(scanner_c1, api_c1, "auth via middleware")
Rel(front_c1, api_c1, "") Rel(front_c1, api_c1, "http(s) SSR <br/> auth via middleware")
``` ```
#### Front #### Front
@ -183,7 +187,7 @@ C4Component
Component(api_c1, "kyoo_api", "TypeScript", "") Component(api_c1, "kyoo_api", "TypeScript", "")
} }
Rel(user, front_c1, "") Rel(user, front_c1, "")
Rel(front_c1, api_c1, "") Rel(front_c1, api_c1, "http(s) SSR <br/> auth via middleware")
``` ```
@ -240,6 +244,6 @@ C4Component
Rel(user, scanner_c1, "http(s) <br/> auth via middleware") Rel(user, scanner_c1, "http(s) <br/> auth via middleware")
Rel(scanner_c1, api_c1, "http(s) <br/> auth via middleware") Rel(scanner_c1, api_c1, "http(s) <br/> auth via middleware")
Rel(scanner_c1, scanner_db1, "") Rel(scanner_c1, scanner_db1, "")
Rel(scanner_c1, content, "http(s) <br/> gathers media info & images") Rel(scanner_c1, content, "http(s) <br/> gathers media metadata")
Rel(scanner_c1, media, "mounted to filesystem <br/> watches") Rel(scanner_c1, media, "mounted to filesystem <br/> watches")
``` ```