https://github.com/dappnode/dappnodepackage-bitcoin

DAppNode package for bitcoin full node daemon
https://github.com/dappnode/dappnodepackage-bitcoin

Last synced: 9 days ago
JSON representation

DAppNode package for bitcoin full node daemon

• Host: GitHub
• URL: https://github.com/dappnode/dappnodepackage-bitcoin
• Owner: dappnode
• License: gpl-3.0
• Created: 2018-09-18T14:59:58.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-13T09:48:07.000Z (7 months ago)
• Last Synced: 2024-05-13T10:56:22.883Z (7 months ago)
• Language: Shell
• Size: 54.6 MB
• Stars: 3
• Watchers: 10
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Bitcoin DAppNode package

[![DAppNodeStore Available](https://img.shields.io/badge/DAppNodeStore-Available-brightgreen.svg)](http://my.admin.dnp.dappnode.eth/#/installer/bitcoin.dnp.dappnode.eth)

This package makes it easy to deploy a [bitcoin](https://bitcoin.org) node in a DAppNode, for this purpose the [bitcoind](https://bitcoin.org/es/descargar) daemon is used.

## Prerequisites

- git

   Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) commandline tool.

- docker

   Install [docker](https://docs.docker.com/engine/installation). The community edition (docker-ce) will work. In Linux make sure you grant permissions to the current user to use docker by adding current user to docker group, `sudo usermod -aG docker $USER`. Once you update the users group, exit from the current terminal and open a new one to make effect.

- docker-compose

   Install [docker-compose](https://docs.docker.com/compose/install)

**Note**: Make sure you can run `git`, `docker ps`, `docker-compose` without any issue and without sudo command.

## Building

`docker-compose build`

## Running

### Start

`docker-compose up -d`

### View logs

`docker-compose logs -f`

### Stop

`docker-compose down`

## Environment variables

You can edit the `docker-compose.yml` and add extra options, such as:

```

| name | default |

| ---- | ------- |

| BTC_RPCUSER | dappnode |

| BTC_RPCPASSWORD | dappnode |

| BTC_TXINDEX | 0 |

| BTC_PRUNE | 0 |

| BTC_DISABLEWALLET | 1 |

by default BTC_TXINDEX is 0, but the installation of the DAppNodePackage will set this value to 1, since it's a recommended value for other applications. BTC_PRUNE is 0 by default. Enable blockchain prunning by setting it to a

value larger than 550 (550Mb) , for example BTC_PRUNE=30000 to maintain only 30Gb of full blockchain data.

```

## License

This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details

## Note

This is early stage software