Skip to content
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.

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

Docs: Fix bind-addr docs #6854

Merged
merged 1 commit into from
Dec 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ This release named by Matt Morehouse.
- JSON-RPC: `listconfigs` now has `configs` subobject with more information about each config option. ([#6243])
- Config: `--regtest` option as alias for `--network=regtest` ([#6243])
- Config: `accept-htlc-tlv-type` (replaces awkward-to-use `accept-htlc-tlv-types`) ([#6243])
- Config: `bind=ws:...` to explicitly listen on a websocket. ([#6173])
- Config: `bind-addr=ws:...` to explicitly listen on a websocket. ([#6173])
- Config: `bind` can now take `dns:` prefix to advertize DNS records. ([#6173])
- Plugins: `sendpay` now allows self-payment of invoices, by specifying an empty route. ([#6399])
- Plugins: plugins can subscribe to all notifications using "*". ([#6347])
Expand Down Expand Up @@ -108,7 +108,7 @@ Note: You should always set `allow-deprecated-apis=false` to test for changes.
- JSON-RPC: `listconfigs` direct fields, use `configs` sub-object and `set`, `value_bool`, `value_str`, `value_int`, or `value_msat` fields. ([#6243])
- Config: boolean plugin options set to `1` or `0` (use `true` and `false` like non-plugin options). ([#6243])
- Config: `accept-htlc-tlv-types` (use `accept-htlc-tlv-type` multiple times) ([#6243])
- Config: `experimental-websocket-port`: use `--bind=ws::<portnum>`. ([#6173])
- Config: `experimental-websocket-port`: use `--bind-addr=ws::<portnum>`. ([#6173])
- Config: bind-addr=xxx.onion and addr=xxx.onion, use announce-addr=xxx.onion (which was always equivalent). ([#6173])
- Config: addr=/socketpath, use listen=/socketpath (which was always equivalent). ([#6173])
- Config: `announce-addr-dns`; use `--bind-addr=dns:ADDR` for finer control. ([#6173])
Expand Down
3 changes: 2 additions & 1 deletion doc/lightningd-config.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -761,7 +761,8 @@ connections on that port, on any IPv4 and IPv6 addresses you listen
to ([bolt][bolt] #891). The normal protocol is expected to be sent over WebSocket binary
frames once the connection is upgraded.

You should use `bind=ws::<portnum>` instead to create a WebSocket listening port.
You should use `bind-addr=ws::<portnum>` instead to create a WebSocket listening port.
see [Networking options](getting-started/getting-started/configuration.md#networking-options)

* **experimental-peer-storage**

Expand Down
2 changes: 1 addition & 1 deletion lightningd/options.c
Original file line number Diff line number Diff line change
Expand Up @@ -1162,7 +1162,7 @@ static char *opt_set_websocket_port(const char *arg, struct lightningd *ld)
char *err;

if (!ld->deprecated_apis)
return "--experimental-websocket-port been deprecated, use --bind=ws:...";
return "--experimental-websocket-port been deprecated, use --bind-addr=ws:...";

err = opt_set_u32(arg, &port);
if (err)
Expand Down
Loading