Mayank Chhabra
4 years ago
committed by
GitHub
GitHub
1 changed files with 66 additions and 27 deletions
@ -1,34 +1,73 @@ |
|||
# API connecting the Umbrel Dashboard to bitcoind & lnd |
|||
[](https://github.com/getumbrel/umbrel-middleware) |
|||
|
|||
### How to use: |
|||
[](https://github.com/getumbrel/umbrel-middleware/releases) |
|||
[](https://github.com/getumbrel/umbrel-middleware/actions?query=workflow%3A"Automatically+Build+image+on+tag") |
|||
[](https://hub.docker.com/repository/registry-1.docker.io/getumbrel/middleware/tags?page=1) |
|||
[](https://t.me/getumbrel) |
|||
|
|||
1. To `/home/umbrel/docker-compose.yml`, add the following service: |
|||
``` |
|||
middleware: |
|||
image: getumbrel/middleware:latest |
|||
depends_on: [ bitcoin, lnd ] |
|||
logging: *default-logging |
|||
restart: on-failure |
|||
network_mode: host |
|||
volumes: |
|||
- "/home/umbrel/lnd:/lnd" |
|||
environment: |
|||
BITCOIN_HOST: "0.0.0.0" |
|||
RPC_PORT: "8332" |
|||
RPC_USER: "<your rpc username>" |
|||
RPC_PASSWORD: "<your rpc password>" |
|||
LND_NETWORK: "mainnet" |
|||
LND_HOST: "127.0.0.1" |
|||
``` |
|||
[](https://twitter.com/getumbrel) |
|||
[](https://reddit.com/r/getumbrel) |
|||
|
|||
2. Run `docker-compose up -d` |
|||
|
|||
3. Test bitcoin from a computer connected to the same network |
|||
``` |
|||
curl http://umbrel.local:3005/v1/bitcoind/info/status |
|||
``` |
|||
# ☂️ middleware |
|||
|
|||
Middleware runs by-default on [Umbrel OS](https://github.com/getumbrel/umbrel-os) as a containerized service. It wraps [Bitcoin Core](https://github.com/bitcoin/bitcoin)'s RPC and [LND](https://github.com/lightningnetwork/lnd)'s gRPC, and exposes them via a RESTful API. |
|||
|
|||
Umbrel OS's [web dashboard](https://github.com/getumbrel/umbrel-dashboard) uses middleware to interact with both Bitcoin and Lightning Network. |
|||
|
|||
4. Test lightning from a computer connected to the same network |
|||
## 🚀 Getting started |
|||
|
|||
If you are looking to run Umbrel on your hardware, you do not need to run this service on it's own. Just download [Umbrel OS](https://github.com/getumbrel/umbrel-os/releases) and you're good to go. |
|||
|
|||
## 🛠 Running middleware |
|||
|
|||
Make sure a [`bitcoind`](https://github.com/bitcoin/bitcoin) and [`lnd`](https://github.com/lightningnetwork/lnd) instance is running and available on the same machine. |
|||
|
|||
### Step 1. Install dependencies |
|||
```sh |
|||
npm install |
|||
``` |
|||
curl http://umbrel.local:3005/v1/lnd/info/status |
|||
|
|||
### Step 2. Set environment variables |
|||
Set the following environment variables directly or by placing them in `.env` file of project's root. |
|||
|
|||
| Variable | Description | Default | |
|||
| ------------- | ------------- | ------------- | |
|||
| `PORT` | Port where middleware should listen for requests | `3005` | |
|||
| `DEVICE_HOST` | IP or domain from where [`umbrel-dashboard`](https://github.com/getumbrel/umbrel-dashboard) will request | `http://umbrel.local` | |
|||
| `BITCOIN_HOST` | IP or domain where `bitcoind` RPC is listening | `127.0.0.1` | |
|||
| `RPC_USER` | `bitcoind` RPC username | | |
|||
| `RPC_PASSWORD` | `bitcoind` RPC password | | |
|||
| `LND_HOST` | IP or domain where `lnd` RPC is listening | `127.0.0.1` | |
|||
| `TLS_FILE` | Path to `lnd`'s TLS certificate | `/lnd/tls.cert` | |
|||
| `LND_PORT` | Port where `lnd` RPC is listening | `10009` | |
|||
| `LND_NETWORK` | The chain `bitcoind` is running on (mainnet, testnet, regtest, simnet) | `mainnet` | |
|||
| `MACAROON_DIR` | Path to `lnd`'s `admin.macroon` file | `/lnd/data/chain/bitcoin/mainnet/admin.macaroon` | |
|||
| `JWT_PUBLIC_KEY_FILE` | Path to the JWT public key created by [`umbrel-manager`](https://github.com/getumbrel/umbrel-manager) | `/jwt-public-key/jwt.pem` | |
|||
|
|||
### Step 3. Run middleware |
|||
```sh |
|||
npm start |
|||
``` |
|||
|
|||
You can browse through the available API endpoints [here](https://github.com/getumbrel/umbrel-middleware/tree/master/routes/v1). |
|||
|
|||
--- |
|||
|
|||
### ⚡️ Don't be too reckless |
|||
|
|||
> Umbrel is still in an early stage and things are expected to break every now and then. We **DO NOT** recommend running it on the mainnet with real money just yet, unless you want to be really *#reckless*. |
|||
|
|||
## ❤️ Contributing |
|||
|
|||
We welcome and appreciate new contributions! |
|||
|
|||
If you're a developer looking to help but not sure where to begin, check out [these issues](https://github.com/getumbrel/umbrel-middleware/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) that have specifically been marked as being friendly to new contributors. |
|||
|
|||
If you're looking for a bigger challenge, before opening a pull request please [create an issue](https://github.com/getumbrel/umbrel-middleware/issues/new/choose) or [join our community chat](https://t.me/getumbrel) to get feedback, discuss the best way to tackle the challenge, and to ensure that there's no duplication of work. |
|||
|
|||
--- |
|||
|
|||
[](https://github.com/getumbrel/umbrel-middleware/blob/master/LICENSE) |
|||
|
|||
[getumbrel.com](https://getumbrel.com) |
|||
|
|||
Loading…
Reference in new issue