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=