nextcloud / nextcloud/whiteboard
Wrong websocket path
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 215
- Forks
- 39
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 32
Description
The websocket path is /socket.io in the source code but /whiteboard in the documentation.
The result of this is that the client fails to connect to the service, when configured according to the documentation/example.
I suggest changing the code so that it is using /whiteboard, as that makes more sense than /socket.io (in particular since there may be other services using websockets on the host in question, and it's therefore better to name the endpoints for what they are instead of by technology).
I also mentioned this earlier here ten days ago, perhaps that information is useful to those having problems getting it running.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with src/collaboration/Portal.ts at the websocket path and compare it with the /nginx documentation section in the README. Align the client endpoint with the documented configuration, then verify that a client configured according to the documentation can connect successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- networking
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100