Skip to content

Commit

Permalink
README: Update to show phoenixd v0.1.4 works, and add quick list of U…
Browse files Browse the repository at this point in the history
…RLs just after setup to avoid confusion
  • Loading branch information
AngusP committed Apr 10, 2024
1 parent 54aeaad commit 9097542
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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/<USERNAME>` LNURL payRequest endpoint (LUD-16) for `<USERNAME>@<LNURL_HOSTNAME>`
* `localhost:8000/lnurlp/<USERNAME>` LNURL payRequest endpoint (LUD-06)
* `localhost:8000/lnurlp/<USERNAME>/callback?amount=<AMOUNT_MSAT>` 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

Expand Down Expand Up @@ -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;
Expand All @@ -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/<USERNAME>` LNURL payRequest endpoint (LUD-16) for `<USERNAME>@<LNURL_HOSTNAME>`
* `localhost:8000/lnurlp/<USERNAME>` LNURL payRequest endpoint (LUD-06)
* `localhost:8000/lnurlp/<USERNAME>/callback?amount=<AMOUNT_MSAT>` 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:

Expand Down

0 comments on commit 9097542

Please sign in to comment.