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. You can use all keys in the config as command line flag. Command line flags always override values in the config.

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.

Make sure that the executable of LightningTip is always running in the background. It connects LND and the widget on your website.

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.

When using LightningTip behind a proxy make sure the proxy supports EventSource. Without support for it the users will not see the "Thank you for your tip!" screen.

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
cd $GOPATH/src/github.com/michael1011/lightningtip
dep ensure
go install