chore(docs): Update ToC across MD files and document Nubus version bump in README.md

This commit is contained in:
Thorsten Roßner
2025-03-27 07:43:59 +01:00
parent 04efd54022
commit c37eedba42
8 changed files with 28 additions and 19 deletions

View File

@@ -32,18 +32,18 @@ For production use the [openDesk Enterprise Edition](./README-EE.md) is required
openDesk currently features the following functional main components: openDesk currently features the following functional main components:
| Function | Functional Component | Component<br/>Version | Upstream Documentation | | Function | Functional Component | Component<br/>Version | Upstream Documentation |
| -------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | |----------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| Chat & collaboration | Element ft. Nordeck widgets | [1.11.89](https://github.com/element-hq/element-desktop/releases/tag/v1.11.89) | [For the most recent release](https://element.io/user-guide) | | Chat & collaboration | Element ft. Nordeck widgets | [1.11.89](https://github.com/element-hq/element-desktop/releases/tag/v1.11.89) | [For the most recent release](https://element.io/user-guide) |
| Collaborative notes | Notes (aka Docs) | [2.4.0](https://github.com/suitenumerique/docs/releases/tag/v2.4.0) | Online documentation/welcome document available in installed application | | Collaborative notes | Notes (aka Docs) | [2.4.0](https://github.com/suitenumerique/docs/releases/tag/v2.4.0) | Online documentation/welcome document available in installed application |
| Diagram editor | CryptPad ft. diagrams.net | [2024.9.0](https://github.com/cryptpad/cryptpad/releases/tag/2024.9.0) | [For the most recent release](https://docs.cryptpad.org/en/) | | Diagram editor | CryptPad ft. diagrams.net | [2024.9.0](https://github.com/cryptpad/cryptpad/releases/tag/2024.9.0) | [For the most recent release](https://docs.cryptpad.org/en/) |
| File management | Nextcloud | [30.0.6](https://nextcloud.com/de/changelog/#30-0-6) | [Nextcloud 30](https://docs.nextcloud.com/) | | File management | Nextcloud | [30.0.6](https://nextcloud.com/de/changelog/#30-0-6) | [Nextcloud 30](https://docs.nextcloud.com/) |
| Groupware | OX App Suite | [8.35](https://documentation.open-xchange.com/appsuite/releases/8.35/) | Online documentation available from within the installed application; [Additional resources](https://documentation.open-xchange.com/) | | Groupware | OX App Suite | [8.35](https://documentation.open-xchange.com/appsuite/releases/8.35/) | Online documentation available from within the installed application; [Additional resources](https://documentation.open-xchange.com/) |
| Knowledge management | XWiki | [16.10.5](https://www.xwiki.org/xwiki/bin/view/ReleaseNotes/Data/XWiki/16.10.5/) | [For the most recent release](https://www.xwiki.org/xwiki/bin/view/Documentation) | | Knowledge management | XWiki | [16.10.5](https://www.xwiki.org/xwiki/bin/view/ReleaseNotes/Data/XWiki/16.10.5/) | [For the most recent release](https://www.xwiki.org/xwiki/bin/view/Documentation) |
| Portal & IAM | Nubus | [1.5.1](https://docs.software-univention.de/nubus-kubernetes-release-notes/latest/en/changelog.html) | [Univention's documentation website](https://docs.software-univention.de/n/en/nubus.html) | | Portal & IAM | Nubus | [1.7.0](https://docs.software-univention.de/nubus-kubernetes-release-notes/latest/en/changelog.html#version-1-7-0-2025-02-23) | [Univention's documentation website](https://docs.software-univention.de/n/en/nubus.html) |
| Project management | OpenProject | [15.4.1](https://www.openproject.org/docs/release-notes/15-4-1/) | [For the most recent release](https://www.openproject.org/docs/user-guide/) | | Project management | OpenProject | [15.4.1](https://www.openproject.org/docs/release-notes/15-4-1/) | [For the most recent release](https://www.openproject.org/docs/user-guide/) |
| Videoconferencing | Jitsi | [2.0.9955](https://github.com/jitsi/jitsi-meet/releases/tag/stable%2Fjitsi-meet_9955) | [For the most recent release](https://jitsi.github.io/handbook/docs/category/user-guide/) | | Videoconferencing | Jitsi | [2.0.9955](https://github.com/jitsi/jitsi-meet/releases/tag/stable%2Fjitsi-meet_9955) | [For the most recent release](https://jitsi.github.io/handbook/docs/category/user-guide/) |
| Weboffice | Collabora | [24.04.12.4](https://www.collaboraoffice.com/code-24-04-release-notes/) | Online documentation available from within the installed application; [Additional resources](https://sdk.collaboraonline.com/) | | Weboffice | Collabora | [24.04.12.4](https://www.collaboraoffice.com/code-24-04-release-notes/) | Online documentation available from within the installed application; [Additional resources](https://sdk.collaboraonline.com/) |
While not all components are perfectly shaped for the execution inside containers, one of the project's objectives is to While not all components are perfectly shaped for the execution inside containers, one of the project's objectives is to
align the applications with best practices regarding container design and operations. align the applications with best practices regarding container design and operations.

View File

@@ -7,6 +7,7 @@ SPDX-License-Identifier: Apache-2.0
This chapter presents APIs available in openDesk grouped by applications. This chapter presents APIs available in openDesk grouped by applications.
<!-- TOC -->
* [IAM - Nubus](#iam---nubus) * [IAM - Nubus](#iam---nubus)
* [UMC Python API](#umc-python-api) * [UMC Python API](#umc-python-api)
* [UMC store API](#umc-store-api) * [UMC store API](#umc-store-api)
@@ -43,7 +44,7 @@ This chapter presents APIs available in openDesk grouped by applications.
* [BCF API](#bcf-api) * [BCF API](#bcf-api)
* [Video Conferencing - Jitsi](#video-conferencing---jitsi) * [Video Conferencing - Jitsi](#video-conferencing---jitsi)
* [IFrame API](#iframe-api) * [IFrame API](#iframe-api)
* [Lib-jitsi-meet API](#lib-jitsi-meet-api) * [lib-jitsi-meet API](#lib-jitsi-meet-api)
* [Jitsi Meet React SDK](#jitsi-meet-react-sdk) * [Jitsi Meet React SDK](#jitsi-meet-react-sdk)
* [Chat - Element](#chat---element) * [Chat - Element](#chat---element)
* [Matrix Application Service API](#matrix-application-service-api) * [Matrix Application Service API](#matrix-application-service-api)
@@ -60,6 +61,7 @@ This chapter presents APIs available in openDesk grouped by applications.
* [Scripting API](#scripting-api) * [Scripting API](#scripting-api)
* [Java API](#java-api) * [Java API](#java-api)
* [JavaScript API](#javascript-api) * [JavaScript API](#javascript-api)
<!-- TOC -->
# IAM - Nubus # IAM - Nubus

View File

@@ -6,7 +6,6 @@ SPDX-License-Identifier: Apache-2.0
<h1>Matrix federation</h1> <h1>Matrix federation</h1>
<!-- TOC --> <!-- TOC -->
* [Context](#context)
* [Example configuration](#example-configuration) * [Example configuration](#example-configuration)
* [Disable federation](#disable-federation) * [Disable federation](#disable-federation)
* [Separate Matrix domain](#separate-matrix-domain) * [Separate Matrix domain](#separate-matrix-domain)

View File

@@ -6,7 +6,6 @@ SPDX-License-Identifier: Apache-2.0
<h1>Separate domains for mail and or Matrix </h1> <h1>Separate domains for mail and or Matrix </h1>
<!-- TOC --> <!-- TOC -->
* [Context](#context)
* [Example configuration](#example-configuration) * [Example configuration](#example-configuration)
* [Mail domain](#mail-domain) * [Mail domain](#mail-domain)
* [Matrix domain](#matrix-domain) * [Matrix domain](#matrix-domain)

View File

@@ -7,6 +7,11 @@ SPDX-License-Identifier: Apache-2.0
This document addresses the available functional configuration options of an openDesk deployment. This document addresses the available functional configuration options of an openDesk deployment.
<!-- TOC -->
* [Supported functional configuration](#supported-functional-configuration)
* [Customization of functional options](#customization-of-functional-options)
<!-- TOC -->
## Supported functional configuration ## Supported functional configuration
While the openDesk applications allow a wide range of configuration options, only a small subset of them are supported by openDesk. This subset can be found in [`helmfile/environments/default/functional.yaml.gotmpl`](../helmfile/environments/default/functional.yaml.gotmpl) While the openDesk applications allow a wide range of configuration options, only a small subset of them are supported by openDesk. This subset can be found in [`helmfile/environments/default/functional.yaml.gotmpl`](../helmfile/environments/default/functional.yaml.gotmpl)
@@ -27,4 +32,4 @@ The following categories are available. Each category contains a set of options
In case the options from [`functional.yaml.gotmpl`](../helmfile/environments/default/functional.yaml.gotmpl) are not sufficient, you might want to look into [`customization.yaml.gotmpl`](../helmfile/environments/default/customization.yaml.gotmpl). The customizations give you control over all templating that is being done in openDesk, but be aware it is an unsupported approach, so in case you have a strong need for customizations, please let us know by opening a ticket. We will check if it is a use case that can be supported by implementing it as part of the aforementioned [`functional.yaml.gotmpl`](../helmfile/environments/default/functional.yaml.gotmpl). In case the options from [`functional.yaml.gotmpl`](../helmfile/environments/default/functional.yaml.gotmpl) are not sufficient, you might want to look into [`customization.yaml.gotmpl`](../helmfile/environments/default/customization.yaml.gotmpl). The customizations give you control over all templating that is being done in openDesk, but be aware it is an unsupported approach, so in case you have a strong need for customizations, please let us know by opening a ticket. We will check if it is a use case that can be supported by implementing it as part of the aforementioned [`functional.yaml.gotmpl`](../helmfile/environments/default/functional.yaml.gotmpl).
> **Note<br>** > **Note<br>**
> You can not directly template your own values in the structure found in [`customization.yaml.gotmpl`](../helmfile/environments/default/customization.yaml.gotmpl), rather, you need to reference your custom value files to overwrite the openDesk defaults. In the app specific `helmfile-child.yaml.gotmpl` files, the openDesk value files are referenced first, then afterwards, the files you define in the customizations are read. > You can not directly template your own values in the structure found in [`customization.yaml.gotmpl`](../helmfile/environments/default/customization.yaml.gotmpl), rather, you need to reference your custom value files to overwrite the openDesk defaults. In the app specific `helmfile-child.yaml.gotmpl` files, the openDesk value files are referenced first, then afterwards, the files you define in the customizations are read.

View File

@@ -21,8 +21,6 @@ This documentation lets you create an openDesk evaluation instance on your Kuber
* [Container runtime](#container-runtime) * [Container runtime](#container-runtime)
* [Volumes](#volumes) * [Volumes](#volumes)
* [Customize deployment](#customize-deployment) * [Customize deployment](#customize-deployment)
* [Functional features](#functional-features)
* [Features through Customization](#features-through-customization)
* [Connectivity](#connectivity) * [Connectivity](#connectivity)
* [Ports](#ports) * [Ports](#ports)
* [Web-based user interface](#web-based-user-interface) * [Web-based user interface](#web-based-user-interface)

View File

@@ -9,6 +9,9 @@ SPDX-License-Identifier: Apache-2.0
* [Disclaimer](#disclaimer) * [Disclaimer](#disclaimer)
* [Automated migrations - Overview and mandatory upgrade path](#automated-migrations---overview-and-mandatory-upgrade-path) * [Automated migrations - Overview and mandatory upgrade path](#automated-migrations---overview-and-mandatory-upgrade-path)
* [Manual checks/actions](#manual-checksactions) * [Manual checks/actions](#manual-checksactions)
* [From v1.1.2](#from-v112)
* [Helmfile cleanup: Do not configure OX provisioning when no OX installed](#helmfile-cleanup-do-not-configure-ox-provisioning-when-no-ox-installed)
* [Helmfile new default: PostgreSQL for XWiki and Nextcloud](#helmfile-new-default-postgresql-for-xwiki-and-nextcloud)
* [From v1.1.1](#from-v111) * [From v1.1.1](#from-v111)
* [Pre-upgrade from v1.1.1](#pre-upgrade-from-v111) * [Pre-upgrade from v1.1.1](#pre-upgrade-from-v111)
* [Helmfile feature update: App settings wrapped in `apps.` element](#helmfile-feature-update-app-settings-wrapped-in-apps-element) * [Helmfile feature update: App settings wrapped in `apps.` element](#helmfile-feature-update-app-settings-wrapped-in-apps-element)
@@ -47,6 +50,9 @@ SPDX-License-Identifier: Apache-2.0
* [Updated customizable template attributes](#updated-customizable-template-attributes) * [Updated customizable template attributes](#updated-customizable-template-attributes)
* [`migrations` S3 bucket](#migrations-s3-bucket) * [`migrations` S3 bucket](#migrations-s3-bucket)
* [Automated migrations - Details](#automated-migrations---details) * [Automated migrations - Details](#automated-migrations---details)
* [From v1.1.2 (automated)](#from-v112-automated)
* [migrations-pre](#migrations-pre)
* [migrations-post](#migrations-post)
* [From v1.0.0 (automated)](#from-v100-automated) * [From v1.0.0 (automated)](#from-v100-automated)
* [From v0.9.0 (automated)](#from-v090-automated) * [From v0.9.0 (automated)](#from-v090-automated)
* [Related components and artifacts](#related-components-and-artifacts) * [Related components and artifacts](#related-components-and-artifacts)

View File

@@ -14,7 +14,7 @@ well as the overall status of monitoring integration.
* [Metrics](#metrics) * [Metrics](#metrics)
* [Alerts](#alerts) * [Alerts](#alerts)
* [Dashboards for Grafana](#dashboards-for-grafana) * [Dashboards for Grafana](#dashboards-for-grafana)
* [Components](#components) * [Component overview](#component-overview)
<!-- TOC --> <!-- TOC -->
# Technology # Technology