freechat/rtc-server/readme.md
shockrah 185b64d9db Base version of the rtc server
Authorization is required for implementation
So is a proper messaging model to make implementation clean and scalable
For now this serves as a good starting point for the rest of this project
2021-03-22 02:45:54 -07:00

15 lines
590 B
Markdown

# RTC WebSocket Server
This server is to be used _only_ if the `json-api` server is compiled with the `rtc` feature.
If you run this server without that feature in the `json-api` then this will never get updates from the API and thus be completely 100% useless.
# Configuration
This server runs on port 5648 and is served via the `ws://` protocol.
It is recommended that admins put this behind some a reverse proxy for secure web-sockets `wss://` and to remove the need for specifying the port number for clients.
## Command line flags
-p --port <PORT> : Defaults to 5648 (suggested)