open.source/magic-wormhole-transit-relay
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add words about websockets support

Browse Source
This commit is contained in:
meejah 2021-04-15 12:16:34 -06:00
parent 3cda647883
commit 088757a7c9
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/running.md
View File

@ -50,6 +50,15 @@ The relevant arguments are:
* ``--usage-db=``: maintains a SQLite database with current and historical usage data * ``--usage-db=``: maintains a SQLite database with current and historical usage data
* ``--blur-usage=``: round logged timestamps and data sizes * ``--blur-usage=``: round logged timestamps and data sizes
For WebSockets support, two additional arguments:
* ``--websocket``: the endpoint to listen for websocket connections
on, like ``tcp:4002``
* ``--websocket-url``: the URL of the WebSocket connection. This may
be different from the listening endpoint because of port-forwarding
and so forth. By default it will be ``ws://localhost:<port>`` if not
provided
When you use ``twist``, the relay runs in the foreground, so it will When you use ``twist``, the relay runs in the foreground, so it will
generally exit as soon as the controlling terminal exits. For persistent generally exit as soon as the controlling terminal exits. For persistent
environments, you should daemonize the server. environments, you should daemonize the server.