mirror of https://github.com/bumi/lntip
Update README.md
This commit is contained in:
parent
05fa7500b0
commit
21dbb09492
33
README.md
33
README.md
|
@ -1,24 +1,25 @@
|
|||
# LnMe - notBTCPayServer but your friendly ⚡ payment page
|
||||
# LnMe - your friendly ⚡ payment page
|
||||
## notBTCPayServer
|
||||
|
||||
LnMe is your personal Bitcoin Lightning payment website and payment widget.
|
||||
LnMe is a personal Bitcoin Lightning payment website and payment widget.
|
||||
|
||||
It is a small service written in Go that connects to a lnd node and exposes a simple HTTP JSON API to create and monitor invoices.
|
||||
It comes with a configurable personal ⚡ website and offers a JavaScript widget to integrate in existing websites.
|
||||
It is a small service written in Go that connects to a [lnd node](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md) and exposes a simple HTTP JSON API to create and monitor invoices.
|
||||
It comes with a configurable personal payment website and offers a JavaScript widget to integrate in existing websites.
|
||||
|
||||
If [webln](https://github.com/wbobeirne/webln) is available the widget automatically use webln to request the payment;
|
||||
otherwise an overlay will be shown with the payment request and a QR code.
|
||||
|
||||
## Motivation
|
||||
|
||||
I wanted a simple way for people to send Lightning payments to me using my own lightning node.
|
||||
I wanted a simple way for people to send Lightning payments using my own lightning node.
|
||||
|
||||
BTCPay Server is too big and hard to run for that as I do not need most features.
|
||||
BTCPay Server is too big and hard to run for that as I do not need most of its features.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
LnMe connects to your [LND node](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md), so a running LND node is required.
|
||||
LnMe can easily run next to LND.
|
||||
LnMe can easily run next to LND on the same system.
|
||||
|
||||
1. Download the latest [release](https://github.com/bumi/lntip/releases)
|
||||
2. Run `lnme` (to run it as systemd service have a look at the [systemd service example config](https://github.com/bumi/lntip/blob/master/examples/invoices-proxy.service))
|
||||
|
@ -30,17 +31,17 @@ LnMe can easily run next to LND.
|
|||
|
||||
To connect to the lnd node the cert, macaroon and address of the lnd node has to be configured. LnMe uses the LND defaults.
|
||||
|
||||
* address: Host and port of the lnd gRPC service. default: localhost:10009
|
||||
* cert: Path to the lnd cert file. default: ~/.lnd/tls.cert
|
||||
* macaroon: Path to the macaroon file. default: ~/.lnd/data/chain/bitcoin/mainnet/invoice.macaroon
|
||||
* `address`: Host and port of the lnd gRPC service. default: localhost:10009
|
||||
* `cert`: Path to the lnd cert file. default: ~/.lnd/tls.cert
|
||||
* `macaroon`: Path to the macaroon file. default: ~/.lnd/data/chain/bitcoin/mainnet/invoice.macaroon
|
||||
|
||||
#### Other configuration
|
||||
|
||||
* static-path: Path to a folder that you want to serve with LnMe (e.g. /home/bitcoin/lnme/website). Use this if you want to customize your ⚡website. default: disabled
|
||||
* disable-website: Disable the default LnMe website. Disable the website if you only want to embed the LnMe widget on your existing website.
|
||||
* disable-cors: Disable CORS headers. (default: false)
|
||||
* bind: Host and port to listen on. (default: :1323)
|
||||
* request-limit: Limit the allowed requests per second. (default: 5)
|
||||
* `static-path`: Path to a folder that you want to serve with LnMe (e.g. /home/bitcoin/lnme/website). Use this if you want to customize your ⚡website. default: disabled
|
||||
* `disable-website`: Disable the default LnMe website. Disable the website if you only want to embed the LnMe widget on your existing website.
|
||||
* `disable-cors`: Disable CORS headers. (default: false)
|
||||
* `bind`: Host and port to listen on. (default: :1323)
|
||||
* `request-limit`: Limit the allowed requests per second. (default: 5)
|
||||
|
||||
#### Examples:
|
||||
|
||||
|
@ -51,7 +52,7 @@ To connect to the lnd node the cert, macaroon and address of the lnd node has to
|
|||
|
||||
### Customize your ⚡ website
|
||||
|
||||
LnMe comes with a default website but you can easily configure and build your own website and use the LnMe widget.
|
||||
LnMe comes with a default website but you can easily configure and build your own using the the LnMe JavaScript widget or JSON API.
|
||||
|
||||
Take a look at the [embedded default website](https://github.com/bumi/lntip/blob/master/files/root/index.html) for an example and use the `--static-path` option to configure LnMe to serve your static file.
|
||||
|
||||
|
|
Loading…
Reference in New Issue