From 2878ad91ffe8be6ba9a0b2396b0834c47bd7d1c1 Mon Sep 17 00:00:00 2001 From: Christian Hoffmann Date: Thu, 10 Nov 2022 20:03:25 +0100 Subject: [PATCH 1/2] JSON-RPC: Remove IPv6-untested warning from --jsonrpcbindip docs IPv6 was tested successfully by @ann0see in https://github.com/jamulussoftware/jamulus/pull/2917#discussion_r1014421615 --- docs/JSON-RPC.md | 3 ++- src/main.cpp | 2 +- tools/generate_json_rpc_docs.py | 3 ++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/JSON-RPC.md b/docs/JSON-RPC.md index a4d6243cc2..039a659ef8 100644 --- a/docs/JSON-RPC.md +++ b/docs/JSON-RPC.md @@ -17,7 +17,8 @@ It can be generated like this: $ openssl rand -base64 10 > /file/with/a/secret.txt ``` -The JSON-RPC server defaults to listening on the local loopback network interface (127.0.0.1). This can be optionally changed by using the `--jsonrpcbindip ` command line option. **IPv4 only. IPv6 support has not been tested.** +The JSON-RPC server defaults to listening on the local loopback network interface (127.0.0.1). +This can be optionally changed by using the `--jsonrpcbindip ` command line option. ## Wire protocol diff --git a/src/main.cpp b/src/main.cpp index 38b536929d..a3ca5ae3f5 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1107,7 +1107,7 @@ QString UsageArguments ( char** argv ) " --jsonrpcsecretfile\n" " path to a single-line file which contains a freely\n" " chosen secret to authenticate JSON-RPC users.\n" - " --jsonrpcbindip optional network address to bind RPC server. Defaults to 127.0.0.1 (IPv4 only, IPv6 not tested).\n" + " --jsonrpcbindip optional network address to bind RPC server. Defaults to 127.0.0.1.\n" " -Q, --qos set the QoS value. Default is 128. Disable with 0\n" " (see the Jamulus website to enable QoS on Windows)\n" " -t, --notranslation disable translation (use English language)\n" diff --git a/tools/generate_json_rpc_docs.py b/tools/generate_json_rpc_docs.py index 228c9952fd..852414636e 100755 --- a/tools/generate_json_rpc_docs.py +++ b/tools/generate_json_rpc_docs.py @@ -204,7 +204,8 @@ def to_markdown(self): $ openssl rand -base64 10 > /file/with/a/secret.txt ``` -The JSON-RPC server defaults to listening on the local loopback network interface (127.0.0.1). This can be optionally changed by using the `--jsonrpcbindip ` command line option. **IPv4 only. IPv6 support has not been tested.** +The JSON-RPC server defaults to listening on the local loopback network interface (127.0.0.1). +This can be optionally changed by using the `--jsonrpcbindip ` command line option. ## Wire protocol From d9ef0611b7114366ff7983bb8dcda1c645eaeb89 Mon Sep 17 00:00:00 2001 From: Christian Hoffmann Date: Thu, 10 Nov 2022 21:20:39 +0100 Subject: [PATCH 2/2] JSON-RPC: Improve empty-bind-address warning for --jsonrpcbindip References: https://github.com/jamulussoftware/jamulus/pull/2917#discussion_r1019527165 Co-authored-by: Peter L Jones --- src/main.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main.cpp b/src/main.cpp index a3ca5ae3f5..c5ec0f7e16 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -801,7 +801,7 @@ int main ( int argc, char** argv ) if ( strJsonRpcBindIP.trimmed().isEmpty() ) { - qCritical() << qUtf8Printable ( QString ( "JSON-RPC is enabled but no bind address was provided, exiting." ) ); + qCritical() << qUtf8Printable ( QString ( "JSON-RPC is enabled but the bind address provided is empty, exiting." ) ); exit ( 1 ); }