mirror/outline
1
0
Fork 0
mirror of https://github.com/outline/outline.git synced 2025-12-29 23:09:55 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update SERVICES.md

Browse Source
This commit is contained in:
Tom Moor
2022-09-05 12:51:30 -07:00
committed by GitHub
parent 34b586724b
commit 2d39a6f0ab
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/SERVICES.md
View File

@@ -14,7 +14,7 @@ yarn start --services=web,worker
## Admin
Currently this service is only used in development to view and debug the queues.
It is hosted at `/admin`.
It can be viewed at `/admin` when enabled.
## Web
@@ -32,13 +32,14 @@ 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. Start the service with:
The collaboration server coordinates all realtime editing and updating of documents,
it can be ran on the same box as the web server or separately.
```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`.
If the collaboration service is hosted on a separate domain then the `COLLABORATION_URL`
env must 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`.