bumi/lntip
1
1
Fork 0
mirror of https://github.com/bumi/lntip synced 2025-06-16 17:55:35 +00:00
Code Issues Releases Wiki Activity

Add Tor readme

Browse Source
This commit is contained in:
bumi 2021-08-27 15:55:51 +02:00
parent fec31b2bd1
commit 91c62ed7ed
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -4,10 +4,10 @@ LnMe is a personal Bitcoin Lightning payment website and payment widget.
![demo](./lnme-demo.gif) ![demo](./lnme-demo.gif)
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 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. 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; 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. otherwise an overlay will be shown with the payment request and a QR code.
## Motivation ## Motivation
@ -19,7 +19,7 @@ BTCPay Server is too big and hard to run for that and I do not need most of its
## Installation ## 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 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 on the same system. LnMe can easily run next to LND on the same system.
1. Download the latest [release](https://github.com/bumi/lnme/releases) 1. Download the latest [release](https://github.com/bumi/lnme/releases)
@ -85,11 +85,16 @@ All environment variables must be prefixed by `LNME_` use `_` instead of `-`
$ LNME_LND_ADDRESS=127.0.0.1:10005 lnme $ LNME_LND_ADDRESS=127.0.0.1:10005 lnme
### TOR
LnMe can connect to your lightning node through [Tor](https://www.torproject.org/). You need to have Tor installed on your system and then simply provide your LND `.onion` address (don't forget to specify the port).
### Deployment ### Deployment
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. 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.
#### Heroku #### Heroku
One click deployment with Heroku: One click deployment with Heroku:
[![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/bumi/lnme) [![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/bumi/lnme)