mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-01-07 04:40:05 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9056 from owncloud/fix_collaboration_readme

Browse Source 
[docs-only] Fix Collaboration readme
This commit is contained in:
Martin
2024-05-03 08:58:55 +02:00
committed by GitHub
parent db281c4257 2f895fbc74
commit 48ce19b584
1 changed files with 19 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
services/collaboration/README.md
View File

@@ -1,25 +1,32 @@
# Collaboration
The collaboration service connects ocis with document servers such as collabora and onlyoffice using the WOPI protocol.
The collaboration service connects ocis with document servers such as Collabora and ONLYOFFICE using the WOPI protocol.
Since this service requires an external service (onlyoffice, for example), it won't run by default with the general `ocis server` command. You need to run it manually with the `ocis collaboration server` command.
Since this service requires an external document server, it won't start by default when using `ocis server`. You must start it manually with the `ocis collaboration server` command.
## Requirements
The collaboration service requires the target document server (onlyoffice, collabora, etc) to be up and running.
Some oCIS services are also required to be running in order to register the GRPC service for the "open in app" action:
* reva's gateway
* app provider
The collaboration service requires the target document server (ONLYOFFICE, Collabora, etc.) to be up and running. Additionally, some Infinite Scale services are also required to be running in order to register the GRPC service for the `open in app` action in the webUI. The following internal and external services need to be available:
If any of those services are down, the collaboration service won't start.
For convenience, you might want to start the whole oCIS stack before starting the collaboration service.
* External document server.
* The gateway service.
* The app-provider service.
## Configuration
If any of the named services above have not been started or are not reachable, the collaboration service won't start. For the binary or the docker release of Infinite Scale, check with the `ocis list` command if they have been started. If not, you must start them manually upfront before starting the collaboration service.
## WOPI Configuration
There are a few variables that you need to set:
* `COLLABORATION_WOPIAPP_ADDR`: The URL of the WOPI app (onlyoffice, collabora, etc). For example: "https://office.mycloud.prv".
* `COLLABORATION_HTTP_ADDR`: The external address of the collaboration service. The target app (onlyoffice, collabora) will use this address to read and write files from ocis. For example: "wopiserver.mycloud.prv"
* `COLLABORATION_HTTP_SCHEME`: The scheme to be used when accessing the collaboration service. Either "http" or "https". This will be used to finally build the URL that the WOPI app needs in order to contact this service.
* `COLLABORATION_WOPIAPP_ADDR`:\
The URL of the WOPI app (onlyoffice, collabora, etc).\
For example: `https://office.example.com`.
* `COLLABORATION_HTTP_ADDR`:\
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://wopiserver.example.com`.
* `COLLABORATION_HTTP_SCHEME`:\
The scheme to be used when accessing the collaboration service. Either `http` or `https`. This will be used to finally build the URL that the WOPI app needs in order to contact the collaboration service.
The rest of the configuration options available can be left with the default values.