Compare commits

...

3 Commits

Author SHA1 Message Date
bumi e96522a8f9
Update README.md 2020-10-25 11:24:10 +01:00
bumi ea4b7f6b2e
Update README.md 2020-10-25 11:23:33 +01:00
bumi bda984622d
Add deployment notes 2020-10-25 11:00:54 +01:00
1 changed files with 23 additions and 1 deletions

View File

@ -23,9 +23,16 @@ LnMe connects to your [LND node](https://github.com/lightningnetwork/lnd/blob/ma
LnMe can easily run next to LND on the same system.
1. Download the latest [release](https://github.com/bumi/lnme/releases)
2. Run `lnme` (to run it as systemd service have a look at the [systemd service example config](https://github.com/bumi/lnme/blob/master/examples/lnme.service))
2. Run `lnme`
3. Done.
### Build from source
1. `$ git clone https://github.com/bumi/lnme.git && cd lnme`
2. `$ go install`
3. `$ rice embed-go && go build`
4. `$ ./lnme`
### Configuration
#### LND configuration
@ -51,6 +58,21 @@ To connect to the lnd node the cert, macaroon and address of the lnd node has to
$ lnme --disable-website
### Deployment
To run LnMe as systemd service have a look at the [systemd service example config](https://github.com/bumi/lnme/blob/master/examples/lnme.service)
I am running LnMe behind a reverse proxy using [caddy](https://caddyserver.com/) which comes with [fully-managed HTTPS](https://caddyserver.com/docs/quick-starts/https) via [letsencrypt](https://letsencrypt.org/).
Example Caddyfile:
```
lnme.michaelbumann.com {
reverse_proxy 127.0.0.1:1323
}
```
`$ caddy --config /etc/caddy/Caddyfile`
### 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.