Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bitcoin-tools/nodebuilder
Run a secure Bitcoin Core node with ease.
https://github.com/bitcoin-tools/nodebuilder
bitcoin bitcoin-api bitcoin-blockchain bitcoin-blocks bitcoin-core bitcoin-core-rpc bitcoin-development bitcoin-docker bitcoin-explorer bitcoin-full-node bitcoin-network bitcoin-node bitcoin-nodes bitcoin-rpc bitcoin-wallet bitcoincore bitcoind bitcoind-docker blockchain full-node
Last synced: 7 days ago
JSON representation
Run a secure Bitcoin Core node with ease.
- Host: GitHub
- URL: https://github.com/bitcoin-tools/nodebuilder
- Owner: bitcoin-tools
- License: mit-0
- Created: 2024-01-12T10:18:27.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-05-22T20:27:00.000Z (4 months ago)
- Last Synced: 2024-05-23T01:06:36.094Z (4 months ago)
- Topics: bitcoin, bitcoin-api, bitcoin-blockchain, bitcoin-blocks, bitcoin-core, bitcoin-core-rpc, bitcoin-development, bitcoin-docker, bitcoin-explorer, bitcoin-full-node, bitcoin-network, bitcoin-node, bitcoin-nodes, bitcoin-rpc, bitcoin-wallet, bitcoincore, bitcoind, bitcoind-docker, blockchain, full-node
- Language: Shell
- Homepage:
- Size: 581 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Bitcoin Core Node Builder
Run a secure Bitcoin Core node with ease.
Copy-paste the following command into Terminal:
```sh
sh -c "$(curl -fsSL https://github.com/bitcoin-tools/nodebuilder/raw/v1.9.1/nodebuilder)"
```
[](https://docs.docker.com)
[](https://en.wikipedia.org/wiki/List_of_Linux_distributions)
[](https://support.apple.com/guide/mac-help/welcome/mac)
[](https://www.freebsd.org)
[](https://www.openbsd.org)
[](https://bitcoincore.org/en/releases/27.1/)
[](https://opensource.org/licenses/MIT-0)
[](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html)
##### Health Checks
[](https://github.com/bitcoin-tools/nodebuilder/actions/workflows/validation.yaml)
[](https://github.com/bitcoin-tools/nodebuilder/actions/workflows/push_release_images.yaml)
## Table of Contents
- [Usage](#usage)
- [(Optional) Command-Line Arguments](#optional-command-line-arguments)
- [(Optional) Docker Container](#optional-docker-container)
- [Prerequisites](#prerequisites)
- [What Does This Script Do?](#what-does-this-script-do)
- [Which Parts of My System Does This Script Touch?](#which-parts-of-my-system-does-this-script-touch)
- [How Do I Uninstall Everything?](#how-do-i-uninstall-everything)
- [Acknowledgements](#acknowledgements)
- [Contributing](#contributing)
- [License](#license)
## Usage
As mentioned above, start the script from the command line. Open Terminal and run:
```sh
sh -c "$(curl -fsSL https://github.com/bitcoin-tools/nodebuilder/raw/v1.9.1/nodebuilder)"
```
Or download the script to your local system, set permissions, and run it:
```sh
wget https://github.com/bitcoin-tools/nodebuilder/raw/v1.9.1/nodebuilder
chmod u+x nodebuilder
./nodebuilder
```
### (Optional) Command-Line Arguments
`nodebuilder` supports optional arguments to override the default semi-automated settings:
| Short | Long Version | Description |
|:-----:|:-------------|:------------|
| `-b` | `--bitcoin-version` | Specify the Bitcoin version. Requires one argument, for example: `-b 27.1` |
| `-c` | `--compile` | Build Bitcoin from source. Requires no arguments. |
| `-h` | `--help` | Display the help message. _Overrides all other arguments._ |
| `-p` | `--prune` | Set a prune value in MiB. Requires one argument, for example: `-p 50000` |
| `-r` | `--skip-reboot` | Skip reboot after installing system update. Requires no arguments. |
| `-s` | `--skip-update` | Skip installation of system updates. Requires no arguments. |
| `-t` | `--test` | Run unit tests on functions. |
| `-u` | `--unattended` | Run in non-interactive mode. Requires no arguments. |
You can set multiple options. Here are two ways to compile Bitcoin 27.1 unattended with a 50000 MiB prune:
```sh
./nodebuilder -b 27.1 -c -p 50000 -u
./nodebuilder --bitcoin-version 27.1 --compile --prune 50000 --unattended
```
### (Optional) Docker Container
A nodebuilder Docker container can either run on Ubuntu (default) or on an alternative Linux distribution: Alpine, Amazon, Arch, Clear, Debian, Fedora, Gentoo, Manjaro, openSUSE Leap, openSUSE Tumbleweed, Oracle, Red Hat Enterprise, Rocky, and SUSE Enterprise.
To run the Ubuntu base image, clone the repository and build the default container.
```
git clone https://github.com/bitcoin-tools/nodebuilder
cd nodebuilder/docker/
docker build .
```
To use an [alternative base image](docker/), clone the repository and build a different container. For example, to run nodebuilder on Alpine Linux, run:
```
docker build -f Dockerfile_alpine .
```
## Prerequisites
1. An active internet connection
2. `curl`, which the script will attempt to automatically install or you can install with a package manager
3. A supported operating system
- Any system that can run [Docker](./docker/)
- Linux distributions
- [Alpine](https://wiki.alpinelinux.org/wiki/Installation)
- [Arch](https://github.com/archlinux/archinstall) or any derivative like [Manjaro](https://wiki.manjaro.org/index.php/Installation_Guides)
- [Clear Linux](https://www.clearlinux.org/downloads.html)
- [Debian](https://en.wikipedia.org/wiki/Debian) or any derivative like [Kali](https://www.kali.org/get-kali) or [Ubuntu](https://ubuntu.com/tutorials/install-ubuntu-desktop#1-overview)
- [Gentoo](https://www.gentoo.org/get-started)
- [Fedora](https://fedoraproject.org/workstation/download), [Red Hat](https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux), [Amazon Linux](https://docs.aws.amazon.com/linux), [Oracle Linux](https://www.oracle.com/linux), [Rocky Linux](https://rockylinux.org/download), etc.
- [SUSE](https://documentation.suse.com/sles/) or any derivative like [openSUSE Leap](https://get.opensuse.org/leap/)
- [macOS](https://en.wikipedia.org/wiki/MacOS)
- [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) and [Docker](#optional-docker-container) on Windows
- [FreeBSD](https://www.freebsd.org)
- [OpenBSD](http://openbsd.org)
This POSIX-compliant script installs a minimal number of [runtime dependencies](./resources/dependencies/) that aren't defined in POSIX.
## What Does This Script Do?
The script performs the following actions:
1. Update the system (including reboot, if required) and install [dependencies](./resources/dependencies/).
2. Either download, validate, and extract Bitcoin Core or build directly from the source code.
3. Set a prune for Bitcoin Core based on the disk free space.
4. Create shortcuts for Bitcoin Core on the desktop and the "Show Applications" list.
5. Start Bitcoin Core.
6. Prevent the system from sleeping, suspending, and hibernating.
7. Display relevant info while the initial block download proceeds, such as the percent synced, blocks left to sync, current chain tip date, and the free disk space remaining.
8. After the initial block download completes, tell the user that the script has finished and end the script.
### Which Parts of My System Does This Script Touch?
This script modifies the following in your file system:
- Any files related to installing system updates and [dependencies](./resources/dependencies/)
- The downloaded Bitcoin Core and validation files:
- `/compile_bitcoin/`
- `/bitcoin--.tar.gz`
- `/SHA256SUMS`
- `/SHA256SUMS.asc`
- `/guix.sigs/`
- The validated Bitcoin Core tarball and PGP keys:
- `~/Downloads/bitcoin--.tar.gz`
- `~/Downloads/guix.sigs/`
- The installed Bitcoin Core executable binaries, headers, libraries, and manual pages, respectively, are installed into:
- `/usr/local/bin/{bitcoind,bitcoin-cli,bitcoin-qt,bitcoin-tx,bitcoin-util,bitcoin-wallet,test_bitcoin}`
- `/usr/local/include/bitcoinconsensus.h`
- `/usr/local/lib/{libbitcoinconsensus.so,libbitcoinconsensus.so.0,libbitcoinconsensus.so.0.0.0}` on Linux
- `/usr/local/lib/libbitcoinconsensus.0.dylib` on macOS
- `/usr/local/man/man1/{bitcoind.1,bitcoin-qt.1,bitcoin-cli.1,bitcoin-tx.1,bitcoin-util.1,bitcoin-wallet.1}`
- An entry in the Show Applications menu and also on the desktop:
- `~/Desktop/bitcoin_core.desktop` on Linux
- `~/.local/share/applications/bitcoin_core.desktop` on Linux
- The Bitcoin Core configuration file:
- `~/.bitcoin/bitcoin.conf` on FreeBSD and Linux
- `~/Library/Application Support/Bitcoin/bitcoin.conf` on macOS
- Any files modified by Bitcoin Core, such as the blockchain, unspent transaction, and peer data.
### How Do I Uninstall Everything?
An automated solution is in the backlog. For now, here are a series of manual steps to follow:
- Uninstalling [runtime dependencies](./resources/dependencies/) can be be tricky. This script installs a minimal number of dependencies like curl, gzip, sudo, and tar as a defensive security posture. For advanced users, if you compiled Bitcoin from source by either using the `-c/--compile` optional argument or by running on Alpine Linux, please also review the build dependencies that were installed.
- To remove the downloaded Bitcoin Core installation and verification files, open the Files or Finder application, go to Downloads, and remove any files starting with `bitcoin-`. Also remove the directory named `guix.sigs`.
- Or do it in Terminal with `rm ~/Downloads/bitcoin-*.tar.gz && rm -r ~/Downloads/guix.sigs/`.
- To remove the installed executable binaries, headers, libraries, and manual pages, open the Files or Finder application, go to `/usr/local/bin`, and remove `bitcoind`, `bitcoin-cli`, `bitcoin-qt`, `bitcoin-util`, `bitcoin-wallet`, and `test_bitcoin`. Then go to `/usr/local/include` and remove `bitcoinconsensus.h`. Then go to `/usr/local/lib` and remove `libbitcoinconsensus.so`, `libbitcoinconsensus.so.0`, `libbitcoinconsensus.so.0.0.0` on Linux or `libbitcoinconsensus.0.dylib` on macOS. Then go to `/usr/local/man/man1` and remove `bitcoind.1`, `bitcoin-qt.1`, `bitcoin-cli.1`, `bitcoin-tx.1`, `bitcoin-util.1`, and `bitcoin-wallet.1`.
- Or do it in Terminal with `rm /usr/local/bin/{bitcoind,bitcoin-cli,bitcoin-qt,bitcoin-tx,bitcoin-util,bitcoin-wallet,test_bitcoin} /usr/local/include/bitcoinconsensus.h /usr/local/lib/{libbitcoinconsensus.so,libbitcoinconsensus.so.0,libbitcoinconsensus.so.0.0.0} /usr/local/man/man1/{bitcoind.1,bitcoin-qt.1,bitcoin-cli.1,bitcoin-tx.1,bitcoin-util.1,bitcoin-wallet.1}` on Linux or `rm /usr/local/bin/{bitcoind,bitcoin-cli,bitcoin-qt,bitcoin-tx,bitcoin-util,bitcoin-wallet,test_bitcoin} /usr/local/include/bitcoinconsensus.h /usr/local/lib/libbitcoinconsensus.0.dylib /usr/local/man/man1/{bitcoind.1,bitcoin-qt.1,bitcoin-cli.1,bitcoin-tx.1,bitcoin-util.1,bitcoin-wallet.1}` on macOS. If the command fails, your user doesn't have proper privileges. Try adding `sudo` to the front of the command.
- To remove the shortcut files on Linux, go to the Desktop and remove the `bitcoin_core.desktop` file. Then go to `~/.local/share/applications` and remove `bitcoin_core.desktop`.
- Or do it in Terminal with `rm ~/Desktop/bitcoin_core.desktop ~/.local/share/applications/bitcoin_core.desktop` on Linux.
- **If you want to keep your synced blocks and chainstate data**, open the Files or Finder application, go to the data directory at `~/.bitcoin` on FreeBSD and Linux or `~/Library/Application Support/Bitcoin` on macOS, and either backup the `blocks` and `chainstate` directories to an external drive or move those directories somewhere else on your computer. (The next step will remove everything else from the Bitcoin Core data directory.)
- Also open `bitcoin.conf` and make note of your prune value, in MiB (1024^2 bytes). Perhaps save that line (and only that line) to a text file wherever you copy/move the `blocks` and `chainstate` directories to. Any future Bitcoin Core nodes you run ***must have a prune setting less than or equal to this value***, or you'll have to re-sync the chain.
- To remove the data directory, open the Files or Finder application, go to the `~` on FreeBSD and Linux or `~/Library/Application Support` on macOS, and delete the data directory named `.bitcoin` on FreeBSD and Linux or `Bitcoin` on macOS. You need to enable the "Show Hidden Files" option in the Files or Finder settings.
- Or do it in Terminal with `rm -r ~/.bitcoin/` on FreeBSD and Linux or `rm -r ~/Library/Application\ Support/Bitcoin/` on macOS.
If you have any questions or ideas on how this section can be improved, please [open an issue](https://github.com/bitcoin-tools/nodebuilder/issues).
## Acknowledgements
Inspiration for this project came from these Open Source projects:
- [Bitcoin Core](https://github.com/bitcoin/bitcoin/graphs/contributors)
- [Yeti Wallet](https://github.com/JWWeatherman/yeticold/graphs/contributors)
- [Bails](https://github.com/BenWestgate/Bails) and [yeti.Bash](https://github.com/BenWestgate/yeti.Bash) by [Ben Westgate](https://github.com/BenWestgate)
- [install-full-node.sh](https://bitnodes.io/install-full-node.sh) by [Addy Yeow](https://github.com/ayeowch/)
- [Parmanode](https://github.com/armantheparman/parmanode) by [ArmanTheParman](https://github.com/armantheparman)
- And from countless online guides, such as [this one](https://bitcoin.org/en/full-node)
## Contributing
Please open an issue for any bug reports or feature requests. You can see the list of open issues [here](https://github.com/bitcoin-tools/nodebuilder/issues).
If you plan to submit a pull request, please first look over our automated and manual [test procedures](test/TEST.md).
## License
This project is licensed under the terms of [the MIT No Attribution / MIT-0 license](./LICENSE).