Go to file
michael1011 6213ced383
fixed spelling mistakes in documentation
2018-03-29 18:26:38 +02:00
backends added sample config 2018-03-29 15:01:28 +02:00
frontend fixed spelling mistakes in documentation 2018-03-29 18:26:38 +02:00
.gitignore updated dependencies 2018-03-25 17:58:36 +02:00
Gopkg.lock updated dependencies 2018-03-28 19:07:56 +02:00
Gopkg.toml updated dependencies 2018-03-28 19:07:56 +02:00
LICENSE updated LICENSE 2018-03-22 18:06:55 +01:00
README.md fixed spelling mistakes in documentation 2018-03-29 18:26:38 +02:00
build.sh added documentation 2018-03-29 17:51:01 +02:00
config.go added sample config 2018-03-29 15:01:28 +02:00
lightningtip.go added documentation 2018-03-29 17:51:01 +02:00
log.go added config 2018-03-22 21:52:16 +01:00
sample-lightningTip.conf added documentation 2018-03-29 17:51:01 +02:00

README.md

LightningTip

A simple way to accept tips via the Lightning Network on your website.

How to install

To get all necessary files for setting up LightningTip you can either download a prebuilt version or compile from source.

LightningTip is using LND as backend. Please make sure it is installed and fully synced before you install LightningTip.

The default config file location is lightningTip.conf in the directory you are executing LightningTip in. The sample config contains everything you need to know about the configuration. To use a custom config file location use the flag --config filename.

Embedding LightningTip is also quite easy. Upload all files excluding lightningTip.html to your webserver. Copy the contents of the head tag of the before mentioned HTML file into a HTML file you want to show LightningTip in. The div below the head tag is LightningTip itself. Paste it into any place in the already edited HTML file on you server.

If you are not running LightningTip on the same domain or IP address as your webserver or not on port 8081 change the variable requestUrl (which is in the first line) in the file lightningTip.js accordingly.

That's it! The only two things you need to take care about is keeping the LND node online and making sure that your channels are funded well enough to receive tips. LightningTip will take care of everything else.

How to build

First of all make sure Golang and Dep are both correctly installed. Golang version 1.10 or newer is recommended.

go get github.com/michael1011/lightningtip.git
cd $GOPATH/src/github.com/michael1011/lightningtip.git
dep ensure
go install