Skip to content

JSON-RPC: Remove IPv6-untested warning from --jsonrpcbindip docs / improve empty address warning #2958

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hoffie merged 2 commits into from
Nov 11, 2022
Merged

JSON-RPC: Remove IPv6-untested warning from --jsonrpcbindip docs / improve empty address warning #2958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2878ad9
JSON-RPC: Remove IPv6-untested warning from --jsonrpcbindip docs
hoffie Nov 10, 2022
d9ef061
JSON-RPC: Improve empty-bind-address warning for --jsonrpcbindip
hoffie Nov 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/JSON-RPC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <ip address>` 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 <ip address>` command line option.


## Wire protocol
Expand Down
4 changes: 2 additions & 2 deletions src/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 );
}

Expand Down Expand Up @@ -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"
Expand Down
3 changes: 2 additions & 1 deletion tools/generate_json_rpc_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <ip address>` 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 <ip address>` command line option.


## Wire protocol
Expand Down