sheppy/opendesk
1
0
Fork 0
mirror of https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git synced 2025-12-07 07:51:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix(helmfile): Support PostgreSQL as alternative database backend for Nextcloud and XWiki. **Note:** PostgreSQL is likely to become the preferred option/default in the future and MariaDB might be deprecated at a later point.

Browse Source
This commit is contained in:
Thorsten Roßner
2025-01-07 14:58:19 +01:00
parent 335806a53e
commit a0f52ee7d4
12 changed files with 228 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/enhanced-configuration/idp-federation.md
View File

@@ -6,7 +6,6 @@ SPDX-License-Identifier: Apache-2.0
<h1>Federation with external identity provider (IdP)</h1>
<!-- TOC -->
* [Context](#context)
* [References](#references)
* [Prerequisites](#prerequisites)
* [User accounts](#user-accounts)
@@ -153,10 +152,9 @@ The following configuration is taking place in the Keycloak realm `opendesk`.
- *Client authentication*: `Client secret sent as post` (default)
- *Client ID*: Use the client ID you took from your organization's IdP config (`opendesk-federation-client` in this example)
- *Client Secret*: Use the secret you took from your organization's IdP config
- When completed with *Add*, you get to the detailed IdP configured that also needs some updates (you may need to open the *Advanced* section to access some settings)
- *Back-channel logout*: `On`
- *Disable user info*: `On`
- When completed with *Add*, you get to the detailed IdP configuration that at least needs some the following update:
- *First login flow override*: `auto-federate-flow`
- Depending on your organizations IdP and process preferences additional setting may be required
- In case you want to forcefully redirect all users to your organization's IdP (disabling login with local openDesk accounts):
- *Authentication* > `2fa-browser`

194
docs/external-services.md
View File

@@ -11,6 +11,7 @@ This document will cover the additional configuration for external services like
* [Database](#database)
* [Object storage](#object-storage)
* [Cache](#cache)
* [Footnotes](#footnotes)
<!-- TOC -->
# Database
@@ -18,93 +19,134 @@ This document will cover the additional configuration for external services like
When deploying this suite to production, you need to configure the applications to use your production-grade database
service.
| Component | Name | Type | Parameter | Key | Default |
| ------------ | ------------------ | ---------- | --------- | ---------------------------------------- | -------------------------- |
| Element | Synapse | PostgreSQL | | | |
| | | | Name | `databases.synapse.name` | `matrix` |
| | | | Host | `databases.synapse.host` | `postgresql` |
| | | | Port | `databases.synapse.port` | `5432` |
| | | | Username | `databases.synapse.username` | `matrix_user` |
| | | | Password | `databases.synapse.password` | |
| Keycloak | Keycloak | PostgreSQL | | | |
| | | | Name | `databases.keycloak.name` | `keycloak` |
| | | | Host | `databases.keycloak.host` | `postgresql` |
| | | | Port | `databases.keycloak.port` | `5432` |
| | | | Username | `databases.keycloak.username` | `keycloak_user` |
| | | | Password | `databases.keycloak.password` | |
| | Keycloak Extension | PostgreSQL | | | |
| | | | Name | `databases.keycloakExtension.name` | `keycloak_extensions` |
| | | | Host | `databases.keycloakExtension.host` | `postgresql` |
| | | | Port | `databases.keycloakExtension.port` | `5432` |
| | | | Username | `databases.keycloakExtension.username` | `keycloak_extensions_user` |
| | | | Password | `databases.keycloakExtension.password` | |
| UMS | Notifications API | PostgreSQL | | | |
| | | | Name | `databases.umsNotificationsApi.name` | `notificationsapi` |
| | | | Host | `databases.umsNotificationsApi.host` | `postgresql` |
| | | | Port | `databases.umsNotificationsApi.port` | `5432` |
| | | | Username | `databases.umsNotificationsApi.username` | `notificationsapi_user` |
| | | | Password | `databases.umsNotificationsApi.password` | |
| | Self Service | PostgreSQL | | | |
| | | | Name | `databases.umsSelfservice.name` | `selfservice` |
| | | | Host | `databases.umsSelfservice.host` | `postgresql` |
| | | | Port | `databases.umsSelfservice.port` | `5432` |
| | | | Username | `databases.umsSelfservice.username` | `selfservice_user` |
| | | | Password | `databases.umsSelfservice.password` | |
| Nextcloud | Nextcloud | MariaDB | | | |
| | | | Name | `databases.nextcloud.name` | `nextcloud` |
| | | | Host | `databases.nextcloud.host` | `mariadb` |
| | | | Username | `databases.nextcloud.username` | `nextcloud_user` |
| | | | Password | `databases.nextcloud.password` | |
| OpenProject | OpenProject | PostgreSQL | | | |
| | | | Name | `databases.openproject.name` | `openproject` |
| | | | Host | `databases.openproject.host` | `postgresql` |
| | | | Port | `databases.openproject.port` | `5432` |
| | | | Username | `databases.openproject.username` | `openproject_user` |
| | | | Password | `databases.openproject.password` | |
| OX App Suite | OX App Suite | MariaDB | | | |
| | | | Name | `databases.oxAppSuite.name` | `CONFIGDB` |
| | | | Host | `databases.oxAppSuite.host` | `mariadb` |
| | | | Username | `databases.oxAppSuite.username` | `root` |
| | | | Password | `databases.oxAppSuite.password` | |
| XWiki | XWiki | MariaDB | | | |
| | | | Name | `databases.xwiki.name` | `xwiki` |
| | | | Host | `databases.xwiki.host` | `mariadb` |
| | | | Username | `databases.xwiki.username` | `xwiki_user` |
| | | | Password | `databases.xwiki.password` | |
> **Note**<br>
> openDesk supports PostgreSQL as alternative database backend for Nextcloud and XWiki. PostgreSQL is likely become the preferred option/default in the future and MariaDB might be deprecated at a later point requiring migrations[^1] if you do not select PostgreSQL for new installations.
| Component | Name | Parameter | Key | Default |
| ---------------- | ------------------ | --------- | --------------------------------------------- | ---------------------------- |
| Element | Synapse | | | |
| | | Type | `databases.synapse.type` | `postgresql` |
| | | Name | `databases.synapse.name` | `matrix` |
| | | Host | `databases.synapse.host` | `postgresql` |
| | | Port | `databases.synapse.port` | `5432` |
| | | Username | `databases.synapse.username` | `matrix_user` |
| | | Password | `databases.synapse.password` | |
| Nubus | Guardian Mgmt API | | | |
| | | Type | `databases.umsGuardianManagementApi.type` | `postgresql` |
| | | Name | `databases.umsGuardianManagementApi.name` | `guardianmanagementapi` |
| | | Host | `databases.umsGuardianManagementApi.host` | `postgresql` |
| | | Port | `databases.umsGuardianManagementApi.port` | `5432` |
| | | Username | `databases.umsGuardianManagementApi.username` | `guardianmanagementapi_user` |
| | | Password | `databases.umsGuardianManagementApi.password` | |
| | Keycloak | | | |
| | | Type | `databases.keycloak.type` | `postgresql` |
| | | Name | `databases.keycloak.name` | `keycloak` |
| | | Host | `databases.keycloak.host` | `postgresql` |
| | | Port | `databases.keycloak.port` | `5432` |
| | | Username | `databases.keycloak.username` | `keycloak_user` |
| | | Password | `databases.keycloak.password` | |
| | Keycloak Extension | | | |
| | | Type | `databases.keycloakExtension.type` | `postgresql` |
| | | Name | `databases.keycloakExtension.name` | `keycloak_extensions` |
| | | Host | `databases.keycloakExtension.host` | `postgresql` |
| | | Port | `databases.keycloakExtension.port` | `5432` |
| | | Username | `databases.keycloakExtension.username` | `keycloak_extensions_user` |
| | | Password | `databases.keycloakExtension.password` | |
| | Notifications API | | | |
| | | Type | `databases.umsNotificationsApi.type` | `postgresql` |
| | | Name | `databases.umsNotificationsApi.name` | `notificationsapi` |
| | | Host | `databases.umsNotificationsApi.host` | `postgresql` |
| | | Port | `databases.umsNotificationsApi.port` | `5432` |
| | | Username | `databases.umsNotificationsApi.username` | `notificationsapi_user` |
| | | Password | `databases.umsNotificationsApi.password` | |
| | Self Service | | | |
| | | Type | `databases.umsSelfservice.type` | `postgresql` |
| | | Name | `databases.umsSelfservice.name` | `selfservice` |
| | | Host | `databases.umsSelfservice.host` | `postgresql` |
| | | Port | `databases.umsSelfservice.port` | `5432` |
| | | Username | `databases.umsSelfservice.username` | `selfservice_user` |
| | | Password | `databases.umsSelfservice.password` | |
| Nextcloud | Nextcloud | | | |
| | | Type | `databases.nextcloud.type` | `mariadb` |
| | | Name | `databases.nextcloud.name` | `nextcloud` |
| | | Host | `databases.nextcloud.host` | `mariadb` |
| | | Port | `databases.nextcloud.port` | `3306` |
| | | Username | `databases.nextcloud.username` | `nextcloud_user` |
| | | Password | `databases.nextcloud.password` | |
| Notes | Notes | | | |
| | | Type | `databases.notes.type` | `postgresql` |
| | | Name | `databases.notes.name` | `notes` |
| | | Host | `databases.notes.host` | `postgresql` |
| | | Port | `databases.notes.port` | `5432` |
| | | Username | `databases.notes.username` | `notes_user` |
| | | Password | `databases.notes.password` | |
| OpenProject | OpenProject | | | |
| | | Type | `databases.openproject.type` | `postgresql` |
| | | Name | `databases.openproject.name` | `openproject` |
| | | Host | `databases.openproject.host` | `postgresql` |
| | | Port | `databases.openproject.port` | `5432` |
| | | Username | `databases.openproject.username` | `openproject_user` |
| | | Password | `databases.openproject.password` | |
| OX App Suite[^2] | OX App Suite | | | |
| | | Type | `databases.oxAppSuite.type` | `mariadb` |
| | | Name | `databases.oxAppSuite.name` | `openxchange` |
| | | Host | `databases.oxAppSuite.host` | `mariadb` |
| | | Port | `databases.oxAppSuite.port` | `3306` |
| | | Username | `databases.oxAppSuite.username` | `root` |
| | | Password | `databases.oxAppSuite.password` | |
| XWiki[^3] | XWiki | | | |
| | | Type | `databases.xwiki.type` | `mariadb` |
| | | Name | `databases.xwiki.name` | `xwiki` |
| | | Host | `databases.xwiki.host` | `mariadb` |
| | | Port | `databases.xwiki.port` | `3306` |
| | | Username | `databases.xwiki.username` | `root` |
| | | Password | `databases.xwiki.password` | |
# Object storage
When deploying this suite to production, you need to configure the applications to use your production-grade object
storage service.
| Component   | Name        | Parameter       | Key                                      | Default            |
| Component | Name | Parameter | Key | Default |
|-------------|-------------|-----------------|------------------------------------------|--------------------|
| OpenProject | OpenProject |                 |                                          |                    |
|             |             | Backend         | `objectstores.openproject.backend` | `minio` |
|             |             | Bucket          | `objectstores.openproject.bucket` | `openproject` |
|             |             | Endpoint        | `objectstores.openproject.endpoint` |                    |
|             |             | Provider        | `objectstores.openproject.provider` | `AWS` |
|             |             | Region          | `objectstores.openproject.region` |                    |
|             |             | Secret          | `objectstores.openproject.secret` |                    |
|             |             | Username        | `objectstores.openproject.username` | `openproject_user` |
|             |             | Use IAM profile | `objectstores.openproject.useIAMProfile` |                    |
| OpenProject | OpenProject | | | |
| | | Backend | `objectstores.openproject.backend` | `minio` |
| | | Bucket | `objectstores.openproject.bucket` | `openproject` |
| | | Endpoint | `objectstores.openproject.endpoint` | |
| | | Provider | `objectstores.openproject.provider` | `AWS` |
| | | Region | `objectstores.openproject.region` | |
| | | Secret | `objectstores.openproject.secret` | |
| | | Username | `objectstores.openproject.username` | `openproject_user` |
| | | Use IAM profile | `objectstores.openproject.useIAMProfile` | |
# Cache
When deploying this suite to production, you need to configure the applications to use your production-grade cache
service.
| Component        | Name             | Type      | Parameter | Key                          | Default          |
| Component | Name | Type | Parameter | Key | Default |
|------------------|------------------|-----------|-----------|------------------------------|------------------|
| Intercom Service | Intercom Service | Redis     |           |                              |                  |
|                  |                  |           | Host      | `cache.intercomService.host` | `redis-headless` |
|                  |                  |           | Port      | `cache.intercomService.port` | `6379` |
| Nextcloud        | Nextcloud        | Redis     |           |                              |                  |
|                  |                  |           | Host      | `cache.nextcloud.host` | `redis-headless` |
|                  |                  |           | Port      | `cache.nextcloud.port` | `6379` |
| OpenProject      | OpenProject      | Memcached |           |                              |                  |
|                  |                  |           | Host      | `cache.openproject.host` | `memcached` |
|                  |                  |           | Port      | `cache.openproject.port` | `11211` |
| UMS              | Self Service     | Memcached |           |                              |                  |
|                  |                  |           | Host      | `cache.umsSelfservice.host` | `memcached` |
|                  |                  |           | Port      | `cache.umsSelfservice.port` | `11211` |
| Intercom Service | Intercom Service | Redis | | | |
| | | | Host | `cache.intercomService.host` | `redis-headless` |
| | | | Port | `cache.intercomService.port` | `6379` |
| Nextcloud | Nextcloud | Redis | | | |
| | | | Host | `cache.nextcloud.host` | `redis-headless` |
| | | | Port | `cache.nextcloud.port` | `6379` |
| OpenProject | OpenProject | Memcached | | | |
| | | | Host | `cache.openproject.host` | `memcached` |
| | | | Port | `cache.openproject.port` | `11211` |
| UMS | Self Service | Memcached | | | |
| | | | Host | `cache.umsSelfservice.host` | `memcached` |
| | | | Port | `cache.umsSelfservice.port` | `11211` |
# Footnotes
[^1] The upstream product provide some valuable information regarding database migrations:
- Nextcloud: https://docs.nextcloud.com/server/latest/admin_manual/configuration_database/db_conversion.html
- XWiki:
- https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Backup#HUsingtheXWikiExportfeature
- https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/ImportExport
[^2] OX App Suite only supports MariaDB and requires root access, as it manages its databases itself.
[^3] XWiki requires root access when using MariaDB as sub-wikis are using separate databases that are managed by XWiki. When using PostgreSQL with XWiki no root user is required as the sub-wikis are managed within multiple schemes within a single database.