diff --git a/services/collaboration/README.md b/services/collaboration/README.md index 5daa8db514..6804187523 100644 --- a/services/collaboration/README.md +++ b/services/collaboration/README.md @@ -41,4 +41,27 @@ There are a few variables that you need to set: The external address of the collaboration service. The target app (onlyoffice, collabora, etc) will use this address to read and write files from Infinite Scale.\ For example: `https://wopi.example.com`. +* `COLLABORATION_WOPI_SHORTTOKENS`:\ + Needs to be set if the office application like `Office Online` complains about the URL is too long (which contains the access token) and refuses to work. If enabled, a store must be configured. + The application can be customized further by changing the `COLLABORATION_APP_*` options to better describe the application. + +## Storing + +The `collaboration` service persists information via the configured store in `COLLABORATION_STORE`. Possible stores are: + - `memory`: Basic in-memory store and the default. + - `redis-sentinel`: Stores data in a configured Redis Sentinel cluster. + - `nats-js-kv`: Stores data using key-value-store feature of [nats jetstream](https://docs.nats.io/nats-concepts/jetstream/key-value-store) + - `noop`: Stores nothing. Useful for testing. Not recommended in production environments. + +Other store types may work but are not supported currently. + +Note: The service can only be scaled if not using `memory` store and the stores are configured identically over all instances! + +Note that if you have used one of the deprecated stores, you should reconfigure to one of the supported ones as the deprecated stores will be removed in a later version. + +Store specific notes: + - When using `redis-sentinel`, the Redis master to use is configured via e.g. `OCIS_CACHE_STORE_NODES` in the form of `:/` like `10.10.0.200:26379/mymaster`. + - When using `nats-js-kv` it is recommended to set `OCIS_CACHE_STORE_NODES` to the same value as `OCIS_EVENTS_ENDPOINT`. That way the cache uses the same nats instance as the event bus. + - When using the `nats-js-kv` store, it is possible to set `OCIS_CACHE_DISABLE_PERSISTENCE` to instruct nats to not persist cache data on disc. +