You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
bumi 561610a7b9
Create FUNDING.yml
5 days ago
.github Create FUNDING.yml 5 days ago
examples Working example 11 months ago
files Less opacity for placeholders to make it look less like prefilled text 4 weeks ago
ln Merge branch 'master' into tor-support 3 weeks ago
lnurl Add Lightning Address support 3 weeks ago
.gitignore Igrnore tor data-dir 3 weeks ago
.lndonate Update .lndonate 3 weeks ago Merge branch 'master' into tor-support 3 weeks ago
app.json Make heroku deployment easier 11 months ago
config.toml.example Simplify configuration and remove nesting 11 months ago
go.mod Add support to connect to TOR nodes 4 weeks ago
go.sum Add support to connect to TOR nodes 4 weeks ago
lnme-demo.gif Update demo 11 months ago
lnme.go Provide LNURL metadata hash as description_hash in the lightning pr 3 weeks ago
rice-box.go Update ricebox 4 weeks ago

LnMe - your friendly payment page

LnMe is a personal Bitcoin Lightning payment page/widget and self-hosted Lightning Address server.


See it in action: - my lightning address:

LnMe focusses on simplicity and ease of deployment. It connects to an existing lightning node (currently LND is supported).

LnMe is one simple executable file that can be deployed anywhere with no dependencies. (on your own node or for example with one click on Heroku)



LnMe connects to your LND node, so a running LND node is required. LnMe can easily run next to LND on the same system or any other hosting provider.

There are no other dependencies. Simply download the binary and run it!

  1. Download the latest release
  2. Run lnme
  3. Done.

Build from source

  1. $ git clone && cd lnme
  2. $ go install
  3. $ rice embed-go && go build
  4. $ ./lnme

Note: You must have go.rice installed


LND configuration

To connect to the lnd node the cert, macaroon and address of the lnd node has to be configured. LnMe uses the LND defaults.

  • lnd-address: Host and port of the LND gRPC service. default: localhost:10009
  • lnd-cert-path: Path to the LND TLS cert file. default: ~/.lnd/tls.cert
  • lnd-macaroon-path: Path to the LND macaroon file. default: ~/.lnd/data/chain/bitcoin/mainnet/invoice.macaroon (invoice.macaroon is recommended)

Instead of the path to the macaroon and cert files you can also provide the hex strings:

  • lnd-cert: LND TLS cert as HEX string.
  • lnd-macaroon: LND macaroon HEX string. (invoice.macaroon is recommended)

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)
  • disable-ln-address: Disable Lightning Address handling.
  • port: Port to listen on. (default: 1323)
  • request-limit: Limit the allowed requests per second. (default: 5)

Depending on your deployment needs LnMe can be configured using the following options:

  1. Command line flags
  2. Environment variables
  3. Config TOML file


Command line flags:
$ lnme --help
$ lnme --port=4711
$ lnme --disable-website
TOML config file

See config.toml.example for an example file.

$ lnme --config=/path/to/config.toml
Environment variables

All environment variables must be prefixed by LNME_ use _ instead of -


LND Permissions

LnMe needs the following LND permissions:

  • Read/Write permission for invoices
  • Write permission for onchain address (if you want to use the onchain option)

Use the LND macaroon bakery to create a new macaroon for LnMe.

To get the HEX versions of the files use xxd -plain e.g. xxd -plain invoice.macaroon | tr -d '\n'


LnMe can connect to your lightning node through Tor. You need to have Tor installed on your system and then simply provide your LND .onion address (don't forget to specify the port).


It is the easiest to run LnMe on the same node as LND. But you can run it anywhere as long as your LND node is accessible. Simply run the binary and make sure the PORT is accessible.


One click deployment with Heroku:

You will need your LND address, the LND tls certificate (HEX) and the macaroon (HEX).

Deploy on Heroku

Here is a Video Demo of the Heroku deployment

Deployment Notes

To run LnMe as systemd service have a look at the systemd service example config

I am running LnMe behind a reverse proxy using caddy which comes with fully-managed HTTPS via letsencrypt.

Example Caddyfile: {

$ caddy --config /etc/caddy/Caddyfile

Feature Usage

Lightning Address

The Lightning Address is an Internet Identifier that allows anyone to send you Bitcoin over the Lightning Network. Lightning Address builds on LNURL-pay LnMe handles the necessary requests for you.

For more information check out the website:

Your Lightning Address: {anything}@{your domain}

Customize your website

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 for an example and use the --static-path option to configure LnMe to serve your static file.

  1. Create a new folder (e.g. /home/satoshi/my-ln-page)
  2. Create your index.html
  3. Run lnme: `lnme --static-path=/home/satoshi/my-ln-page

JavaScript Widget integration

You can integrate the LnMe widget in your existing website.

1. Add the LnMe JavaScript files

<script data-lnme-base-url="" src=""></script>

2. Usage

To request a lightning payment simply call request() on a new LnMe({value: value, memo: memo}):

var lnme = new LnMe({ value: 1000, memo: 'high5' });

Use it from a plain HTML link:

<a href="#" onclick="javascript:new LnMe({ value: 1000, memo: 'high5' }).request();return false;">Tip me</a>
More advanced JS API:
let lnme = new LnMe({ value: 1000, memo: 'high5' });

// get a new invoice and watch for a payment
// promise resolves if the invoice is settled
lnme.requestPayment().then(invoice => {
  alert('YAY, thanks!');

// create a new invoice
lnme.addInvoice().then(invoice => {

// periodically watch if an invoice is settled
lnme.watchPayment().then(invoice => {
  alert('YAY, thanks!');


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 and I do not need most of its features.


Use go run to ron the service locally:

$ go run lnme.go --address= --cert=/home/bitcoin/lightning/tls.cert --macaroon=/home/bitcoin/lightning/invoice.macaroon


LnMe uses go.rice to embed assets (HTML, JS, and CSS files). run rice embed-go (needs to be installed)

$ rice embed-go
$ go build


Bug reports and pull requests are welcome on GitHub at


Available as open source under the terms of the MIT License.