Zum Inhalt springen
openDesk Hilfe

Enterprise Edition

openDesk Enterprise Edition is recommended for production use. It receives support and patches from ZenDiS and the suppliers of the components due to the included product subscriptions.

The document refers to openDesk Community Edition as “oD CE” and for the openDesk Enterprise Edition it is “oD EE”.

Please contact ZenDiS to get openDesk Enterprise, either as SaaS offering or for you on-premise installation.

Components

The following components using the same codebase and artifacts for their Enterprise and Community offering:

  • Cryptpad
  • Jitsi
  • Nubus
  • OpenProject
  • XWiki

The following components have - at least partially - Enterprise specific artifacts:

  • Collabora: Collabora Online image version <major>.<minor>.<patch>.3 will be used once available, at the same time the Collabora Development Edition image will be updated to <major>.<minor>.<patch>.2 for oD CE.
  • Element: Some artifacts providing additional functionality are only available in oD EE. For the shared artifacts we keep the ones in oD CE and oD EE in sync.
  • Nextcloud: Specific enterprise image based on the NC Enterprise package is build based on the same release version as used in oD CE.
  • OX AppSuite: oD CE and EE are using the same release version, in EE an enterprise-built container of the AppSuite’s Core-Middleware is being integrated.
  • OX Dovecot Pro 3: Dovecot Pro provides support for S3 storage and this feature is used by default.

If you want to check in detail which artifacts are specific to openDesk Enterprise and thereby may contain non open source code, please check the repository: values in the image (1 / 2) and chart (1 / 2) definitions. When a repository path starts with /zendis the artifact is only available in an openDesk Enterprise deployment.

Enabling the Enterprise deployment

To enable the oD EE deployment you must set the environment variable OPENDESK_ENTERPRISE to any value that does not evaluate to boolean false for Helm flow control, e.g. "true", "yes" or "1":

OPENDESK_ENTERPRISE=true

Note Upgrading from oD CE to EE is currently not supported, especially due to the fact it requires a migration from Dovecot 2.x (standard storage) to Dovecot Pro 3.x (S3).

Configuring the oD EE deployment for self-hosted installations

Registry access

With openDesk EE you get access to the related artifact registry owned by ZenDiS.

Three steps are required to access the registry - for step #1 and #2 you can set some variables. You can to define a <your_name_for_the_secret> freely, like enterprise-secret, as long as it consistent in step #1 and #3.

NAMESPACE=
NAME_FOR_THE_SECRET=
YOUR_ENTERPRISE_REGISTRY_USERNAME=
YOUR_ENTERPRISE_REGISTRY_PASSWORD=
  1. Add your registry credentials as secret to the namespace you want to deploy openDesk to. Do not forget to create the namespace if it does not exist yet (kubectl create namespace ${NAMESPACE}).
kubectl create secret --namespace "${NAMESPACE}" \
  docker-registry "${NAME_FOR_THE_SECRET}" \
  --docker-server "registry.opencode.de" \
  --docker-username "${YOUR_ENTERPRISE_REGISTRY_USERNAME}" \
  --docker-password "${YOUR_ENTERPRISE_REGISTRY_PASSWORD}" \
  --dry-run=client -o yaml | kubectl apply -f -
  1. Docker login to the registry to access Helm charts for local deployments:
docker login registry.opencode.de -u ${YOUR_ENTERPRISE_REGISTRY_USERNAME} -p ${YOUR_ENTERPRISE_REGISTRY_PASSWORD}
  1. Reference the secret from step #1 in the deployment as well as the registry itself for images and helm charts:
global:
  imagePullSecrets:
    - ""
repositories:
  image:
    registryOpencodeDeEnterprise: "registry.opencode.de"
  helm:
    registryOpencodeDeEnterprise: "registry.opencode.de"

License keys

Some applications require license information for their Enterprise features to be enabled. With the aforementioned registry credentials you will also receive a file called enterprise.yaml containing the relevant license keys.

Please place the file next your other .yaml.gotmpl file(s) that configure your deployment.

Details regarding the scope/limitation of the component’s licenses:

  • Nextcloud: Enterprise license to enable Nextcloud Enterprise specific features, can be used across multiple installations until the licensed number of users is reached.
  • OpenProject: Domain specific enterprise license to enable OpenProject’s Enterprise feature set, domain matching can use regular expressions.
  • XWiki: Deployment specific enterprise license (key pair) to activate the XWiki Pro apps.