Retropex/umbrel-bitcoin
1
0
Fork 0
mirror of https://github.com/Retropex/umbrel-bitcoin.git synced 2025-05-13 03:30:49 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Mayank Chhabra 2022-06-24 15:54:17 +05:30 committed by GitHub
parent ac88a2bf2c
commit 418afd0e72
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.md
View File

@ -1,27 +1,36 @@
[![Umbrel Middleware](https://static.getumbrel.com/github/github-banner-umbrel-middleware.svg)](https://github.com/getumbrel/umbrel-middleware) <p align="center">
<a href="https://umbrel.com">
<img src="https://i.imgur.com/rhDWq5W.jpg" alt="Logo">
</a>
<h1 align="center">Bitcoin Node for Umbrel</h1>
<p align="center">
Run a Bitcoin node on your Umbrel personal server. An official app by Umbrel. Powered by Bitcoin Core.
<br />
<a href="https://umbrel.com"><strong>umbrel.com »</strong></a>
<br />
<br />
<a href="https://twitter.com/umbrel">
<img src="https://img.shields.io/twitter/follow/umbrel?style=social" />
</a>
<a href="https://t.me/getumbrel">
<img src="https://img.shields.io/badge/community-chat-%235351FB">
</a>
<a href="https://reddit.com/r/getumbrel">
<img src="https://img.shields.io/reddit/subreddit-subscribers/getumbrel?style=social">
</a>
<a href="https://community.getumbrel.com">
<img src="https://img.shields.io/badge/community-forum-%235351FB">
</a>
</p>
</p>
[![Version](https://img.shields.io/github/v/release/getumbrel/umbrel-middleware?color=%235351FB&label=version)](https://github.com/getumbrel/umbrel-middleware/releases) ## Getting started
[![Docker Build](https://img.shields.io/github/workflow/status/getumbrel/umbrel-middleware/Docker%20build%20on%20push?color=%235351FB)](https://github.com/getumbrel/umbrel-middleware/actions?query=workflow%3A"Docker+build+on+push")
[![Docker Pulls](https://img.shields.io/docker/pulls/getumbrel/middleware?color=%235351FB)](https://hub.docker.com/repository/registry-1.docker.io/getumbrel/middleware/tags?page=1)
[![Community Chat](https://img.shields.io/badge/community%20chat-telegram-%235351FB)](https://t.me/getumbrel)
[![Developer Chat](https://img.shields.io/badge/dev%20chat-keybase-%235351FB)](https://keybase.io/team/getumbrel)
[![Twitter](https://img.shields.io/twitter/follow/getumbrel?style=social)](https://twitter.com/getumbrel) This app can be installed in one click via the Umbrel App Store.
[![Reddit](https://img.shields.io/reddit/subreddit-subscribers/getumbrel?label=Subscribe%20%2Fr%2Fgetumbrel&style=social)](https://reddit.com/r/getumbrel)
## Running locally for development
# ☂️ bitcoin
The official bitcoin application for [Umbrel OS](https://github.com/getumbrel/umbrel-os). It wraps [Bitcoin Core](https://github.com/bitcoin/bitcoin)'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`](https://github.com/bitcoin/bitcoin) instance is running and available on the same machine. Make sure a [`bitcoind`](https://github.com/bitcoin/bitcoin) instance is running and available on the same machine.
## 🛠 Running bitcoin
### Step 1. Install dependencies ### Step 1. Install dependencies
```sh ```sh
@ -33,45 +42,41 @@ Set the following environment variables directly or by placing them in `.env` fi
| Variable | Description | Default | | Variable | Description | Default |
| ------------- | ------------- | ------------- | | ------------- | ------------- | ------------- |
| `PORT` | Port where middleware should listen for requests | `3005` | | `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` | | `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` | | `BITCOIN_HOST` | IP or domain where `bitcoind` RPC is listening | `127.0.0.1` |
| `RPC_USER` | `bitcoind` RPC username | | | `RPC_USER` | `bitcoind` RPC username | |
| `RPC_PASSWORD` | `bitcoind` RPC password | | | `RPC_PASSWORD` | `bitcoind` RPC password | |
### Step 3. build the web interface ### Step 3. Build the web interface
```sh ```sh
yarn install:ui yarn install:ui
yarn build:ui yarn build:ui
``` ```
### Step 4. Run bitcoin ### Step 4. Run
```sh ```sh
yarn start yarn start
``` ```
You can access the web interface by visiting `http://localhost:8080/` You can access the app interface by visiting `http://localhost:8080/`
--- ---
### ⚡️ Don't be too reckless ## Contributing
> 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! 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 a developer looking to help but not sure where to begin, check out [these issues](https://github.com/getumbrel/umbrel-bitcoin/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. If you're looking for a bigger challenge, before opening a pull request please [create an issue](https://github.com/getumbrel/umbrel-bitcoin/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.
## 🙏 Acknowledgements ## Acknowledgements
Umbrel's bitcoin app is built upon the work done by [Casa](https://github.com/casa) on its open-source [API](https://github.com/Casa/Casa-Node-API). This app is built upon the work done by [Casa](https://github.com/casa) on its open source [API](https://github.com/Casa/Casa-Node-API).
--- ---
[![License](https://img.shields.io/github/license/getumbrel/umbrel-middleware?color=%235351FB)](https://github.com/getumbrel/umbrel-middleware/blob/master/LICENSE) [![License](https://img.shields.io/github/license/getumbrel/umbrel-bitcoin?color=%235351FB)](https://github.com/getumbrel/umbrel-bitcoin/blob/master/LICENSE)
[getumbrel.com](https://getumbrel.com) [umbrel.com](https://umbrel.com)