Bitcoin Node for Umbrel

Run a Bitcoin node on your Umbrel personal server. An official app by Umbrel. Powered by Bitcoin Core.
umbrel.com »

Getting started

This app can be installed in one click via the Umbrel App Store.

Running locally for development

Make sure a bitcoind instance is running and available on the same machine.

Step 1. Install dependencies

yarn

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 the API should listen for requests	3005
DEVICE_HOSTS	Comma separated list of IPs or domain names to whitelist for CORS	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

Step 3. Build the web interface

yarn install:ui
yarn build:ui

Step 4. Run

yarn start

You can access the app interface by visiting http://localhost:8080/

---

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 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 or join our community chat to get feedback, discuss the best way to tackle the challenge, and to ensure that there's no duplication of work.

Acknowledgements

This app is built upon the work done by Casa on its open source API.

---

umbrel.com