almet/umap
1
0
Fork 0
mirror of https://github.com/umap-project/umap.git synced 2025-04-28 19:42:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Docs: Remove old references to websocket configuration

Browse source
This commit is contained in:
Alexis Métaireau 2025-03-14 15:26:37 +01:00
parent 3e0a6b8f10
commit 33525a1837
No known key found for this signature in database
GPG key ID: 1C21B876828E5FF2
1 changed files with 3 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
docs/config/settings.md
View file

@ -354,52 +354,7 @@ Otherwise, use any valid [python-social-auth configuration](https://python-socia
#### WEBSOCKET_ENABLED #### WEBSOCKET_ENABLED
A WebSocket server is packaged with uMap, and can be turned-on to activate Setting `WEBSOCKET_ENABLED` to `True` will allow users to enable real-time collaboration.
"real-time collaboration". In practice, in order to enable it, a few settings A switch will be available for them in the "advanced properties" of the map.
are exposed.
Setting `WEBSOCKET_ENABLED` to `True` will **not** enable real-time See [the documentation about ASGI deployment](../deploy/asgi.md) for more information.
collaboration on all the maps served by the server. Instead, a switch will be
available in the "advanced properties" of the map.
The websocket server can be started with the following command:
```bash
umap run_websocket_server
```
And can take optional settings `--host` and `--port` (default values are defined in
the settings).
Configuration example:
```python
WEBSOCKET_ENABLED = True
WEBSOCKET_BACK_HOST = "localhost"
WEBSOCKET_BACK_PORT = 8002
WEBSOCKET_FRONT_URI = "ws://localhost:8002"
```
These settings can also be set with the (same names) environment variables.
#### WEBSOCKET_BACK_HOST
#### WEBSOCKET_BACK_PORT
The internal host and port the websocket server will connect to.
#### WEBSOCKET_FRONT_URI
The connection string that will be used by the client to connect to the
websocket server. In practice, as it's useful to put the WebSocket server behind
TLS encryption, the values defined by `WEBSOCKET_FRONT_URI` are different than
the values defined by `WEBSOCKET_BACK_PORT` and `WEBSOCKET_BACK_HOST`.
This value is comprised of three parts:
```
protocol://host:port
```
- `protocol`: can either be `ws` for plain unencrypted WebSockets, or `wss` when using TLS encryption.
- `host`: is the address where the connection will be sent. It should be public facing.
- `port`: is the port that is open on the host.