☂️ bitcoin

The official bitcoin application for Umbrel OS. It wraps Bitcoin Core's RPC exposes it via a RESTful API.

A variety of applications that run on Umbrel use bitcoin to interact with the bitcoin network.

🚀 Getting started

This application can be installed with one click via Umbrel's app store.

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

🛠 Running bitcoin

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 middleware 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 bitcoin

yarn start

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

---

⚡️ 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 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

Umbrel's bitcoin app is built upon the work done by Casa on its open-source API.

---

getumbrel.com