From d7216e15061a4d2cfbaf07ff720a0bd33f629531 Mon Sep 17 00:00:00 2001 From: Aaron Dewes Date: Thu, 8 Apr 2021 10:25:43 +0200 Subject: [PATCH] doc: Add options that were added for Umbrel These options that aren't documented yet were added recently, I hope this documentation looks okay for you. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 7c0f865..2b4ada0 100644 --- a/README.md +++ b/README.md @@ -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`. 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 @@ -31,6 +34,12 @@ Add config vars : * `MACAROON`: hex-encoded `admin.macaroon` * `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 Can be used in ReactNative or Nodejs environment