From 088757a7c9f39f30cf5c9c9056ba37697a39f86a Mon Sep 17 00:00:00 2001 From: meejah Date: Thu, 15 Apr 2021 12:16:34 -0600 Subject: [PATCH] add words about websockets support --- docs/running.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/running.md b/docs/running.md index 5ea0601..5908584 100644 --- a/docs/running.md +++ b/docs/running.md @@ -50,6 +50,15 @@ The relevant arguments are: * ``--usage-db=``: maintains a SQLite database with current and historical usage data * ``--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:`` if not + provided + When you use ``twist``, the relay runs in the foreground, so it will generally exit as soon as the controlling terminal exits. For persistent environments, you should daemonize the server.