Components

Introduction

Some components - or more concrete: pods - can be turned on and off in appsuite-stack/helm/appsuite/values.yaml.

Enabling or disabling them only influences whether or not the pod will be started. Configuration in other pods is not updated to reflect the change. That configuration must be changed explicitly.

Configurations

core-cacheservice

values.yaml:   cacheService / s3ObjectStores|sproxydObjectStores / ...

If the cache service is enabled, it needs a configuration for using a S3 or Scality object storage.

core-documentconverter

The document converter tries to find a cache service per default.

values.yaml:   core-documentconverter / documentConverter / cache / remoteCache / enabled = true/false

If the cache service is used, the document converter will find it automatically.

If the cache service is disabled, the document converter should be configured to not try finding a cache service by setting the above configuration to false.

The document converter will automatically use reasonable defaults for temporary (short term) local caching if the cache service is not available.

Disable using a document converter in core-mw

The middleware will try to find a document converter per default. If you have disabled the document converter, you should also configure core-mw so it doesn't continue searching for a document converter:

core-mw:   com.openexchange.capability.document_preview: "false"

core-mw:   packages:     status:       open-xchange-documentconverter-api: disabled       open-xchange-documentconverter-client: disabled

core-imageconverter

DEPRECATED SOON - in the near future, the image converter will use the cache service instead of handling the caching itself.

For the time being, this configuration is needed so that the image converter can handle caching in an object storage:

values.yaml:   objectCache / s3ObjectStores /...   objectCache / mysql   objectCache / sproxydObjectStores/ ...

Note: objectCache type fileStore is not supported and will vanish once the cache service is used.

Disabling caching in image converter:

Just leave the following values empty, comment that values out or remove them so that objectCache.s3ObjectStores and objectCache/sproxydObjectStores get empty.

values.yaml:   objectCache / s3ObjectStores / id = -1   objectCache / sproxydObjectStores/ id = -1

Disable using an image converter in core-mw

The middleware will try to find an image converter per default. If you have disabled the image converter, you should also configure core-mw so it doesn't continue searching for an image converter:

core-mw:   packages:     status:       open-xchange-imageconverter-client: disabled

office-web

If you enable or disable office-web (OX Documents), some capabilities needs to be set in core-mw accordingly:

core-mw:   com.openexchange.capability.text: "true/false"   com.openexchange.capability.presentation: "true/false"   com.openexchange.capability.spreadsheet: "true/false"   com.openexchange.capability.document_preview: "true/false"   com.openexchange.capability.presenter: "true/false"   com.openexchange.capability.guard-docs: "true/false" (only use true if guard is enabled)

core-mw:   packages:     status:       open-xchange-documents-templates: enabled/disabled       open-xchange-documents-backend: enabled/disabled       open-xchange-documents-monitoring: enabled/disabled

core-spellcheck

The spell checker service is only used in OX Documents and is used per default.

If you disable core-spellcheck, also tell OX Documents to not search for a spell checker and to not offer spell checking to the user:

core.mw:   io.ox/office//module/spellingEnabled=false   com.openexchange.office.spellcheck.remoteURL=

wopi-server

The wopi-server is a service to edit documents with Collabora Online for which OX Documents(office and office-web) must be enabled.

Configuration

core-mw

The core-mw capability for using Collabora Online must be enabled.

core-mw:
    properties:
        com.openexchange.capability.documents_collabora: "true"

Enable the wopi-server and configure the properties

wopi-server:
  enabled: true
  properties:

OX App Suite and Collabora Online

The URLs of both services must be configured so that documents can be opened in OX App Suite using Collabora Online.

    appsuite:
      # The URL to the OX App Suite e.g. https://example.com/appsuite
      url:
    wopiclient:
      collabora:
        # The URL to the Collabora Online discovery page e.g. https://example.com/hosting/discovery
        discoveryUrl:

Redis

    redis:
      # The Redis mode must be “standalone” or “sentinel”, the default is “standalone”
      mode: "standalone"
      # List of Redis hosts in the format host:port
      hosts: []
      # The database of the Redis. The default is 0
      database: 0
      # The name of the master in the redis sentinel mode, the default is "mymaster".
      sentinelMasterId: "mymaster"

      # User name/password authentication is disabled by default.
      auth:
        enabled: false
        username: ""
        password: ""

      # The TLS/SSL connection is disabled by default.
      # Use the Java "keytool" to generate the "keystore" and the "truststore" in storetype "PKCS12".
      tls:
        enabled: false
        keystore:
        keystorePassword:
        truststore:
        truststorePassword:

Further configuration options

The values entered are the default. When “external services” are mentioned below, this refers to OX App Suite and Collabora Online.

    accesstoken:
      # The number of seconds the access token is valid in seconds.
      expirySeconds: 43200

    # The maximum file size that can be retrieved from the wopi server
    # can be written with the following (case-sensitive) post-fixes: B, KB, MB.
    maxFileSize: 100MB

    externalService:
      # The timeout for the connection to the external services in seconds.
      connectionTimeoutSeconds: 10
      # The read timeout for the external services in seconds.
      readTimeoutSeconds: 90
      # The write timeout for the external services in seconds.
      writeTimeoutSeconds: 90