Skip to content

Commit 2e9a510

Browse files
committed
doc: fix typo and missing ws: prefix documentation.
Signed-off-by: Rusty Russell <[email protected]>
1 parent 725c417 commit 2e9a510

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

doc/lightningd-config.5.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -610,7 +610,7 @@ is not specified, a DNS lookup may be done to resolve `HOSTNAME` or `TORIPADDRES
610610
If `HOSTNAME` was given that resolves to a local interface, the daemon
611611
will bind to that interface.
612612

613-
* **bind-addr**=*\[IPADDRESS\[:PORT\]\]|SOCKETPATH|HOSTNAME\[:PORT\]*
613+
* **bind-addr**=*\[ws:\]\[IPADDRESS\[:PORT\]\]|SOCKETPATH|HOSTNAME\[:PORT\]*
614614

615615
Set an IP address or UNIX domain socket to listen to, but do not
616616
announce. A UNIX domain socket is distinguished from an IP address by
@@ -621,6 +621,11 @@ IPv6 on all interfaces, '0.0.0.0' means bind to all IPv4
621621
interfaces, '::' means 'bind to all IPv6 interfaces'. 'PORT' is
622622
not specified, 9735 is used.
623623

624+
The `ws:` prefix indicates to expect connections to use the
625+
RFC-6455 WebSocket protocol instead of raw TCP/IP. This is more
626+
usable by web browsers directly, but often requires a reverse proxy
627+
to speak TLS ("wss").
628+
624629
This option can be used multiple times to add more addresses, and
625630
its use disables autolisten. If necessary, and 'always-use-proxy'
626631
is not specified, a DNS lookup may be done to resolve 'IPADDRESS'.

doc/lightningd-rpc.7.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ referred to in addition to simple JSON types:
101101
* `u64`: a JSON number without decimal point in the range 0 to 18446744073709551615 inclusive.
102102
* `u32`: a JSON number without decimal point in the range 0 to 4294967295 inclusive.
103103
* `u16`: a JSON number without decimal point in the range 0 to 65535 inclusive.
104-
* `u16`: a JSON number without decimal point in the range 0 to 255 inclusive.
104+
* `u8`: a JSON number without decimal point in the range 0 to 255 inclusive.
105105
* `pubkey`: a 66-character `hex` which is an SEC-1 encoded secp256k1 point (usually used as a public key).
106106
* `msat`: a `u64` which indicates an amount of millisatoshis. Deprecated: may also be a string of the number, with "msat" appended. As an input parameter, lightningd(8) will accept strings with suffixes (see below).
107107
* `txid`: a 64-character `hex` Bitcoin transaction identifier.

0 commit comments

Comments
 (0)