yuuza/outline
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: Allow websockets and collaboration service to run in the same process (#2674)

Browse Source
This commit is contained in:
Tom Moor
2021-10-19 21:18:20 -07:00
committed by GitHub
parent 3610a7f4a2
commit d443abfc57
11 changed files with 67 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/SERVICES.md
View File

@@ -32,14 +32,13 @@ At least one worker process is required to process the [queues](../server/queues
## Collaboration
The service is in alpha and as such is not started by default. It must run
separately to the `websockets` service, and will not start in the same process.
The `COLLABORATION_URL` must be set to the publicly accessible URL when running
the service. For example, if the app is hosted at `https://docs.example.com` you
may use something like: `COLLABORATION_URL=wss://docs-collaboration.example.com`.
Start the service with:
The service is in alpha and as such is not started by default. Start the service with:
```bash
yarn start --services=collaboration
```
The collaboration service is ideally run on a separate server. If this is the
case the `COLLABORATION_URL` env can be set to the publicly accessible URL. For
example, if the app is hosted at `https://docs.example.com` you may use something
like: `COLLABORATION_URL=wss://docs-collaboration.example.com`.