Skip to content

Commit

Permalink
doc: Updated warning box for wss-proxy
Browse files Browse the repository at this point in the history
Bug Fix: The wss-proxy plugin throws error `plugin-wss-proxy: Killing plugin: disabled itself at init: Error in parsing options: 'NoneType' object is not subscriptable` if CLN is not listening on websocket.

Reference: #7386 (comment)

Changelog-None.
  • Loading branch information
ShahanaFarooqui authored and rustyrussell committed Jun 28, 2024
1 parent 39626b9 commit 545d67e
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/developers-guide/app-development/wss-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ Install required packages with `pip install -r plugins/wss-proxy/requirements.tx

## Configuration

> 🚧
>
> Note: The wss-proxy plugin expects CLN to be listening on a websocket.
>
> In other words, CLN config option `bind-addr` starting with `ws` (`bind-addr=ws:...`)
>
> is required for wss-proxy to connect.
If `wss-bind-addr` is not specified, the plugin will disable itself.

- --wss-bind-addr: WSS proxy address to connect with WS. Format <wss-host>:<wss-port>.
Expand Down

0 comments on commit 545d67e

Please sign in to comment.