Skip to content

Commit ff685bd

Browse files
committed
DOC: show how to enable the WebSocket interface
1 parent 1ec1649 commit ff685bd

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

doc/manual/network-websocket.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ WebSocket-based Network Interface
66
We did not evaluate any of the network interfaces in terms of security.
77
So please be sure that you are in a safe network when using them.
88

9-
The WebSocket network interface is started by default when starting the SSR.
9+
The WebSocket network interface can be activated with::
10+
11+
ssr-binaural --websocket-server
12+
13+
This of course works for all renderers, not only ``ssr-binaural``.
1014

1115
Once the SSR is running, you can use your browser to connect to
1216
http://localhost:9422/test.
@@ -21,8 +25,6 @@ You can choose a different port with::
2125

2226
ssr-binaural --websocket-server=4321
2327

24-
This of course works for all renderers, not only ``ssr-binaural``.
25-
2628
The relevant settings in the :ref:`ssr_configuration_file` are::
2729

2830
WEBSOCKET_INTERFACE = on

0 commit comments

Comments
 (0)