Skip to content

Commit

Permalink
DOC: show how to enable the WebSocket interface
Browse files Browse the repository at this point in the history
  • Loading branch information
mgeier committed Jul 7, 2023
1 parent 1ec1649 commit ff685bd
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions doc/manual/network-websocket.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ WebSocket-based Network Interface
We did not evaluate any of the network interfaces in terms of security.
So please be sure that you are in a safe network when using them.

The WebSocket network interface is started by default when starting the SSR.
The WebSocket network interface can be activated with::

ssr-binaural --websocket-server

This of course works for all renderers, not only ``ssr-binaural``.

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

ssr-binaural --websocket-server=4321

This of course works for all renderers, not only ``ssr-binaural``.

The relevant settings in the :ref:`ssr_configuration_file` are::

WEBSOCKET_INTERFACE = on
Expand Down

0 comments on commit ff685bd

Please sign in to comment.