mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-21 22:31:48 +01:00
Code Issues Projects Releases Wiki Activity

doc: Updated warning box for wss-proxy

Browse source 
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: https://github.com/ElementsProject/lightning/issues/7386#issuecomment-2175766309

Changelog-None.
This commit is contained in:
ShahanaFarooqui 2024-06-25 19:18:54 -07:00 • committed by Rusty Russell
parent 39626b9f8f
commit 545d67eaf6
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/developers-guide/app-development/wss-proxy.md
View file

@ -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>.