Giter Club home page Giter Club logo

BtcAutoNode - Easy Automated Installation of a Bitcoin Full Node and useful Apps via Scripts


BtcAutoNode is a set of bash scripts to install/setup a bitcoin full node in a Debian server system (Amd64).
(Tested so far on Debian 11.7, Debian 12.2 / 12.4, Ubuntu 23.04)

Example: Bitcoind installation:

bitcoind.mp4

The scripts are based on the Ministry of Nodes Videos and parts from the RaspiBolt Guide.

[Ministry of Nodes Node Box Guide 2022]
https://www.youtube.com/watch?v=9Kb7TobTNPI&list=PLCRbH-IWlcW2A_kpx2XwAMgT0rcZEZ2Cg

[RaspiBolt Guide]
https://raspibolt.org/

The intention was to make it easier/faster to get a full node up and running (especially for beginners).
This is not a one-click install node package with a fancy Webui (as e.g Umbrel, Raspiblitz,...).

It's more the way of following the videos or Guide and doing everything manually step by step, except that the installation is automated.

Predefined configs and service files are written automatically so that everything fits together.
No service/app is already started after executing the scripts. That should be done by the user.
But each script points out the relevant directories and files at the end of the execution.

It's a good idea to follow the videos and read the guide to understand what is being done and why. But also the scripts are documented and kept simple so that they are easy to follow.

The following individual scripts/applications are currently availabe:

  • System preparation (update, dependencies, user,...)
  • Bitcoin Core Node - Validate Blocks and Transactions
  • Fulcrum - Electrum SPV Server and Indexer
  • Mempool - Visualizer, Explorer and API Service
  • LND - Lightning Network Daemon Node
  • Thunderhub - Lightning Node Manager
  • Sparrow - Server/Terminal (for headless platforms)
  • Bisq - DEX Network (for headless platforms)
  • Glances - An Eye on your System (system monitor)
  • BTC RPC Explorer - Self-Hosted Bitcoin explorer for blockchain and full node
  • Bitfeed - A live visualization of Bitcoin network activity and blockchain explorer
  • Node Status Monitor - A simple php web page showing the status of the apps
  • Lightning Network Visualizer - A graph visualization tool to draw the lightning network
  • Electrs - Electrum Server in Rust (Fulcrum alternative)
  • Ride the Lightning - Web interface to manage Lightning node operations (similar to Thunderhub)
  • JoinMarket + Jam - Tool to create CoinJoin transactions + Jam WebUI
  • BTCPay Server - FOSS Bitcoin payment processor

Prerequisites

A working Debian server base system installation is needed with access to the root user (who does the installations).
At least 4GB of Ram should be available, otherwise the mempool build process might fail (and maybe other things).
(Works best with a dark gray terminal background color, like 3f3f3f or black)

Download/Installation

As root user:
Download the install.sh installer file which will install git and download/update the repository.

wget https://github.com/BtcAutoNode/BtcAutoNode/raw/master/install.sh
chmod +x install.sh
./install.sh

Usage

As root user:
Cd into the newly created directory btcautonode. Then cd into the install directory (or upgrade or uninstall).
Execute scripts via ./<script_name> and follow the instructions (Start with the 0_install_system.sh script!).

cd btcautonode/install
./0_install_system.sh
./1_install_bitcoind.sh
./2_install_fulcrum.sh
...
If you want to log the script output into a log file too, execute the scripts like this:
./2_install_fulcrum.sh | tee >(ansi2txt > fulcrum.log) [using ansi2text to strip off color codes]
./2_install_fulcrum.sh | tee fulcrum.log [to keep color codes: view file with: less -R fulcrum.log]

Telegram Group

Join the Telegram group and feel free to ask any questions:
https://t.me/BtcAutoNode

btcautonode's Projects

btcautonode icon btcautonode

Auto install scripts for bitcoin full node and other useful apps

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.