README.md

BitcoinSV Docker Image

Optimized docker image of the BitcoinSV node

Table of Contents

• Installation
• Documentation
• Maintainers
• Credits
• Contributing
• License

Installation

Objective: install a full BitcoinSV node using docker

Install Docker via Homebrew (Mac)

brew cask install docker

Install docker for Mac

1) Open the docker application for your applications folder
2) Finish the installation of the docker desktop application

Login to docker

docker login

Install Bitcoin SV Node

(Optional) Start with this repository as an example project

git clone git@github.com:mrz1836/docker-bitcoinsv.git
cd ~/docker-bitcoinsv

1) Create a bsvd-data volume to persist the bsvd blockchain data, should exit immediately. The bsvd-data container will store the blockchain when the node container is recreated (software upgrade, reboot, etc.):

docker volume create --name=bsvd-data

Confirm the volume exists

docker volume ls

DRIVER              VOLUME NAME
local               bsvd-data

2) Build the docker image

docker build --tag=bsv-node-image .

Confirm the image exists

docker image ls -a

REPOSITORY          TAG                 IMAGE ID            CREATED             SIZE
bsv-node-image      latest              bea2961dbc29        47 seconds ago      112MB

3) Run the docker image

docker run -v bsvd-data:/bitcoinsv --name=bsvd-node-server -d \
      -p 8333:8333 \
      -p 8332:8332 \
      bsv-node-image:latest

Check that the container exists

docker container ls -a

Connect to the docker instance

docker exec -it bsvd-node-server /bin/bash

Test: Are there are node connections?

root@zfr2961dbc55:~# bitcoin-cli getconnectioncount

Test: Is there blockchain info?

root@zfr2961dbc55:~# bitcoin-cli getblockchaininfo

Test: Are there logs?

root@zfr2961dbc55:~# tail -f ~/.bitcoin/bitcoind.log

Documentation

Makefile Commands

View all makefile commands

make help

List of all current commands:

build                Builds the docker image
help                 Show this help message
release              Full production release (creates release in Github)
release-snap         Test the full release (build binaries)
release-test         Full production test release (everything except deploy)
replace-version      Replaces the version in HTML/JS (pre-deploy)
run                  Runs the docker container
tag                  Generate a new tag and push (tag version=0.0.0)
tag-remove           Remove a tag if found (tag-remove version=0.0.0)
tag-update           Update an existing tag to current commit (tag-update version=0.0.0)

Maintainers

MrZ	Satchmo

Support the development of this project and the development team 🙏

Credits

Inspiration and some code from: docker-bitcoinsv

Contributing

View the contributing guidelines and please follow the code of conduct.

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬. You can also support this project by becoming a sponsor on GitHub 👏 or by making a bitcoin donation to ensure this journey continues indefinitely! 🚀

License