From 909754275fd45a784423042882915432e21be2df Mon Sep 17 00:00:00 2001 From: AngusP Date: Wed, 10 Apr 2024 22:56:45 +0100 Subject: [PATCH] README: Update to show phoenixd v0.1.4 works, and add quick list of URLs just after setup to avoid confusion --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b6c0674..108f9de 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Note that LNBits will support phoenixd [soon™️](https://github.com/lnbits/ln ## Compatibility -Developed against `phoenixd version 0.1.3-d805f81`; also note that phoenixd is also new software and future releases may break things. +Developed against `phoenixd version 0.1.4-04bd430` (and `0.1.3-d805f81`); also note that phoenixd is also new software and future releases may break things. Currently tested on MacOS and Linux; YMMV on other UNIXes, and on Windows. @@ -62,6 +62,12 @@ docker run -p 8000:8000 \ -it phoenixd-lnurl:latest ``` + * `localhost:8000/lnurl` Tip webpage as in the screenshot above + * `localhost:8000/.well-known/lnurlp/` LNURL payRequest endpoint (LUD-16) for `@` + * `localhost:8000/lnurlp/` LNURL payRequest endpoint (LUD-06) + * `localhost:8000/lnurlp//callback?amount=` LNURL payRequest callback (LUD-06 and LUD-16) + * **Note** `localhost:8000/` and any other path will give you an `ERROR` -- that's supposed to happen, as it isn't a LNURL that **pheonixd-lnurl** understands 😉 + ## Non-Docker Setup @@ -90,7 +96,6 @@ chain=testnet http-password=hunter2 http-bind-port=9740 auto-liquidity=2m -max-absolute-fee=100000 ``` For **production** use, you can *just* install and run `phoenixd` for the first time; @@ -111,6 +116,12 @@ Now you're ready to run: ./run.sh ``` + * `localhost:8000/lnurl` Tip webpage as in the screenshot above + * `localhost:8000/.well-known/lnurlp/` LNURL payRequest endpoint (LUD-16) for `@` + * `localhost:8000/lnurlp/` LNURL payRequest endpoint (LUD-06) + * `localhost:8000/lnurlp//callback?amount=` LNURL payRequest callback (LUD-06 and LUD-16) + * **Note** `localhost:8000/` and any other path will give you an `ERROR` -- that's supposed to happen, as it isn't a LNURL that **pheonixd-lnurl** understands 😉 + To deploy, you probably want something to manage **phoenixd-lnurl** as a service, rather than running it directly. Some example config is provided to help with this: