diff --git a/README.md b/README.md index b3be80add9342cee8b12c46c34b6f82526c5ed50..b60803e0791e506358e8ad9894c8cdcdb912a3b8 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,16 @@ > runtime in the browser. Besides serving the information about all resources, this service can > also function to provide snapshots of all the resources available at a specific point in time. +## Architecture + +The ui-middleware is, as the name already suggests, a middleware component to support the App Suite UI. +As an installation of App Suite UI can consist of multiple projects, like the [Core App Suite UI](https://gitlab.open-xchange.com/frontend/ui), [Documents UI]([https://gitlab.open-xchange.com/documents/office-web), [OX Guard UI](https://gitlab.open-xchange.com/appsuite/guard-ui), and other custom plugins, those components need to be combined at some point to be served to the browser. +This is handled by the ui-middleware component, by putting it between the Ingress Controller and the containers serving the individual components that make up the App Suite UI. + +If you prefer a picture, this is, how such an installation can look like. + + + ## Endpoint - `/manifests` diff --git a/docs/ui-mw-architecture.png b/docs/ui-mw-architecture.png new file mode 100644 index 0000000000000000000000000000000000000000..cfe003203af03aea41ee5cfaf9006f3426a074fb Binary files /dev/null and b/docs/ui-mw-architecture.png differ