mirror of
https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git
synced 2025-12-06 07:21:36 +01:00
fix(docs): Add architecture.md and apis.md
This commit is contained in:
René Fischer
committed by
Thorsten Roßner
Thorsten Roßner
parent
718eb45e9c
commit
77108587c7
@@ -224,6 +224,7 @@ env-cleanup:
|
|||||||
for OPENDESK_RELEASE in $(helm ls -n ${NAMESPACE} -aq); do
|
for OPENDESK_RELEASE in $(helm ls -n ${NAMESPACE} -aq); do
|
||||||
helm uninstall -n ${NAMESPACE} ${OPENDESK_RELEASE};
|
helm uninstall -n ${NAMESPACE} ${OPENDESK_RELEASE};
|
||||||
done
|
done
|
||||||
|
# if you update the section below, please also update the respective section in getting_started.md
|
||||||
kubectl delete pvc --all --namespace ${NAMESPACE};
|
kubectl delete pvc --all --namespace ${NAMESPACE};
|
||||||
kubectl delete jobs --all --namespace ${NAMESPACE};
|
kubectl delete jobs --all --namespace ${NAMESPACE};
|
||||||
kubectl delete configmaps --all --namespace ${NAMESPACE};
|
kubectl delete configmaps --all --namespace ${NAMESPACE};
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ SPDX-License-Identifier: Apache-2.0
|
|||||||
* [Requirements](#requirements)
|
* [Requirements](#requirements)
|
||||||
* [Getting started](#getting-started)
|
* [Getting started](#getting-started)
|
||||||
* [Advanced customization](#advanced-customization)
|
* [Advanced customization](#advanced-customization)
|
||||||
* [Components](#components)
|
* [Architecture](#architecture)
|
||||||
* [Releases](#releases)
|
* [Releases](#releases)
|
||||||
* [Feedback](#feedback)
|
* [Feedback](#feedback)
|
||||||
* [Development](#development)
|
* [Development](#development)
|
||||||
@@ -73,9 +73,9 @@ You would like to install openDesk in your own infrastructure?
|
|||||||
- [Monitoring](./docs/monitoring.md)
|
- [Monitoring](./docs/monitoring.md)
|
||||||
- [Theming](./docs/theming.md)
|
- [Theming](./docs/theming.md)
|
||||||
|
|
||||||
# Components
|
# Architecture
|
||||||
|
|
||||||
More information on openDesk's components and their integration can be found in our detailed [Component docs](./docs/components.md).
|
More information on openDesk's architecture can be found in our [Architecture docs](./docs/architecture.md).
|
||||||
|
|
||||||
# Releases
|
# Releases
|
||||||
|
|
||||||
|
|||||||
@@ -18,6 +18,11 @@ path = "helmfile/files/theme/*"
|
|||||||
SPDX-FileCopyrightText = "2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH"
|
SPDX-FileCopyrightText = "2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH"
|
||||||
SPDX-License-Identifier = "Apache-2.0"
|
SPDX-License-Identifier = "Apache-2.0"
|
||||||
|
|
||||||
|
[[annotations]]
|
||||||
|
path = "docs/architecture/apis_images/*"
|
||||||
|
SPDX-FileCopyrightText = "2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH"
|
||||||
|
SPDX-License-Identifier = "Apache-2.0"
|
||||||
|
|
||||||
[[annotations]]
|
[[annotations]]
|
||||||
path = "helmfile/files/portal-tiles/*"
|
path = "helmfile/files/portal-tiles/*"
|
||||||
SPDX-FileCopyrightText = "2024 Google LLC"
|
SPDX-FileCopyrightText = "2024 Google LLC"
|
||||||
|
|||||||
437
docs/architecture.md
Normal file
437
docs/architecture.md
Normal file
@@ -0,0 +1,437 @@
|
|||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1>Architecture</h1>
|
||||||
|
|
||||||
|
* [Overview](#overview)
|
||||||
|
* [Nubus (IAM)](#nubus-iam)
|
||||||
|
* [Authentication](#authentication)
|
||||||
|
* [Identity data flows](#identity-data-flows)
|
||||||
|
* [OpenID Connect (OIDC)](#openid-connect-oidc)
|
||||||
|
* [Keycloak](#keycloak)
|
||||||
|
* [Keycloak Extensions](#keycloak-extensions)
|
||||||
|
* [OpenLDAP](#openldap)
|
||||||
|
* [Authorization](#authorization)
|
||||||
|
* [LDAP Group Synchronization](#ldap-group-synchronization)
|
||||||
|
* [Provisioning](#provisioning)
|
||||||
|
* [OX Connector](#ox-connector)
|
||||||
|
* [SCIM](#scim)
|
||||||
|
* [Component integration](#component-integration)
|
||||||
|
* [Intercom Service / Silent Login](#intercom-service--silent-login)
|
||||||
|
* [Central Contacts](#central-contacts)
|
||||||
|
* [Central Navigation](#central-navigation)
|
||||||
|
* [Filepicker](#filepicker)
|
||||||
|
* [(OpenProject) File Store](#openproject-file-store)
|
||||||
|
* [Applications vs. Services](#applications-vs-services)
|
||||||
|
* [Collabora (Office)](#collabora-office)
|
||||||
|
* [CryptPad Online (Diagrams)](#cryptpad-online-diagrams)
|
||||||
|
* [Element/Synapse (Chat \& Call)](#elementsynapse-chat--call)
|
||||||
|
* [Jitsi (Video Conferencing)](#jitsi-video-conferencing)
|
||||||
|
* [Nextcloud (Files)](#nextcloud-files)
|
||||||
|
* [Nubus (Identity and Access Management / Portal)](#nubus-identity-and-access-management--portal)
|
||||||
|
* [OpenProject (Project management)](#openproject-project-management)
|
||||||
|
* [OX App Suite (Groupware) with OX Dovecot (Mail backend)](#ox-app-suite-groupware-with-ox-dovecot-mail-backend)
|
||||||
|
* [XWiki (Knowledge management)](#xwiki-knowledge-management)
|
||||||
|
* [Application specific user accounts](#application-specific-user-accounts)
|
||||||
|
* [Footnotes](#footnotes)
|
||||||
|
|
||||||
|
openDesk is designed as a [Kubernetes](https://kubernetes.io) deployment.
|
||||||
|
|
||||||
|
It consists of a set of [Helm charts](https://helm.sh/) orchestrated by [Helmfile](https://github.com/helmfile/helmfile).
|
||||||
|
|
||||||
|
openDesk includes the functional applications, like file management, chat, and email. Other services such
|
||||||
|
as databases and object storage are included for evaluation purposes only. In production, you must provide
|
||||||
|
these services yourself.
|
||||||
|
|
||||||
|
# Overview
|
||||||
|
|
||||||
|
The following diagram shows a high-level overview of openDesk.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart TD
|
||||||
|
A(User) -->|Log In| B[Keycloak]
|
||||||
|
subgraph Nubus
|
||||||
|
B -->C[Portal]
|
||||||
|
B -->|User Directory| OpenLDAP
|
||||||
|
end
|
||||||
|
C -->|Manage Files| NC[fa:fa-file Nextcloud]
|
||||||
|
C -->|Chat & Call| EL[fa:fa-comments Element]
|
||||||
|
C -->|Send/Receive E-Mails| OXE[fa:fa-envelope OX App Suite]
|
||||||
|
C -->|Manage Appointments| OXC[fa:fa-calendar OX App Suite]
|
||||||
|
NC -->|Edit Office Documents| CO[fa:fa-file-word Collabora Online]
|
||||||
|
NC -->|Edit diagram.net Documents| CP[fa:fa-chart-diagram CryptPad]
|
||||||
|
C -->|Manage Tasks| OP[fa:fa-diagram-project OpenProject]
|
||||||
|
C -->|Store Knowledge| XW[fa:fa-book XWiki]
|
||||||
|
C -->|Meet People| JI[fa:fa-video Jitsi]
|
||||||
|
```
|
||||||
|
|
||||||
|
openDesk includes a portal that allows navigation to the respective application. The portal is part of the
|
||||||
|
Identity and Access Management (IAM) application shipped with openDesk: *Nubus*. Nubus includes OpenLDAP
|
||||||
|
for storing users, groups, and permissions, and Keycloak for single sign-on with LDAP user federation
|
||||||
|
configured to the aforementioned OpenLDAP.
|
||||||
|
|
||||||
|
When the user is authenticated by Keycloak, the portal shows the applications the user is permitted to access.
|
||||||
|
|
||||||
|
The user can now access applications and use the corresponding functionality without the need to authenticate to
|
||||||
|
applications again. This is implemented using the OpenID Connect (OIDC) protocol.
|
||||||
|
|
||||||
|
# Nubus (IAM)
|
||||||
|
|
||||||
|
[Nubus](https://www.univention.de/products/nubus/) is a specialized IAM platform developed by Univention GmbH
|
||||||
|
to centralize and simplify identity management in IT environments. It is typically used in contexts where
|
||||||
|
user authentication, role-based access control, and integration with multiple systems are essential.
|
||||||
|
|
||||||
|
In openDesk, Nubus serves the following purposes:
|
||||||
|
|
||||||
|
1. Identity Provider (IdP)
|
||||||
|
|
||||||
|
Nubus acts as the central IdP in a federated authentication system, issuing and managing authentication tokens for applications.
|
||||||
|
|
||||||
|
2. Access Control Layer
|
||||||
|
|
||||||
|
As a gateway, Nubus ensures that only authorized users can access specific systems, services, or APIs, enforcing RBAC policies.
|
||||||
|
|
||||||
|
3. Integration Hub
|
||||||
|
|
||||||
|
Links applications by synchronizing identity and access data across them, ensuring consistency.
|
||||||
|
|
||||||
|
4. User Provisioning
|
||||||
|
|
||||||
|
Automates the process of creating, updating, and deactivating user accounts across integrated systems based on organizational workflows.
|
||||||
|
|
||||||
|
5. IAM Administration
|
||||||
|
|
||||||
|
The user, group and permission information which is stored in Nubus' OpenLDAP service is managed by IAM Admin(s)
|
||||||
|
using a stripped down version of the [UMC (Univention Management Console)](https://docs.software-univention.de/manual/5.0/de/central-management-umc/umc.html).
|
||||||
|
|
||||||
|
6. Frontend Integration Authentication
|
||||||
|
|
||||||
|
A specialized component - the Intercom Service - acts according to the Backend-for-Frontend pattern when it comes to certain integration use cases requiring the frontend of one application to call the API of another service that also has the need for user authentication. See [Component integration](#component-integration) for more details.
|
||||||
|
|
||||||
|
7. Portal
|
||||||
|
|
||||||
|
Nubus provides a Portal component for users to access the connected applications, that also includes a self service e.g. for password reset.
|
||||||
|
|
||||||
|
For additional information, refer to the [Nubus for Kubernetes Architecture Manual](https://docs.software-univention.de/nubus-kubernetes-architecture/latest/en/index.html).
|
||||||
|
|
||||||
|
# Authentication
|
||||||
|
|
||||||
|
openDesk uses the OpenID Connect (OIDC) protocol for authentication and authorization.
|
||||||
|
|
||||||
|
## Identity data flows
|
||||||
|
|
||||||
|
An overview of
|
||||||
|
- components that consume the LDAP service.
|
||||||
|
- The components access the LDAP using a component-specific LDAP search account.
|
||||||
|
- components using Univention Keycloak as an identity provider (IdP).
|
||||||
|
- The components should use OAuth2 / OIDC flows if not otherwise denoted.
|
||||||
|
- All components have a client configured in Keycloak.
|
||||||
|
|
||||||
|
Some components trust others to handle authentication for them.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart TD
|
||||||
|
K[IdP]-->L[LDAP]
|
||||||
|
N[Nextcloud]-->L
|
||||||
|
O[OpenProject] --> L
|
||||||
|
A[OX AppSuite]-->L
|
||||||
|
D[OX Dovecot]-->L
|
||||||
|
P[Portal/Admin]-->L
|
||||||
|
X[XWiki]-->L
|
||||||
|
A-->K
|
||||||
|
N-->K
|
||||||
|
D-->K
|
||||||
|
O-->K
|
||||||
|
X-->K
|
||||||
|
P-->|SAML|K
|
||||||
|
E[Element]-->K
|
||||||
|
J[Jitsi]-->K
|
||||||
|
I[IntercomService]-->K
|
||||||
|
C[Collabora]-->N
|
||||||
|
R[CryptPad]-->N
|
||||||
|
F[Postfix]-->D
|
||||||
|
```
|
||||||
|
|
||||||
|
## OpenID Connect (OIDC)
|
||||||
|
|
||||||
|
[OIDC](https://openid.net/developers/how-connect-works/) is an identity layer on top of the OAuth 2.0 protocol, allowing clients (Relying Party (RP)) to verify the identity of end-users based on the authentication performed by an authorization server (OpenID Provider (OP)). In openDesk, Keycloak serves as the OIDC provider, managing user authentication and issuing tokens for secure access to applications.
|
||||||
|
|
||||||
|
The following sequence diagram shows an OIDC flow of a user logging into openDesk's project management application. In openDesk, applications such as OpenProject take the role of the OIDC Relying Party, whereas Keycloak acts as the OIDC provider and OpenLDAP as the IdP.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
sequenceDiagram
|
||||||
|
autonumber
|
||||||
|
participant Browser as Browser
|
||||||
|
participant OpenProject as OpenProject<br/>OIDC Relying Party
|
||||||
|
participant Keycloak as Keycloak<br>OIDC Provider
|
||||||
|
participant LDAP as OpenLDAP<br>IdP
|
||||||
|
Browser->>OpenProject: GET https://projects.domain.tld
|
||||||
|
OpenProject-->>Browser: Redirect to OIDC provider authentication form (with request)
|
||||||
|
Browser->>Keycloak: Authenticate with username/password, optionally 2FA
|
||||||
|
Keycloak->>LDAP: Retrieve/update user information
|
||||||
|
LDAP->>Keycloak: Return user info
|
||||||
|
Keycloak-->>Browser: 302 Redirect https://projects.domain.tld/callback?[...]
|
||||||
|
Browser->>OpenProject: GET https://projects.domain.tld/callback?[...]
|
||||||
|
OpenProject->>Keycloak: POST https://id.domain.tld/oauth/token
|
||||||
|
Keycloak-->>OpenProject: Return JSON with token, signature
|
||||||
|
OpenProject->>OpenProject: Verify token signature valid, signed by Provider
|
||||||
|
OpenProject-->>Browser: 302 Redirect https://projects.domain.tld
|
||||||
|
Note over Browser: User is authenticated
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Note:**<br>
|
||||||
|
> Nubus' Portal and UMC still use [SAML 2.0](https://www.oasis-open.org/standard/saml/) to authenticate users. However, Nubus will switch to OIDC in an upcoming release, eliminating the use of SAML in openDesk altogether.
|
||||||
|
|
||||||
|
## Keycloak
|
||||||
|
|
||||||
|
[Keycloak](https://www.keycloak.org/) is an open-source identity and access management solution for web based applications and services. It provides features such as single sign-on, multi-factor authentication, user federation, and centralized user management.
|
||||||
|
|
||||||
|
In openDesk, Keycloak serves as the [OIDC provider](#openid-connect-oidc), handling user authentication and issuing tokens for secure access to applications.
|
||||||
|
|
||||||
|
For more information, see the [Keycloak Documentation](https://www.keycloak.org/documentation).
|
||||||
|
|
||||||
|
## Keycloak Extensions
|
||||||
|
|
||||||
|
Part of Nubus are the [Keycloak Extensions](https://docs.software-univention.de/nubus-kubernetes-operation/1.0/en/configuration/keycloak-extensions.html) used for
|
||||||
|
|
||||||
|
- Login brute force protection: Blocking authentication requests upon too much failed attempts from a device or IP. The available [CAPTCHA](https://en.wikipedia.org/wiki/CAPTCHA) option is deactivated in openDesk.
|
||||||
|
- New device notification: Sending the use an email after successful login from a new device.
|
||||||
|
|
||||||
|
To address these use cases the Keycloak Extensions act as a proxy to Keycloak.
|
||||||
|
|
||||||
|
## OpenLDAP
|
||||||
|
|
||||||
|
[OpenLDAP](https://www.openldap.org) is an open-source implementation of the Lightweight Directory Access Protocol (LDAP) that provides a central repository for user and group information. In openDesk, OpenLDAP is used as the user directory to store user and group data and manage access control policies across the applications.
|
||||||
|
|
||||||
|
# Authorization
|
||||||
|
|
||||||
|
## LDAP Group Synchronization
|
||||||
|
|
||||||
|
LDAP group synchronization ensures that user group memberships are consistent across the applications in openDesk that make use of the IAM group information. Nubus uses OpenLDAP to store and manage user groups, which are synchronized with integrated applications to enforce access control policies.
|
||||||
|
|
||||||
|
Beside Keycloak LDAP groups are available to the following applications, none of the application supports nested groups. It means that users must be direct members of a group, as members of sub groups are ignored.
|
||||||
|
- Files / Nextcloud: Reads all groups that are enabled for Nextcloud twice a day based on the setting `background_sync_interval` in the `user_ldap` app.
|
||||||
|
- Knowledge Management / XWiki: Reads all groups that are enabled for XWiki use, this is done nightly based the jobs `LDAP Group Import Job` and `Mapped groups daily updater` that admin users can access in `/bin/view/Scheduler`.
|
||||||
|
- Project Management / OpenProject: Reads all groups that are enabled for OpenProject [hourly](https://www.openproject.org/docs/system-admin-guide/authentication/ldap-connections/ldap-group-synchronization/#create-a-synchronized-group).
|
||||||
|
- Webmail / OX AppSuite: Requires a webmail user to be part of a group before the group is actively provisioned to OX AppSuite.
|
||||||
|
|
||||||
|
# Provisioning
|
||||||
|
|
||||||
|
Part of the already mentioned Nubus IAM is a [provisioning service](https://docs.software-univention.de/nubus-kubernetes-architecture/0.5/en/components/provisioning-service.html).
|
||||||
|
|
||||||
|
Beside the Nubus internal user of the provisioning service the OX AppSuite is currently the only openDesk application that is getting data actively provisioned in contrast to scenarios where applications fetch the required information from the LDAP.
|
||||||
|
|
||||||
|
## OX Connector
|
||||||
|
|
||||||
|
As the OX AppSuite is using an application specific format to get e.g. users provisioned, there is also a specific connector component that links to provisioning service to the OX AppSuite, it is called the [OX Connector](https://docs.software-univention.de/manual/5.0/de/mail/ox-connector.html).
|
||||||
|
|
||||||
|
The [OX SOAP API](https://oxpedia.org/wiki/index.php?title=Open-Xchange_Provisioning_using_SOAP) is used by the OX Connector to synchronize information about the follow OX AppSuite objects:
|
||||||
|
- Contexts
|
||||||
|
- Functional Mailboxes
|
||||||
|
- Groups
|
||||||
|
- (Managed) Resources
|
||||||
|
- Users
|
||||||
|
|
||||||
|
To find out more, see [Roles & Permissions](roles-and-permissions.md).
|
||||||
|
|
||||||
|
## SCIM
|
||||||
|
|
||||||
|
[System for Cross-domain Identity Management](https://scim.cloud) (SCIM) is an open standard for automating the exchange of user identity information between identity domains or IT systems. SCIM is designed to make user provisioning and management easier by providing a standardized way to manage user identities in cloud-based applications and services.
|
||||||
|
|
||||||
|
In openDesk, SCIM will be used in the future to automate the process of creating, updating, and deactivating user accounts across the applications. This ensures that user data is consistent and up-to-date across all applications, reducing the administrative overhead and potential for errors.
|
||||||
|
|
||||||
|
> **Note:**<br>
|
||||||
|
> SCIM support is planned in openDesk for 2025.
|
||||||
|
|
||||||
|
# Component integration
|
||||||
|
|
||||||
|
Important, especially from the end user perspective are the functional integrations between the different openDesk applications.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart TD
|
||||||
|
OX-AppSuite_Frontend-->|Silent Login, Filepicker, Central Navigation|Intercom_Service
|
||||||
|
Element-->|Silent Login, Central Navigation|Intercom_Service
|
||||||
|
Intercom_Service-->|Silent Login, Token Exchange|IdP
|
||||||
|
Intercom_Service-->|Filepicker|Nextcloud
|
||||||
|
Intercom_Service-->|Central Navigations|Portal
|
||||||
|
OX-AppSuite_Backend-->|Filepicker|Nextcloud
|
||||||
|
OX-AppSuite_Backend-->|Videoconferences|Element
|
||||||
|
Nextcloud-->|Central Navigation|Portal
|
||||||
|
OpenProject-->|Central Navigation|Portal
|
||||||
|
OpenProject-->|File Store|Nextcloud
|
||||||
|
XWiki-->|Central Navigation|Portal
|
||||||
|
Nextcloud-->|Central Contacts|OX-AppSuite_Backend
|
||||||
|
OX-AppSuite_Frontend-->|Filepicker|OX-AppSuite_Backend
|
||||||
|
```
|
||||||
|
|
||||||
|
Details can be found in the upstream documentation that is linked in the respective sections.
|
||||||
|
|
||||||
|
## Intercom Service / Silent Login
|
||||||
|
|
||||||
|
The Intercom Service is deployed in the context of Nubus. Its role is to enable cross-application integration
|
||||||
|
based on the user's browser interaction as handling authentication when the frontend of an application has to call
|
||||||
|
the API from another application is often a challenge.
|
||||||
|
|
||||||
|
To establish a session with the Intercom Service, applications can use the silent login feature within an iframe.
|
||||||
|
|
||||||
|
Currently, only OX AppSuite and Element are using the frontend-based integration.
|
||||||
|
|
||||||
|
**Links**
|
||||||
|
- [Intercom Service upstream documentation](https://docs.software-univention.de/intercom-service/latest/index.html).
|
||||||
|
|
||||||
|
## Central Contacts
|
||||||
|
|
||||||
|
OX App Suite is managing contacts in openDesk. Therefore, Nextcloud's PHP backend is using the OX AppSuite's middleware Contacts API to
|
||||||
|
- create a new contact in the user's contacts folder when a file is shared with an unknown email address.
|
||||||
|
- retrieve contacts from the user's contacts folder to support search-as-you-type when starting to share a file.
|
||||||
|
|
||||||
|
**Links:**
|
||||||
|
- Currently used [OX Contacts API (deprecated)](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Contacts).
|
||||||
|
- New [OX Addressbooks API](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Addressbooks) the Central Contacts integration will switch to.
|
||||||
|
|
||||||
|
## Central Navigation
|
||||||
|
|
||||||
|
Central navigation is based on an API endpoint in the Nubus portal that returns a JSON containing the portal's contents for
|
||||||
|
a given user. The response from the API endpoint is used in the openDesk applications to render the central navigation.
|
||||||
|
|
||||||
|
The API can be called by
|
||||||
|
- frontend services through the Intercom Service's `/navigation.json` endpoint or
|
||||||
|
- backend services directly at the portal's `/univention/portal/navigation.json` endpoint.
|
||||||
|
|
||||||
|
The central navigation expects the API caller to present a shared secret for authentication and the username for whom the portal
|
||||||
|
contents should be returned for.
|
||||||
|
|
||||||
|
A `curl` based request returning the navigation contents looks like this:
|
||||||
|
|
||||||
|
```
|
||||||
|
curl 'https://portal.<DOMAIN>/univention/portal/navigation.json?base=https%3A//portal.<DOMAIN>&language=de-DE' -u "<USERNAME>:<SHARED_SECRET>"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Filepicker
|
||||||
|
|
||||||
|
The Nextcloud Filepicker is integrated into the OX AppSuite, supporting the following use cases against the respective openDesk instance's Nextcloud:
|
||||||
|
- Attach files from Nextcloud to emails.
|
||||||
|
- Create and add links to Nextcloud files into emails.
|
||||||
|
- Save attachments from emails into Nextcloud.
|
||||||
|
- Attach files from Nextcloud to calendar entries.
|
||||||
|
|
||||||
|
The Filepicker uses frontend and backend-based integration:
|
||||||
|
- For frontend-based integration, the OX AppSuite frontend uses the Intercom Service.
|
||||||
|
- Backend-based integration is coming from OX AppSuite middleware. The middleware communicates directly with Nextcloud
|
||||||
|
when adding a file to an email or storing a file into Nextcloud to avoid passing these files through the user's browser.
|
||||||
|
|
||||||
|
**Links**
|
||||||
|
- [OX AppSuite Nextcloud Integration upstream documentation](https://gitlab.open-xchange.com/extensions/nextcloud-integration/-/tree/main/documentation).
|
||||||
|
|
||||||
|
## (OpenProject) File Store
|
||||||
|
|
||||||
|
While OpenProject allows you to attach files to work packages directly, it is often preferred that the files are
|
||||||
|
stored within Nextcloud or to link an existing file from your openDesk Nextcloud to a work package.
|
||||||
|
|
||||||
|
Therefore, openDesk pre-configures the trust between the openDesk instance's OpenProject and Nextcloud during the `openproject-boostrap` deployment step. As a prerequisite for that, openDesk's Nextcloud contains the `integration_openproject` app.
|
||||||
|
|
||||||
|
The file store must still be enabled per project in OpenProject's project admin section.
|
||||||
|
|
||||||
|
**Links:**
|
||||||
|
- [OpenProject's documentation on Nextcloud integration](https://www.openproject.org/docs/system-admin-guide/integrations/nextcloud/)
|
||||||
|
- [OpenProject Integration Nextcloud app](https://apps.nextcloud.com/apps/integration_openproject)
|
||||||
|
|
||||||
|
# Applications vs. Services
|
||||||
|
|
||||||
|
openDesk consists of a variety of open-source projects, please find an overview below:
|
||||||
|
|
||||||
|
| Name | Description | Type |
|
||||||
|
| --------------------- | -------------------------------- | ----------- |
|
||||||
|
| Certificates | TLS certificates | Service |
|
||||||
|
| ClamAV (Distributed) | Antivirus engine | Service |
|
||||||
|
| ClamAV (Simple) | Antivirus engine | Service |
|
||||||
|
| Collabora | Weboffice | Application |
|
||||||
|
| CryptPad | diagrams.net editor | Application |
|
||||||
|
| dkimpy-milter | DKIM milter for Postfix | Service |
|
||||||
|
| Element | Secure communications platform | Application |
|
||||||
|
| Jitsi | Videoconferencing | Application |
|
||||||
|
| MariaDB | Database | Service |
|
||||||
|
| Memcached | Cache Database | Service |
|
||||||
|
| MinIO | Object Storage | Service |
|
||||||
|
| Nextcloud | File share | Application |
|
||||||
|
| Nubus (UMS) | Identity Management & Portal | Application |
|
||||||
|
| OpenProject | Project management | Application |
|
||||||
|
| OX Appsuite & Dovecot | Groupware with IMAP mail backend | Application |
|
||||||
|
| Postfix | MTA | Service |
|
||||||
|
| PostgreSQL | Database | Service |
|
||||||
|
| Redis | Cache Database | Service |
|
||||||
|
| XWiki | Knowledge Management | Application |
|
||||||
|
|
||||||
|
The end user focussed components are called applications and provide the functional scope of openDesk, please find separate paragraphs on each of the applications below.
|
||||||
|
|
||||||
|
Other components are of type "Service", these are used for development and evaluation purposes only, they need to be replaced in production deployments.
|
||||||
|
|
||||||
|
For the APIs / Protocols supported by the applications, please read the [apis.md](./architecture/apis.md).
|
||||||
|
|
||||||
|
## Collabora (Office)
|
||||||
|
|
||||||
|
[Collabora](https://www.collaboraonline.com) is a powerful online document editing suite.
|
||||||
|
|
||||||
|
In openDesk, Collabora is used for editing Office documents such as rich texts, spreadsheets and presentations.
|
||||||
|
|
||||||
|
## CryptPad Online (Diagrams)
|
||||||
|
|
||||||
|
[CryptPad](https://cryptpad.org/) is a collaborative editor framework supporting end-to-end encryption..
|
||||||
|
|
||||||
|
In openDesk, CryptPad is for editing diagrams.net documents.
|
||||||
|
|
||||||
|
## Element/Synapse (Chat & Call)
|
||||||
|
|
||||||
|
[Element Web](https://github.com/element-hq/element-web) is the web frontend for [Synapse](https://github.com/element-hq/synapse), the reference implementation of the sovereign and secure [Matrix protocol](https://matrix.org).
|
||||||
|
|
||||||
|
In openDesk, Element is used for chat and direct audio & video calling.
|
||||||
|
|
||||||
|
## Jitsi (Video Conferencing)
|
||||||
|
|
||||||
|
[Jitsi](https://jitsi.org) is an open-source video conferencing solution that allows users to hold secure video meetings.
|
||||||
|
|
||||||
|
In openDesk, Jitsi is used for video conferencing and online meetings. It integrates with other applications to provide seamless communication capabilities.
|
||||||
|
|
||||||
|
## Nextcloud (Files)
|
||||||
|
|
||||||
|
[Nextcloud](https://nextcloud.com) is a file storage and sync platform with powerful collaboration capabilities with desktop, mobile and web interfaces.
|
||||||
|
|
||||||
|
## Nubus (Identity and Access Management / Portal)
|
||||||
|
|
||||||
|
[Nubus](https://www.univention.com/products/nubus/) is a unified Identity & Access Management, providing you with full control and digital sovereignty over your IAM processes and data.
|
||||||
|
|
||||||
|
In openDesk Nubus is providing the management for user, groups and other IAM stored objects, as well as the portal, the Identity provider for Single Sign-On and federation scenarios and the
|
||||||
|
|
||||||
|
## OpenProject (Project management)
|
||||||
|
|
||||||
|
[OpenProject](https://www.openproject.org) is a project management tool that supports agile project management, team collaboration, issue tracking, and more.
|
||||||
|
|
||||||
|
## OX App Suite (Groupware) with OX Dovecot (Mail backend)
|
||||||
|
|
||||||
|
[OX App Suite](https://www.open-xchange.com/products/ox-app-suite) is a groupware application using [OX Dovecot](https://www.dovecot.org/) as its backend mail store.
|
||||||
|
|
||||||
|
In openDesk, OX App Suite is used for email, calendar, address book and personal task management.
|
||||||
|
|
||||||
|
## XWiki (Knowledge management)
|
||||||
|
|
||||||
|
[XWiki](https://www.xwiki.org) is an open-source wiki platform for knowledge management and collaboration.
|
||||||
|
|
||||||
|
# Application specific user accounts
|
||||||
|
|
||||||
|
While the IAM managed users centrally, some applications come with local accounts for administrative purposes.
|
||||||
|
|
||||||
|
| Application | Account name | Purpose | Password |
|
||||||
|
| ------------ | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
|
||||||
|
| Collabora | `collabora-internal-admin` | To access the Collabora admin dashboard | `secrets.collabora.adminPassword` |
|
||||||
|
| Element | `uvs` | The account for the "User Verification Service". It is used by Jitsi integrated into Element. | `secrets.matrixUserVerificationService.password` |
|
||||||
|
| | `meeting-bot` | Used by the Nordeck Meeting-Bot to manage meeting rooms in Synapse. | `secrets.matrixNeoDateFixBot.password` |
|
||||||
|
| Nextcloud | `nextcloud` | Bootstrap the Nextcloud fileshare for OpenProject with `opendesk-openproject-bootstrap` job[^1]. | `secrets.nextcloud.adminPassword` |
|
||||||
|
| OX App Suite | `admin` | OX-Connector to provision context, users, groups etc. | `secrets.oxAppsuite.adminPassword` |
|
||||||
|
| OpenProject | set in `secrets.openproject.apiAdminUsername` | Bootstrap the Nextcloud fileshare for OpenProject with `opendesk-openproject-bootstrap` job[^1]. | `secrets.openproject.apiAdminPassword` |
|
||||||
|
| XWiki | `superadmin` | Only available with `debug.enabled: true`, can be used for interactive login using `/bin/view/Main/?oidc.skipped=true`. | `secrets.xwiki.superadminpassword` |
|
||||||
|
|
||||||
|
# Footnotes
|
||||||
|
|
||||||
|
[^1]: We are working on a new approach to provision the OpenProject filestore, therefore the accounts are planned to be deactivated/removed with openDesk 1.2.
|
||||||
820
docs/architecture/apis.md
Normal file
820
docs/architecture/apis.md
Normal file
@@ -0,0 +1,820 @@
|
|||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
-->
|
||||||
|
|
||||||
|
<h1>openDesk APIs</h1>
|
||||||
|
|
||||||
|
This chapter presents APIs available in openDesk grouped by applications.
|
||||||
|
|
||||||
|
* [IAM - Nubus](#iam---nubus)
|
||||||
|
* [UMC Python API](#umc-python-api)
|
||||||
|
* [UMC store API](#umc-store-api)
|
||||||
|
* [IntercomService (ICS) API](#intercomservice-ics-api)
|
||||||
|
* [High-level Listener modules API](#high-level-listener-modules-api)
|
||||||
|
* [UDM Simple API](#udm-simple-api)
|
||||||
|
* [UDM REST API](#udm-rest-api)
|
||||||
|
* [UCR Python API](#ucr-python-api)
|
||||||
|
* [LDAP](#ldap)
|
||||||
|
* [Nubus Provisioning Service (**TBD**)](#nubus-provisioning-service-tbd)
|
||||||
|
* [Nubus Authorization Service (**TBD**)](#nubus-authorization-service-tbd)
|
||||||
|
* [Groupware - OX AppSuite / OX Dovecot](#groupware---ox-appsuite--ox-dovecot)
|
||||||
|
* [Usage of APIs within openDesk](#usage-of-apis-within-opendesk)
|
||||||
|
* [HTTP API](#http-api)
|
||||||
|
* [SOAP API](#soap-api)
|
||||||
|
* [REST API](#rest-api)
|
||||||
|
* [CardDAV](#carddav)
|
||||||
|
* [CalDAV](#caldav)
|
||||||
|
* [IMAP](#imap)
|
||||||
|
* [POP3](#pop3)
|
||||||
|
* [Files - Nextcloud](#files---nextcloud)
|
||||||
|
* [Usage of APIs within openDesk](#usage-of-apis-within-opendesk-1)
|
||||||
|
* [OCS API](#ocs-api)
|
||||||
|
* [Notifications API](#notifications-api)
|
||||||
|
* [Activity API](#activity-api)
|
||||||
|
* [Remote wipe API](#remote-wipe-api)
|
||||||
|
* [WebDAV](#webdav)
|
||||||
|
* [CalDAV / CardDAV](#caldav--carddav)
|
||||||
|
* [Weboffice - Collabora](#weboffice---collabora)
|
||||||
|
* [PostMessage API](#postmessage-api)
|
||||||
|
* [Conversion API](#conversion-api)
|
||||||
|
* [Project management - OpenProject](#project-management---openproject)
|
||||||
|
* [HATEOAS API](#hateoas-api)
|
||||||
|
* [BCF API](#bcf-api)
|
||||||
|
* [Video Conferencing - Jitsi](#video-conferencing---jitsi)
|
||||||
|
* [IFrame API](#iframe-api)
|
||||||
|
* [Lib-jitsi-meet API](#lib-jitsi-meet-api)
|
||||||
|
* [Jitsi Meet React SDK](#jitsi-meet-react-sdk)
|
||||||
|
* [Chat - Element](#chat---element)
|
||||||
|
* [Matrix Application Service API](#matrix-application-service-api)
|
||||||
|
* [Matrix Client-Server API](#matrix-client-server-api)
|
||||||
|
* [Matrix Server-Server API](#matrix-server-server-api)
|
||||||
|
* [Matrix Push Gateway API](#matrix-push-gateway-api)
|
||||||
|
* [Matrix Identity Service API](#matrix-identity-service-api)
|
||||||
|
* [Knowledge management - XWiki](#knowledge-management---xwiki)
|
||||||
|
* [REST API](#rest-api-1)
|
||||||
|
* [Scripting API](#scripting-api)
|
||||||
|
* [Java API](#java-api)
|
||||||
|
* [JavaScript API](#javascript-api)
|
||||||
|
|
||||||
|
# IAM - Nubus
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## UMC Python API
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Name | UMC Python API |
|
||||||
|
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | |
|
||||||
|
| Versioning | |
|
||||||
|
| Authentication | |
|
||||||
|
| In openDesk provided by | Nubus UMC |
|
||||||
|
| Transport protocol | |
|
||||||
|
| Usage within component | |
|
||||||
|
| Usage within openDesk | |
|
||||||
|
| Usage for external integration | |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | [Univention Management Console Protocol (UMCP)](https://docs.software-univention.de/ucs-python-api/univention.management.console.protocol.html). Format consisting of a single header line, one empty line and the body. The body can be JSON. |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://docs.software-univention.de/ucs-python-api/modules.html |
|
||||||
|
|
||||||
|
## UMC store API
|
||||||
|
|
||||||
|
| Name | UMC store API (also named UMC JavaScript API or Dojo/UMC JavaScript API) |
|
||||||
|
| ------------------------------ | --------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Encapsulate and ease the access to module data from JavaScript |
|
||||||
|
| Versioning | |
|
||||||
|
| Authentication | |
|
||||||
|
| In openDesk provided by | Nubus UMC |
|
||||||
|
| Transport protocol | |
|
||||||
|
| Usage within component | |
|
||||||
|
| Usage within openDesk | |
|
||||||
|
| Usage for external integration | |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://docs.software-univention.de/developer-reference/5.0/en/umc/local-system-module.html#umc-store-api |
|
||||||
|
|
||||||
|
## IntercomService (ICS) API
|
||||||
|
|
||||||
|
| Name | IntercomService API |
|
||||||
|
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Encapsulate and ease the access to module data from JavaScript |
|
||||||
|
| Versioning | |
|
||||||
|
| Authentication | IdP based SSO |
|
||||||
|
| In openDesk provided by | Nubus UMC |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | |
|
||||||
|
| Usage within openDesk | The ICS implements the BFF pattern for various openDesk inter-component integrations, see also [components.md](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/develop/docs/components.md#component-integration) |
|
||||||
|
| Usage for external integration | |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | Depends on the integration use case. |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://docs.software-univention.de/intercom-service/latest/architecture.html |
|
||||||
|
|
||||||
|
## High-level Listener modules API
|
||||||
|
|
||||||
|
| Name | High-level Listener modules API |
|
||||||
|
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Dispatching of LDAP events. |
|
||||||
|
| Versioning | |
|
||||||
|
| Authentication | |
|
||||||
|
| In openDesk provided by | Univention Event Processing |
|
||||||
|
| Transport protocol | |
|
||||||
|
| Usage within component | The listener mechanism is used to dispatch events from the LDAP to the Nubus provisioning service. It should be replaced by another approach in the future. |
|
||||||
|
| Usage within openDesk | The ICS implements the BFF pattern for various openDesk inter-component integrations, see also [components.md](https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk/-/blob/develop/docs/components.md#component-integration) |
|
||||||
|
| Usage for external integration | |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | Depends on the integration use case. |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://docs.software-univention.de/developer-reference/5.0/en/listener/api.html |
|
||||||
|
|
||||||
|
More details on the Nubus provisioning service can be found here: https://docs.software-univention.de/nubus-kubernetes-architecture/0.5/en/components/provisioning-service.html
|
||||||
|
|
||||||
|
## UDM Simple API
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Name | UDM Simple API |
|
||||||
|
| ------------------------------ | ----------------------------------------------------------------- |
|
||||||
|
| Purpose | Allows to use capability and objects directly in Python programs. |
|
||||||
|
| Versioning | |
|
||||||
|
| Authentication | |
|
||||||
|
| In openDesk provided by | Univention Directory Manager |
|
||||||
|
| Transport protocol | |
|
||||||
|
| Usage within component | |
|
||||||
|
| Usage within openDesk | |
|
||||||
|
| Usage for external integration | |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | Depends on the integration use case. |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | |
|
||||||
|
|
||||||
|
## UDM REST API
|
||||||
|
|
||||||
|
| Name | UDM REST API |
|
||||||
|
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| Purpose | Inspect, modify, create and delete objects through HTTP requests. |
|
||||||
|
| Versioning | |
|
||||||
|
| Authentication | Basic Auth |
|
||||||
|
| In openDesk provided by | Univention Directory Manager |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | The Nubus bootstrapping makes use of the API. |
|
||||||
|
| Usage within openDesk | |
|
||||||
|
| Usage for external integration | The [openDesk User Importer](https://gitlab.opencode.de/bmi/opendesk/components/platform-development/images/user-import) utilizes the API. |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | Depends on the integration use case. |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://docs.software-univention.de/developer-reference/5.0/en/udm/rest-api.html |
|
||||||
|
|
||||||
|
## UCR Python API
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Name | UCR Python API |
|
||||||
|
| ------------------------------ | --------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Offers a programming interface for components and other Python programs. |
|
||||||
|
| Versioning | |
|
||||||
|
| Authentication | |
|
||||||
|
| In openDesk provided by | Nubus |
|
||||||
|
| Transport protocol | |
|
||||||
|
| Usage within component | The Nubus bootstrapping makes use of the API. |
|
||||||
|
| Usage within openDesk | |
|
||||||
|
| Usage for external integration | |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://docs.software-univention.de/developer-reference/5.0/en/ucr/usage.html#using-ucr-from-python |
|
||||||
|
|
||||||
|
## LDAP
|
||||||
|
|
||||||
|
| Name | LDAP |
|
||||||
|
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Read access to Nubus LDAP |
|
||||||
|
| Versioning | n/a |
|
||||||
|
| Authentication | LDAP user auth |
|
||||||
|
| In openDesk provided by | Nubus openLDAP |
|
||||||
|
| Transport protocol | LDAP |
|
||||||
|
| Usage within component | Data backend for Nubus |
|
||||||
|
| Usage within openDesk | Used by multiple application to access user/group data, e.g. Nextcloud Server, OpenProject, OX AppSuite backend, XWiki |
|
||||||
|
| Usage for external integration | No recommended |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | LDAP |
|
||||||
|
| Supported standards | LDAP |
|
||||||
|
| Documentation | https://docs.software-univention.de/manual/5.0/en/domain-ldap/ldap-directory.html |
|
||||||
|
|
||||||
|
## Nubus Provisioning Service (**TBD**)
|
||||||
|
|
||||||
|
To be delivered.
|
||||||
|
|
||||||
|
## Nubus Authorization Service (**TBD**)
|
||||||
|
|
||||||
|
To be delivered.
|
||||||
|
|
||||||
|
# Groupware - OX AppSuite / OX Dovecot
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Usage of APIs within openDesk
|
||||||
|
|
||||||
|
Following are APIs used by the Groupware application:
|
||||||
|
|
||||||
|
| Used by | Accessed component | Service | Purpose | Message format |
|
||||||
|
| ------------------------------ | ------------------ | ------------------ | ----------------------------------------------------------- | -------------------------------- |
|
||||||
|
| AppSuite Middleware | Keycloak | Authentication | Single sign-on / sign-out | OIDC |
|
||||||
|
| Dovecot | Keycloak | Authentication | Authenticate user | OIDC |
|
||||||
|
| AppSuite Frontend (in Browser) | Intercom Service | Silent Login | Stablish Intercom Service session | |
|
||||||
|
| AppSuite Frontend (in Browser) | Intercom Service | Central Navigation | Retrieve content for openDesk Navigation drop-down | JSON |
|
||||||
|
| AppSuite Frontend (in Browser) | Intercom Service | Element Bot | Manage (CUD) meetings in Element | Custom JSON (based on iCalender) |
|
||||||
|
| AppSuite Frontend (in Browser) | Intercom Service | Filepicker | Read/write contents from/to Nextcloud or create share links | WebDAV & Nextcloud API |
|
||||||
|
| AppSuite Middleware | Nextcloud | Filepicker | Read/write files from/to Nextcloud | WebDAV & Nextcloud API |
|
||||||
|
| AppSuite Middleware | Element Bot | Element Bot | Update/delete meetings in Element | Custom JSON (based on iCalender) |
|
||||||
|
| AppSuite Middleware | LDAP | Address book | Search for global contacts and retrieve contact details | LDAP |
|
||||||
|
| Dovecot | LDAP | Data retrieval | Retrieve necessary user details to handle mailboxes | LDAP |
|
||||||
|
|
||||||
|
## HTTP API
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
| Name | HTTP API |
|
||||||
|
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Login, accessing email, contacts, calendar, tasks, configs, email filtering, task automation, workflow automation, etc – most of the AppSuite's functionality that is available to the user through the Web-UI. |
|
||||||
|
| Versioning | No API-specific versioning. The version can be considered identical with OX App Suite version, which is contained in URL of online documentation of API. |
|
||||||
|
| Authentication | |
|
||||||
|
| In openDesk provided by | OX AppSuite Middleware |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | Used by OX Web-UI (Frontend) |
|
||||||
|
| Usage within openDesk | - Nextcloud used the SearchAPI to synchronize contacts<br>- Nordeck Meeting bot synchronizes OX meeting changes applied in Element. |
|
||||||
|
| Usage for external integration | Not used at the moment, but recommended way to integrate with OX AppSuite. |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | JSON based, AppSuite specific format |
|
||||||
|
| Supported standards | iCal, defined by RFC, fully implemented |
|
||||||
|
| Documentation | https://documentation.open-xchange.com/components/middleware/http/8/index.html |
|
||||||
|
|
||||||
|
## SOAP API
|
||||||
|
|
||||||
|
| Name | SOAP API |
|
||||||
|
| ------------------------------ | -------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Management of users, groups, contexts, resources. |
|
||||||
|
| Versioning | n/a |
|
||||||
|
| Authentication | Basic Auth |
|
||||||
|
| In openDesk provided by | OX AppSuite Middleware |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | OX-Connector synchronizes the state of the objects (users, groups etc.) managed in the LDAP. |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | XML based, exactly following the format of Java RMI. |
|
||||||
|
| Supported standards | SOAP |
|
||||||
|
| Documentation | https://software.open-xchange.com/products/appsuite/doc/SOAP/admin/OX-Admin-SOAP.html |
|
||||||
|
|
||||||
|
> **Note**:
|
||||||
|
> You will find a catalogue of the available services including links to the respective URLs at `/webservices/` within the AppSuite host of your openDesk installation, e.g. https://webmail.myopendesk.tld/webservices/
|
||||||
|
|
||||||
|
## REST API
|
||||||
|
|
||||||
|
| Name | REST API |
|
||||||
|
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Delivers services in following functional groups:<br>- *Admin*: Interface for provisioning and other administrative operations<br>- *Advertisement*: The advertisement module<br>- *Health*: The health-check module<br>- *InternetFreeBusy*: Servlet for requesting free busy data<br>- *Metrics*: The metrics module<br>- *Preliminary*: This module contains preliminary endpoints which can change in the future<br>- *Push*: The push module<br>- *Userfeedback*: The user feedback module |
|
||||||
|
| Versioning | No API-specific versioning. The version can be considered identical with OX App Suite version, which is contained in URL of online documentation of API. |
|
||||||
|
| Authentication | Basic Auth |
|
||||||
|
| In openDesk provided by | OX AppSuite Middleware |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | Push module is used by OX Frontend. |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | - Email Body RFC 822 is used by Push<br>- Prometheus format is used by Metrics API<br>- API iCal format is used by InternetFreeBusy |
|
||||||
|
| Supported standards | SOAP |
|
||||||
|
| Documentation | https://documentation.open-xchange.com/components/middleware/rest/8/index.html |
|
||||||
|
## CardDAV
|
||||||
|
|
||||||
|
| Name | CardDAV |
|
||||||
|
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Designed for rich clients. Synchronization of contact entries in both directions (i.e. as a server and as a client); vCard import and export are available via OX HTTP API |
|
||||||
|
| Versioning | Yes, API version is specific to the version of underlying protocol |
|
||||||
|
| Authentication | |
|
||||||
|
| In openDesk provided by | OX AppSuite Middleware |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | vCard, defined by RFC, fully implemented |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://documentation.open-xchange.com/8/middleware/miscellaneous/caldav_carddav.html |
|
||||||
|
|
||||||
|
## CalDAV
|
||||||
|
|
||||||
|
| Name | CalDAV |
|
||||||
|
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Designed for rich clients. Synchronization of contact entries in both directions (i.e. as a server and as a client); vCard import and export are available via OX HTTP API |
|
||||||
|
| Versioning | Yes, API version is specific to the version of underlying protocol |
|
||||||
|
| Authentication | |
|
||||||
|
| In openDesk provided by | OX AppSuite Middleware |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | iCal, defined by RFC, fully implemented |
|
||||||
|
| Supported standards | iTIP, iMIP |
|
||||||
|
| Documentation | https://documentation.open-xchange.com/8/middleware/miscellaneous/caldav_carddav.html |
|
||||||
|
|
||||||
|
## IMAP
|
||||||
|
|
||||||
|
| Name | IMAP |
|
||||||
|
| ------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| Purpose | Used for retrieval of emails, designed for rich clients |
|
||||||
|
| Versioning | Yes, API version is specific to the version of underlying protocol |
|
||||||
|
| Authentication | |
|
||||||
|
| In openDesk provided by | OX Dovecot |
|
||||||
|
| Transport protocol | TCP |
|
||||||
|
| Usage within component | Used by OX AppSuite middleware to read/write mail and folders |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | Can be used by local IMAP clients (e.g. Thunderbird) |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | RFC 9051 |
|
||||||
|
| Supported standards | IMAP |
|
||||||
|
| Documentation | https://www.rfc-editor.org/rfc/rfc9051 |
|
||||||
|
|
||||||
|
## POP3
|
||||||
|
|
||||||
|
| Name | POP3 |
|
||||||
|
| ------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| Purpose | Used for retrieval of emails, designed for rich clients |
|
||||||
|
| Versioning | Yes, API version is specific to the version of underlying protocol |
|
||||||
|
| Authentication | |
|
||||||
|
| In openDesk provided by | OX Dovecot |
|
||||||
|
| Transport protocol | TCP |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | Can be used by local POP3 clients (e.g. Thunderbird) |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | RFC 1939 |
|
||||||
|
| Supported standards | IMAP |
|
||||||
|
| Documentation | https://www.rfc-editor.org/rfc/rfc1939 |
|
||||||
|
|
||||||
|
# Files - Nextcloud
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Usage of APIs within openDesk
|
||||||
|
|
||||||
|
Following are APIs used by the Files application:
|
||||||
|
|
||||||
|
| Used by | Accessed component | Service | Purpose | Message format |
|
||||||
|
| ---------------- | ---------------------- | ---------------------- | -------------------------------------------------- | -------------- |
|
||||||
|
| Nextcloud Server | Keycloak | Authentication | Single sign-on / sign-out | OIDC |
|
||||||
|
| Nextcloud Server | Nubus Portal | Central Navigation | Retrieve content for openDesk Navigation drop-down | JSON |
|
||||||
|
| Nextcloud Server | OX AppSuite Middleware | OX HTTP API (Contacts) | Reading/writing personal contacts | JSON |
|
||||||
|
| Nextcloud Server | Nubus | LDAP | Read users and groups data | LDAP |
|
||||||
|
|
||||||
|
## OCS API
|
||||||
|
|
||||||
|
| Name | OCS API |
|
||||||
|
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Obtain and/or manage user status, user preferences, shares, sharees, recommendations. API is likely to be extended to other use cases in the future. Nextcloud apps can extend the functionality of OCS API by providing new endpoints |
|
||||||
|
| Versioning | Identical with component release version |
|
||||||
|
| Authentication | Basic Auth or by passing a set of valid session cookies |
|
||||||
|
| In openDesk provided by | Nextcloud Server |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | Filepicker is using the API to create share links. |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | Requests in JSON, responses in JSON or XML |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/index.html |
|
||||||
|
|
||||||
|
## Notifications API
|
||||||
|
|
||||||
|
| Name | Notifications API |
|
||||||
|
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Fetch notifications |
|
||||||
|
| Versioning | See linked documentation (which also names the version), address via URL path, e.g. `/ocs/v2.php/apps/notifications/api/v2` |
|
||||||
|
| Authentication | |
|
||||||
|
| In openDesk provided by | Nextcloud Server |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | Requests in JSON, responses in JSON or XML |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://github.com/nextcloud/notifications/blob/master/docs/ocs-endpoint-v2.md |
|
||||||
|
| | |
|
||||||
|
|
||||||
|
## Activity API
|
||||||
|
|
||||||
|
| Name | Activity API |
|
||||||
|
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| Purpose | Allows to obtain the list of actions initiated or involving a specific user (files created, shared, deleted etc and other activities reported by apps) |
|
||||||
|
| Versioning | Identical with component release version |
|
||||||
|
| Authentication | See linked documentation (which also names the version), address via URL path, e.g. `/ocs/v2.php/apps/activity/api/v2` |
|
||||||
|
| In openDesk provided by | Nextcloud Server |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | Requests in JSON, responses in JSON or XML |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://github.com/nextcloud/activity/blob/master/docs/endpoint-v2.md |
|
||||||
|
|
||||||
|
## Remote wipe API
|
||||||
|
|
||||||
|
| Name | Remote wipe API |
|
||||||
|
| ------------------------------ | ------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Used to wipe storage remotely (e.g. on a lost device) |
|
||||||
|
| Versioning | Identical with component release version |
|
||||||
|
| Authentication | Login flow token |
|
||||||
|
| In openDesk provided by | Nextcloud Server |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | JSON |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://docs.nextcloud.com/server/latest/developer_manual/client_apis/RemoteWipe/index.html |
|
||||||
|
|
||||||
|
## WebDAV
|
||||||
|
|
||||||
|
| Name | WebDAV |
|
||||||
|
| ------------------------------ | --------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Accessing files and folders, conducting search |
|
||||||
|
| Versioning | Identical with component release version |
|
||||||
|
| Authentication | Basic Auth or by passing a set of valid session cookies |
|
||||||
|
| In openDesk provided by | Nextcloud Server |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | Used by OX AppSuite to put/retrieve files (attachments) |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | Requests in JSON, responses in JSON or XML |
|
||||||
|
| Supported standards | RFC4918 |
|
||||||
|
| Documentation | https://docs.nextcloud.com/server/latest/developer_manual/client_apis/WebDAV/index.html |
|
||||||
|
|
||||||
|
## CalDAV / CardDAV
|
||||||
|
|
||||||
|
CalDAV and CardDAV APIs are available in Nextcloud, but as openDesk uses OX AppSuite for Calendar and Contacts these Nextcloud APIs do not provide relevant data in openDesk.
|
||||||
|
|
||||||
|
# Weboffice - Collabora
|
||||||
|
|
||||||
|
Following are APIs used by the Weboffice application:
|
||||||
|
|
||||||
|
| Used by | Accessed component | Service | Purpose | Message format |
|
||||||
|
| --------- | ------------------ | ----------------- | ------------------------------------------- | -------------- |
|
||||||
|
| Collabora | Nextcloud | Document handling | Retrieve, store and manage office documents | WOPI |
|
||||||
|
|
||||||
|
Collabora is integrated with Nextcloud to read/write Office documents from/to Nextcloud. The integration uses the Web
|
||||||
|
Application Open Interface ([WOPI](https://learn.microsoft.com/en-us/openspecs/office_protocols/ms-wopi/6a8bb410-68ad-47e4-9dc3-6cf29c6b046b)) protocol.
|
||||||
|
|
||||||
|
Nextcloud acts as the WOPI server whereas Collabora Online is the WOPI client.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
sequenceDiagram
|
||||||
|
autonumber
|
||||||
|
Browser->>Nextcloud: Open document "digital-strategy.odt"<br>(which is fileid=123456)
|
||||||
|
Nextcloud-->>Browser: "Use COOL server to open document online<br>URL is https://office.domain.tld/?open"
|
||||||
|
Browser->>Collabora: GET "https://office.domain.tld/?open&file=https://files.domain.tld/index.php/apps/richdocuments/wopi/files/123456"
|
||||||
|
Collabora-->>Nextcloud: GET https://files.domain.tld/index.php/apps/richdocuments/wopi/files
|
||||||
|
Nextcloud-->>Browser: Edit document "digital-strategy.odt" (fileid=123456)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## PostMessage API
|
||||||
|
|
||||||
|
| Name | PostMessage API |
|
||||||
|
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Interact with parent frame when Collabora browser part is enclosed in one, mostly based on WOPI specification with few extensions/modifications |
|
||||||
|
| Versioning | N/A |
|
||||||
|
| Authentication | CSP rules protect unauthorized communication. In practice editor is embedded in an iframe and can communicate only with the iframe's parent. |
|
||||||
|
| In openDesk provided by | Collabora |
|
||||||
|
| Transport protocol | HTTP |
|
||||||
|
| Usage within component | N/A |
|
||||||
|
| Usage within openDesk | Query number of users in a document, query supported export formats, manage sessions, manage actions like save, insert image, print etc. |
|
||||||
|
| Usage for external integration | In openDesk Collabora Online is integrated with Nextcloud but other integrations exist and are possible, see the documentation. |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | JSON |
|
||||||
|
| Supported standards | [WOPI](https://learn.microsoft.com/en-us/openspecs/office_protocols/ms-wopi/6a8bb410-68ad-47e4-9dc3-6cf29c6b046b) |
|
||||||
|
| Documentation | https://sdk.collaboraonline.com/docs/postmessage_api.html |
|
||||||
|
|
||||||
|
## Conversion API
|
||||||
|
|
||||||
|
| Name | Conversion API |
|
||||||
|
| ------------------------------ | ------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Convert files between various file formats (e.g. to pdf, png, txt, or between OOXML and ODF etc.) |
|
||||||
|
| Versioning | N/A |
|
||||||
|
| Authentication | The `convert-to` endpoint is restricted to allowed host addresses that can be set in the configuration. |
|
||||||
|
| In openDesk provided by | Collabora |
|
||||||
|
| Transport protocol | HTTP (REST API) |
|
||||||
|
| Usage within component | N/A |
|
||||||
|
| Usage within openDesk | To generate thumbnails in Nextcloud for supported document types. |
|
||||||
|
| Usage for external integration | It is possible to set up Collabora Online as a general document converter service. |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | text based, see the documentation |
|
||||||
|
| Supported standards | N/A |
|
||||||
|
| Documentation | https://sdk.collaboraonline.com/docs/conversion_api.html |
|
||||||
|
|
||||||
|
# Project management - OpenProject
|
||||||
|
|
||||||
|
Following are APIs used by the Project management application:
|
||||||
|
|
||||||
|
| Used by | Accessed component | Service | Purpose | Message format |
|
||||||
|
| --------------- | ------------------ | ------------------ | -------------------------------------------------- | -------------- |
|
||||||
|
| OpenProject-web | Keycloak | Authentication | Single sign-on / sign-out | OIDC |
|
||||||
|
| OpenProject-web | Nubus Portal | Central Navigation | Retrieve content for openDesk Navigation drop-down | JSON |
|
||||||
|
| OpenProject-web | Nextcloud | Various | Integration of Nextcloud as OpenProject filestore | JSON |
|
||||||
|
| OpenProject-web | Nubus | LDAP | Read users and groups data | LDAP |
|
||||||
|
|
||||||
|
## HATEOAS API
|
||||||
|
|
||||||
|
| Name | HATEOAS (Hyperimages as the Engine of Application State) API |
|
||||||
|
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Provides access for the frontend client of OpenProject and for third party use, i.e.:<br>- CRUD work packages, projects, time logging, users, queries (work package filters), and all related objects<br>- READ notifications, activities per work package<br>- READ capabilities (allowed actions of users throughout projects) does not address |
|
||||||
|
| Versioning | URL based versioning scheme, e.g. `/api/v3/spec.json` |
|
||||||
|
| Authentication | OAuth2, session based authentication, and basic auth |
|
||||||
|
| In openDesk provided by | OpenProject |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | OpenProject Web-UI |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | [HAL](https://en.wikipedia.org/wiki/Hypertext_Application_Language) + JSON |
|
||||||
|
| Supported standards | REST, [HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) |
|
||||||
|
| Documentation | https://www.openproject.org/docs/api/introduction/ |
|
||||||
|
|
||||||
|
**Additional Information:**
|
||||||
|
|
||||||
|
*What does it not do that developers should know about?*
|
||||||
|
- CRUD custom fields, time reports, wikis and wiki pages
|
||||||
|
- Aggregated filterable activities/changes
|
||||||
|
|
||||||
|
*What are the typical use cases?*
|
||||||
|
- It powers all angular frontend components in OpenProject, mainly the work package table/view, boards, team planner etc., and supports all common use cases
|
||||||
|
|
||||||
|
*How does it work? (What do users need to know about architecture an internal components?)*
|
||||||
|
- HAL is a standard to define resources with embedding and links between them
|
||||||
|
- HAL contains action links depending on the user’s permissions, allows to derive allowed actions from object keys in json
|
||||||
|
|
||||||
|
*What knowledge prerequisites for the developer before using the API?*
|
||||||
|
- Knowledge of REST
|
||||||
|
- (Optional) Knowledge of HAL standard
|
||||||
|
|
||||||
|
*Any extensions or APIs in development or in planning users should know about?*
|
||||||
|
- Signaling to receive only selected attributes/nested resources from the API for performance improvements
|
||||||
|
|
||||||
|
## BCF API
|
||||||
|
|
||||||
|
| Name | BCF API |
|
||||||
|
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Implementation of subset of [BCF](https://en.wikipedia.org/wiki/BIM_Collaboration_Format) standard for [BIM](https://en.wikipedia.org/wiki/Building_information_modeling) projects |
|
||||||
|
| Versioning | URL based versioning scheme, e.g. `/api/bcf/2.1` |
|
||||||
|
| Authentication | OAuth2 |
|
||||||
|
| In openDesk provided by | OpenProject |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | JSON |
|
||||||
|
| Supported standards | [BCF 2.1](https://github.com/buildingSMART/BCF-API/blob/release_2_1/README.md) |
|
||||||
|
| Documentation | https://www.openproject.org/docs/api/bcf-rest-api/ |
|
||||||
|
|
||||||
|
# Video Conferencing - Jitsi
|
||||||
|
|
||||||
|
## IFrame API
|
||||||
|
|
||||||
|
| Name | IFrame API |
|
||||||
|
| ------------------------------ | ---------------------------------------------------------------------- |
|
||||||
|
| Purpose | Embed Jitsi video conferencing features into existing application/site |
|
||||||
|
| Versioning | Identical to the Jitsi release version |
|
||||||
|
| Authentication | Optional (JWT-based authentication in openDesk context) |
|
||||||
|
| In openDesk provided by | Jitsi-Web |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | Used by Element (Chat Web-UI) |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe/ |
|
||||||
|
|
||||||
|
## lib-jitsi-meet API
|
||||||
|
|
||||||
|
| Name | lib-jitsi-meet API |
|
||||||
|
| ------------------------------ | ---------------------------------------------------------------------- |
|
||||||
|
| Purpose | Create Jitsi video conferences with a custom GUI |
|
||||||
|
| Versioning | Identical to the Jitsi release |
|
||||||
|
| Authentication | not required |
|
||||||
|
| In openDesk provided by | Jitsi-Web |
|
||||||
|
| Transport protocol | none (it works as a library) |
|
||||||
|
| Usage within component | Used by Jitsi itself |
|
||||||
|
| Usage within openDesk | Used by Jitsi itself |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ljm-api/ |
|
||||||
|
|
||||||
|
## Jitsi Meet React SDK
|
||||||
|
|
||||||
|
> **Note**<br>
|
||||||
|
> Additional SDKs can be found at https://jitsi.github.io/handbook/docs/category/sdks/
|
||||||
|
|
||||||
|
| Name | Meet React SDK |
|
||||||
|
| ------------------------------ | ------------------------------------------------------------------- |
|
||||||
|
| Purpose | Embed Jitsi video conferencing into apps using React |
|
||||||
|
| Versioning | https://github.com/jitsi/jitsi-meet-react-sdk/releases |
|
||||||
|
| Authentication | not required |
|
||||||
|
| In openDesk provided by | Jitsi |
|
||||||
|
| Transport protocol | none (it works as a module) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-react-sdk |
|
||||||
|
|
||||||
|
# Chat - Element
|
||||||
|
|
||||||
|
While Jitsi is available as standalone videoconferencing in openDesk, it is also used in [Element as videoconferencing backend](https://github.com/element-hq/element-web/blob/develop/docs/jitsi.md).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Following are APIs used by the Chat application:
|
||||||
|
|
||||||
|
| Used by | Accessed component | Service | Purpose | Message format |
|
||||||
|
| --------------- | ------------------ | ------------------ | -------------------------------------------------- | -------------- |
|
||||||
|
| Element/Synapse | Keycloak | Authentication | Single sign-on / sign-out | OIDC |
|
||||||
|
| OpenProject-web | Intercom Service | Central Navigation | Retrieve content for openDesk Navigation drop-down | JSON |
|
||||||
|
|
||||||
|
## Matrix Application Service API
|
||||||
|
|
||||||
|
| Name | Matrix Application Service API |
|
||||||
|
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Implementation of custom server-side behavior in Matrix (e.g. gateways, filters, extensible hooks) |
|
||||||
|
| Versioning | URL based with version bumps on breaking changes (e.g. `/_matrix/app/v1`) |
|
||||||
|
| Authentication | HTTP-Authorization header with Bearer token |
|
||||||
|
| In openDesk provided by | Synapse |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | Nordeck Widgets |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | JSON |
|
||||||
|
| Supported standards | [Matrix](https://spec.matrix.org/latest/application-service-api/) |
|
||||||
|
| Documentation | [Synapse](https://element-hq.github.io/synapse/latest/) is the reference implementation of the Matrix protocol, see standard for API details |
|
||||||
|
|
||||||
|
## Matrix Client-Server API
|
||||||
|
|
||||||
|
| Name | Matrix Client-Server API |
|
||||||
|
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Send messages, control rooms and synchronize conversation history, JSON objects over HTTP |
|
||||||
|
| Versioning | URL based with version bumps on breaking changes (e.g. `/_matrix/client/v3`) |
|
||||||
|
| Authentication | HTTP-Authorization header with Bearer token |
|
||||||
|
| In openDesk provided by | Synapse |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | Used by Element (Chat Web-UI) |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | JSON |
|
||||||
|
| Supported standards | [Matrix](https://spec.matrix.org/latest/client-server-api/) |
|
||||||
|
| Documentation | [Synapse](https://element-hq.github.io/synapse/latest/) is the reference implementation of the Matrix protocol, see standard for API details |
|
||||||
|
|
||||||
|
## Matrix Server-Server API
|
||||||
|
|
||||||
|
| Name | Matrix Server-Server API |
|
||||||
|
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Communication between Matrix server (also known as FederationAPIs) |
|
||||||
|
| Versioning | URL based with version bumps on breaking changes (e.g. `/_matrix/federation/v2`) |
|
||||||
|
| Authentication | HTTP-Authorization header with Bearer token |
|
||||||
|
| In openDesk provided by | Synapse |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | Used when federation with other Matrix instances is enabled |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | JSON |
|
||||||
|
| Supported standards | [Matrix](https://spec.matrix.org/latest/client-server-api/) |
|
||||||
|
| Documentation | [Synapse](https://element-hq.github.io/synapse/latest/) is the reference implementation of the Matrix protocol, see standard for API details |
|
||||||
|
|
||||||
|
## Matrix Push Gateway API
|
||||||
|
|
||||||
|
| Name | Matrix Push Gateway API |
|
||||||
|
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Distribute notifications from the homeserver to clients (push) |
|
||||||
|
| Versioning | URL based with version bumps on breaking changes (e.g. `/_matrix/push/v2`) |
|
||||||
|
| Authentication | |
|
||||||
|
| In openDesk provided by | Synapse |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | Used by Element (Chat Web-UI) |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | JSON |
|
||||||
|
| Supported standards | [Matrix](https://spec.matrix.org/latest/push-gateway-api/) |
|
||||||
|
| Documentation | [Synapse](https://element-hq.github.io/synapse/latest/) is the reference implementation of the Matrix protocol, see standard for API details |
|
||||||
|
|
||||||
|
## Matrix Identity Service API
|
||||||
|
|
||||||
|
| Name | Matrix Identity Service API |
|
||||||
|
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Validate, store, and answer questions about the identities of users |
|
||||||
|
| Versioning | URL based with version bumps on breaking changes (e.g. `/_matrix/identity/v2`) |
|
||||||
|
| Authentication | HTTP-Authorization header with Bearer token |
|
||||||
|
| In openDesk provided by | Synapse |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | none |
|
||||||
|
| Usage within openDesk | |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | JSON |
|
||||||
|
| Supported standards | [Matrix](https://spec.matrix.org/latest/identity-service-api/) |
|
||||||
|
| Documentation | [Synapse](https://element-hq.github.io/synapse/latest/) is the reference implementation of the Matrix protocol, see standard for API details |
|
||||||
|
|
||||||
|
# Knowledge management - XWiki
|
||||||
|
|
||||||
|
Following are APIs used by the Knowledge management application:
|
||||||
|
|
||||||
|
| Used by | Accessed component | Service | Purpose | Message format |
|
||||||
|
| ------- | ------------------ | ------------------ | -------------------------------------------------- | -------------- |
|
||||||
|
| Xwiki | Keycloak | Authentication | Single sign-on / sign-out | OIDC |
|
||||||
|
| Xwiki | Nubus Portal | Central Navigation | Retrieve content for openDesk Navigation drop-down | JSON |
|
||||||
|
| Xwiki | Nubus | LDAP | Read users and groups data | LDAP |
|
||||||
|
|
||||||
|
## REST API
|
||||||
|
|
||||||
|
| Name | REST API |
|
||||||
|
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Perform low level action, e.g. interact with XWiki stored data |
|
||||||
|
| Versioning | |
|
||||||
|
| Authentication | Anonymous or username/password on each request (stateless) |
|
||||||
|
| In openDesk provided by | XWiki |
|
||||||
|
| Transport protocol | HTTP(S) |
|
||||||
|
| Usage within component | |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | JSON/XML |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | - https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiRESTfulAPI<br>- https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-rest/xwiki-platform-rest-model/src/main/resources/xwiki.rest.model.xsd |
|
||||||
|
|
||||||
|
## Scripting API
|
||||||
|
|
||||||
|
| Name | Scripting API |
|
||||||
|
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Feature-rich API to access any module, use any functionality, modify existing functionality; allows definition of new REST API endpoints - API scope is identical to Java API |
|
||||||
|
| Versioning | |
|
||||||
|
| Authentication | Executed in context of (authenticated) user or anonymous - permissions (scripting rights, programming rights) of that context apply |
|
||||||
|
| In openDesk provided by | XWiki |
|
||||||
|
| Transport protocol | |
|
||||||
|
| Usage within component | |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | Not supported |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://extensions.xwiki.org/xwiki/bin/view/Extension/Scripting%20Documentation%20Application |
|
||||||
|
|
||||||
|
## Java API
|
||||||
|
|
||||||
|
| Name | Java API |
|
||||||
|
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Feature-rich API to access any module, use any functionality, modify existing functionality; allows definition of new REST API endpoints - API scope is identical to Scripting API |
|
||||||
|
| Versioning | |
|
||||||
|
| Authentication | Executed in context of (authenticated) user or anonymous - but without the permission check (in opposite to the Scripting API) |
|
||||||
|
| In openDesk provided by | XWiki |
|
||||||
|
| Transport protocol | |
|
||||||
|
| Usage within component | |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/API/ |
|
||||||
|
|
||||||
|
## JavaScript API
|
||||||
|
|
||||||
|
| Name | Javascript API |
|
||||||
|
| ------------------------------ | -------------------------------------------------------------------------------------------- |
|
||||||
|
| Purpose | Include dynamic components in XWiki/web pages |
|
||||||
|
| Versioning | |
|
||||||
|
| Authentication | Executed in context of (authenticated) user or anonymous |
|
||||||
|
| In openDesk provided by | Jitsi |
|
||||||
|
| Transport protocol | |
|
||||||
|
| Usage within component | |
|
||||||
|
| Usage within openDesk | none |
|
||||||
|
| Usage for external integration | none |
|
||||||
|
| Parallel access | Allowed |
|
||||||
|
| Message protocol | |
|
||||||
|
| Supported standards | |
|
||||||
|
| Documentation | https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/FrontendResources/JavaScriptAPI/ |
|
||||||
BIN
docs/architecture/apis_images/ChatVC-overview.png
Normal file
BIN
docs/architecture/apis_images/ChatVC-overview.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
BIN
docs/architecture/apis_images/Files-api.png
Normal file
BIN
docs/architecture/apis_images/Files-api.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 69 KiB |
BIN
docs/architecture/apis_images/Groupware-api-http-usage.png
Normal file
BIN
docs/architecture/apis_images/Groupware-api-http-usage.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
BIN
docs/architecture/apis_images/Groupware-api-usage.png
Normal file
BIN
docs/architecture/apis_images/Groupware-api-usage.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 39 KiB |
BIN
docs/architecture/apis_images/Groupware-api.png
Normal file
BIN
docs/architecture/apis_images/Groupware-api.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
BIN
docs/architecture/apis_images/IAM-ics-api-use.png
Normal file
BIN
docs/architecture/apis_images/IAM-ics-api-use.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
BIN
docs/architecture/apis_images/IAM-overview.png
Normal file
BIN
docs/architecture/apis_images/IAM-overview.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 76 KiB |
BIN
docs/architecture/apis_images/IAM-ucr.png
Normal file
BIN
docs/architecture/apis_images/IAM-ucr.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
BIN
docs/architecture/apis_images/IAM-udm.png
Normal file
BIN
docs/architecture/apis_images/IAM-udm.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
BIN
docs/architecture/apis_images/IAM-umc-architecture.png
Normal file
BIN
docs/architecture/apis_images/IAM-umc-architecture.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
@@ -1,189 +0,0 @@
|
|||||||
<!--
|
|
||||||
SPDX-FileCopyrightText: 2023 Bundesministerium des Innern und für Heimat, PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
|
|
||||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
|
||||||
SPDX-License-Identifier: Apache-2.0
|
|
||||||
-->
|
|
||||||
|
|
||||||
<h1>Components</h1>
|
|
||||||
|
|
||||||
This section covers the internal system requirements and external service requirements for productive use.
|
|
||||||
|
|
||||||
<!-- TOC -->
|
|
||||||
* [Overview](#overview)
|
|
||||||
* [Component integration](#component-integration)
|
|
||||||
* [Intercom Service / Silent Login](#intercom-service--silent-login)
|
|
||||||
* [Filepicker](#filepicker)
|
|
||||||
* [Central Navigation](#central-navigation)
|
|
||||||
* [Central Contacts](#central-contacts)
|
|
||||||
* [File Store (OpenProject -\> Nextcloud)](#file-store-openproject---nextcloud)
|
|
||||||
* [Identity data flows](#identity-data-flows)
|
|
||||||
* [Provisioning](#provisioning)
|
|
||||||
<!-- TOC -->
|
|
||||||
|
|
||||||
# Overview
|
|
||||||
|
|
||||||
openDesk consists of a variety of open-source projects. Here is a list with the description and type.
|
|
||||||
|
|
||||||
Components of type `Eval` are used for development and evaluation purposes only,
|
|
||||||
they need to be replaced in production deployments.
|
|
||||||
|
|
||||||
| Component | Description | Type |
|
|
||||||
| -------------------- | ------------------------------ | ---------- |
|
|
||||||
| Certificates | TLS certificates | Eval |
|
|
||||||
| ClamAV (Distributed) | Antivirus engine | Eval |
|
|
||||||
| ClamAV (Simple) | Antivirus engine | Eval |
|
|
||||||
| Collabora | Weboffice | Functional |
|
|
||||||
| CryptPad | Weboffice | Functional |
|
|
||||||
| dkimpy-milter | DKIM milter for Postfix | Eval |
|
|
||||||
| Element | Secure communications platform | Functional |
|
|
||||||
| Jitsi | Videoconferencing | Functional |
|
|
||||||
| MariaDB | Database | Eval |
|
|
||||||
| Memcached | Cache Database | Eval |
|
|
||||||
| MinIO | Object Storage | Eval |
|
|
||||||
| Nextcloud | File share | Functional |
|
|
||||||
| Nubus (UMS) | Identity Management & Portal | Functional |
|
|
||||||
| OpenProject | Project management | Functional |
|
|
||||||
| OX App Suite | Groupware | Functional |
|
|
||||||
| OX Dovecot | Mail backend (IMAP) | Functional |
|
|
||||||
| Postfix | MTA | Eval |
|
|
||||||
| PostgreSQL | Database | Eval |
|
|
||||||
| Redis | Cache Database | Eval |
|
|
||||||
| XWiki | Knowledge Management | Functional |
|
|
||||||
|
|
||||||
# Component integration
|
|
||||||
|
|
||||||
Some use cases require inter-component integration.
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
flowchart TD
|
|
||||||
OX-AppSuite_Frontend-->|Silent Login, Filepicker, Central Navigation|Intercom_Service
|
|
||||||
Element-->|Silent Login, Central Navigation|Intercom_Service
|
|
||||||
Intercom_Service-->|Silent Login, Token Exchange|IdP
|
|
||||||
Intercom_Service-->|Filepicker|Nextcloud
|
|
||||||
Intercom_Service-->|Central Navigation|Portal
|
|
||||||
OX-AppSuite_Backend-->|Filepicker|Nextcloud
|
|
||||||
Nextcloud-->|Central Navigation|Portal
|
|
||||||
OpenProject-->|Central Navigation|Portal
|
|
||||||
OpenProject-->|File Store|Nextcloud
|
|
||||||
XWiki-->|Central Navigation|Portal
|
|
||||||
Nextcloud-->|Central Contacts|OX-AppSuite_Backend
|
|
||||||
OX-AppSuite_Frontend-->|Filepicker|OX-AppSuite_Backend
|
|
||||||
```
|
|
||||||
|
|
||||||
Most details can be found in the upstream documentation that is linked in the respective sections.
|
|
||||||
|
|
||||||
## Intercom Service / Silent Login
|
|
||||||
|
|
||||||
The Intercom Service is deployed in the context of Nubus/UMS. Its role is to enable cross-application integration
|
|
||||||
based on the user's browser interaction as handling authentication when the frontend of an application has to call
|
|
||||||
the API from another application is often a challenge.
|
|
||||||
|
|
||||||
To establish a session with the Intercom Service, applications can use the silent login feature within an iframe.
|
|
||||||
|
|
||||||
Currently, only OX AppSuite and Element are using the frontend-based integration.
|
|
||||||
|
|
||||||
**Links**
|
|
||||||
- [Intercom Service upstream documentation](https://docs.software-univention.de/intercom-service/latest/index.html).
|
|
||||||
|
|
||||||
## Filepicker
|
|
||||||
|
|
||||||
The Nextcloud Filepicker is integrated into the OX AppSuite, supporting the following use cases against the respective openDesk instance's Nextcloud:
|
|
||||||
- Attach files from Nextcloud to emails.
|
|
||||||
- Create and add links to Nextcloud files into emails.
|
|
||||||
- Save attachments from emails into Nextcloud.
|
|
||||||
- Attach files from Nextcloud to calendar entries.
|
|
||||||
|
|
||||||
The Filepicker uses frontend and backend-based integration:
|
|
||||||
- For frontend-based integration, the OX AppSuite frontend uses the Intercom Service.
|
|
||||||
- Backend-based integration is coming from OX AppSuite middleware. The middleware communicates directly with Nextcloud
|
|
||||||
when adding a file to an email or storing a file into Nextcloud to avoid passing these files through the user's browser.
|
|
||||||
|
|
||||||
**Links**
|
|
||||||
- [OX AppSuite Nextcloud Integration upstream documentation](https://gitlab.open-xchange.com/extensions/nextcloud-integration/-/tree/main/documentation).
|
|
||||||
|
|
||||||
## Central Navigation
|
|
||||||
|
|
||||||
Central navigation is based on an API endpoint in the Nubus portal that returns a JSON containing the portal's contents for
|
|
||||||
a given user. The response from the API endpoint is used in the openDesk applications to render the central navigation.
|
|
||||||
|
|
||||||
The API can be called by
|
|
||||||
- frontend services through the Intercom Service's `/navigation.json` endpoint or
|
|
||||||
- backend services directly at the portal's `/univention/portal/navigation.json` endpoint.
|
|
||||||
|
|
||||||
The central navigation expects the API caller to present a shared secret for authentication and the username for whom the portal
|
|
||||||
contents should be returned for.
|
|
||||||
|
|
||||||
A `curl` based request returning the navigation contents looks like this:
|
|
||||||
|
|
||||||
```
|
|
||||||
curl 'https://portal.<DOMAIN>/univention/portal/navigation.json?base=https%3A//portal.<DOMAIN>&language=de-DE' -u "<USERNAME>:<SHARED_SECRET>"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Central Contacts
|
|
||||||
|
|
||||||
OX App Suite is managing contacts in openDesk. Therefore, Nextcloud's PHP backend is using the OX AppSuite's middleware Contacts API to
|
|
||||||
- create a new contact in the user's contacts folder when a file is shared with an unknown email address.
|
|
||||||
- retrieve contacts from the user's contacts folder to support search-as-you-type when starting to share a file.
|
|
||||||
|
|
||||||
**Links:**
|
|
||||||
- Currently used [OX Contacts API (deprecated)](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Contacts).
|
|
||||||
- New [OX Addressbooks API](https://documentation.open-xchange.com/components/middleware/http/8/index.html#!Addressbooks) the Central Contacts integration will switch to.
|
|
||||||
|
|
||||||
## File Store (OpenProject -> Nextcloud)
|
|
||||||
|
|
||||||
While OpenProject allows you to attach files to work packages directly, it is often preferred that the files are
|
|
||||||
stored within Nextcloud or to link an existing file from your openDesk Nextcloud to a work package.
|
|
||||||
|
|
||||||
Therefore, openDesk pre-configures the trust between the openDesk instance's OpenProject and Nextcloud during the `openproject-boostrap` deployment step. As a prerequisite for that, openDesk's Nextcloud contains the `integration_openproject` app.
|
|
||||||
|
|
||||||
The file store must still be enabled per project in OpenProject's project admin section.
|
|
||||||
|
|
||||||
**Links:**
|
|
||||||
- [OpenProject's documentation on Nextcloud integration](https://www.openproject.org/docs/system-admin-guide/integrations/nextcloud/)
|
|
||||||
- [OpenProject Integration Nextcloud app](https://apps.nextcloud.com/apps/integration_openproject)
|
|
||||||
|
|
||||||
# Identity data flows
|
|
||||||
|
|
||||||
An overview of
|
|
||||||
- components that consume the LDAP service.
|
|
||||||
- The components access the LDAP using a component-specific LDAP search account.
|
|
||||||
- components using Univention Keycloak as an identity provider (IdP).
|
|
||||||
- The components should use OAuth2 / OIDC flows if not otherwise denoted.
|
|
||||||
- All components have a client configured in Keycloak, except for Jitsi, which is using authentication with the
|
|
||||||
[Authorization Code Flow](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth) that does not
|
|
||||||
require an OIDC client to be configured in Keycloak.
|
|
||||||
|
|
||||||
Some components trust others to handle authentication for them.
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
flowchart TD
|
|
||||||
K[IdP]-->L[LDAP]
|
|
||||||
N[Nextcloud]-->L
|
|
||||||
O[OpenProject] --> L
|
|
||||||
A[OX AppSuite]-->L
|
|
||||||
D[OX Dovecot]-->L
|
|
||||||
P[Portal/Admin]-->L
|
|
||||||
X[XWiki]-->L
|
|
||||||
A-->K
|
|
||||||
N-->K
|
|
||||||
D-->K
|
|
||||||
O-->K
|
|
||||||
X-->K
|
|
||||||
P-->|SAML|K
|
|
||||||
E[Element]-->K
|
|
||||||
J[Jitsi]-->K
|
|
||||||
I[IntercomService]-->K
|
|
||||||
C[Collabora]-->N
|
|
||||||
R[CryptPad]-->N
|
|
||||||
F[Postfix]-->D
|
|
||||||
```
|
|
||||||
|
|
||||||
# Provisioning
|
|
||||||
|
|
||||||
Currently, active provisioning is only done for OX AppSuite. The OX-Connector synchronizes the following objects to the OX AppSuite using the AppSuite's SOAP API:
|
|
||||||
|
|
||||||
- Contexts
|
|
||||||
- Users
|
|
||||||
- Groups
|
|
||||||
- Functional Mailboxes
|
|
||||||
- Resources
|
|
||||||
@@ -482,6 +482,7 @@ done
|
|||||||
# Delete leftover resources
|
# Delete leftover resources
|
||||||
kubectl delete pvc --all --namespace ${NAMESPACE};
|
kubectl delete pvc --all --namespace ${NAMESPACE};
|
||||||
kubectl delete jobs --all --namespace ${NAMESPACE};
|
kubectl delete jobs --all --namespace ${NAMESPACE};
|
||||||
|
kubectl delete configmaps --all --namespace ${NAMESPACE};
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Warning**<br>
|
> **Warning**<br>
|
||||||
|
|||||||
Reference in New Issue
Block a user