kosmos/lndhub
8
0
Fork 0
Code Issues Pull Requests Releases Activity

doc: Add options that were added for Umbrel

Browse Source 
These options that aren't documented yet were added recently, I hope this documentation looks okay for you.
This commit is contained in:
Aaron Dewes 2021-04-08 10:25:43 +02:00 committed by Overtorment
parent 30c8bb2d94
commit d7216e1506
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -23,6 +23,9 @@ Copy `admin.macaroon` and `tls.cert` in root folder of LndHub.
`bitcoind` should run with `-deprecatedrpc=accounts`, for now. Lndhub expects Lnd's wallet to be unlocked, if not - it will attempt to unlock it with password stored in `config.lnd.password`. `bitcoind` should run with `-deprecatedrpc=accounts`, for now. Lndhub expects Lnd's wallet to be unlocked, if not - it will attempt to unlock it with password stored in `config.lnd.password`.
Don't forget to enable disk-persistance for `redis`. Don't forget to enable disk-persistance for `redis`.
If you have no `bitcoind` instance, for example if you use neutrino, or you have no bitcoind wallet,
for example if you use LND for wallet managment, you can remove the bitcoind settings from `config.js`.
Please not that this feature is limited to Bitcoin, so you can't use this feature if you use any other cryptocurrency with LND.
### Deploy to Heroku ### Deploy to Heroku
@ -31,6 +34,12 @@ Add config vars :
* `MACAROON`: hex-encoded `admin.macaroon` * `MACAROON`: hex-encoded `admin.macaroon`
* `TLSCERT`: hex-encoded `tls.cert` * `TLSCERT`: hex-encoded `tls.cert`
### Run in docker
LndHub is available on Docker Hub as [`bluewalletorganization/lndhub`](https://hub.docker.com/r/bluewalletorganization/lndhub).
Please note that this requires a separate instance of redis and LND and optionally, bitcoind.
You can also view Umbrel's implementation using docker-compose [here](https://github.com/getumbrel/umbrel/blob/280c87f0f323666b1b0552aeb24f60df94d1e43c/apps/lndhub/docker-compose.yml).
### Reference client implementation ### Reference client implementation
Can be used in ReactNative or Nodejs environment Can be used in ReactNative or Nodejs environment