cln-plugins/donations/README.md

# Invoice Service (for Donations) plugin

This plugin enables c-lightning nodes to start one or several small webserver
via the command line on specified port. The webserver is based on flask and
exposes the invoice API call.

Therefor people can query for an invoice which they can use to pay. The plugin
can be started with `lightningd` by adding the following `--plugin` option
(adjusting the path to wherever the plugins are actually stored):

```
lightningd --plugin=/path/to/plugins/donations.py
```

By default the plugin will automatically start a webserver serving the donations page on port `8088`.


The following command line options are registered by the plugin and can be used to customize its behavior:

| Command line option    | Description                                                         |
|------------------------|---------------------------------------------------------------------|
| `--donation-autostart` | Should the donation server start automatically? (default: `true`)   |
| `--donation-web-port`  | Which port should the donation server listen to? (default: `8088`) |


Once the plugin is active you can run `lightning-cli help donationserver` to
learn about the command line API:

Controls a donationserver with `start`/`stop`/`restart`/`list` on `port`.

A Simple HTTP Server is created that can serve a donation webpage and allow to
issue invoices.  The plugin takes one of the following three commands
{start/stop/restart} as the first agument By default the plugin starts the
server on port 8088. This can however be changed with the port argument.

This means after starting `lightningd` together with the plugin you can run:
`lightning-cli donationserver start` and access the server at
http://localhost:8088/donation (in case you run your lightning node at
`localhost`)

## About the plugin
You can see a demo of the plugin on the [authors website][rene-donations]:


This plugin was created and is maintained by Rene Pickhardt. Thus Rene Pickhardt
is the copyright owner of this plugin. It shall serve as an educational resource
on his [Youtube channel][rene-youtube].

The plugin is licensed like the rest of c-lightning with BSD-MIT license
and comes without any warrenty.

If you like my work feel free to support me on [patreon][rene-patreon].

[rene-donations]: https://ln.rene-pickhardt.de/donation
[rene-patreon]: https://www.patreon.com/renepickhardt
[rene-youtube]:  https://www.youtube.com/user/RenePickhardt