#!/bin/sh
###############################################################################
#
# install-full-node.sh
#
# This is an install script for Bitcoin full node based on Bitcoin Core.
#
# This script attempts to make your node automatically reachable by other nodes
# in the network. This is done by using uPnP to open port 8333 on your router
# to accept incoming connections to port 8333 and route the connections to your
# node running inside your local network.
#
# For security reason, wallet functionality is not enabled by default.
#
# Supported OS: Linux, Mac OS X, BSD
# Supported platforms: x86, x86_64, ARM
#
# Usage:
# Open your terminal and type:
#
# curl https://bitnodes.21.co/install-full-node.sh | sh
#
# Bitcoin Core will built from source and installed into $HOME/bitcoin-core
# directory. Layout of this directory after the installation is shown below:
#
# Source files:
# $HOME/bitcoin-core/bitcoin/
#
# Binaries:
# $HOME/bitcoin-core/bin/
#
# Configuration file:
# $HOME/bitcoin-core/.bitcoin/bitcoin.conf
#
# Blockchain data files:
# $HOME/bitcoin-core/.bitcoin/blocks
# $HOME/bitcoin-core/.bitcoin/chainstate
#
###############################################################################
REPO_URL="https://github.com/bitcoin/bitcoin.git"
# See https://github.com/bitcoin/bitcoin/tags for latest version.
VERSION=v0.13.1
TARGET_DIR=$HOME/bitcoin-core
PORT=8333
UNINSTALL=0
BLUE='\033[94m'
GREEN='\033[32;1m'
YELLOW='\033[33;1m'
RED='\033[91;1m'
RESET='\033[0m'
SYSTEM=$(uname -s)
MAKE="make"
if [ "$SYSTEM" = "FreeBSD" ]; then
MAKE="gmake"
fi
usage() {
cat <
This is an install script for Bitcoin full node based on Bitcoin Core.
Usage: $0 [-h] [-v
] [-t ] [-p ] [-u]
-h
Print usage.
-v
Version of Bitcoin Core to install.
Default: $VERSION
-t
Target directory for source files and binaries.
Default: $HOME/bitcoin-core
-p
Bitcoin Core listening port.
Default: $PORT
-u
Uninstall Bitcoin Core.
EOF
}
print_info() {
printf "$BLUE$1$RESET\n"
}
print_success() {
printf "$GREEN$1$RESET\n"
sleep 1
}
print_warning() {
printf "$YELLOW$1$RESET\n"
}
print_error() {
printf "$RED$1$RESET\n"
sleep 1
}
print_start() {
print_info "Start date: $(date)"
}
print_end() {
print_info "\nEnd date: $(date)"
}
print_readme() {
cat <
# README
To stop Bitcoin Core:
cd $TARGET_DIR/bin && ./stop.sh
To start Bitcoin Core again:
cd $TARGET_DIR/bin && ./start.sh
To use bitcoin-cli program:
cd $TARGET_DIR/bin && ./bitcoin-cli -conf=$TARGET_DIR/.bitcoin/bitcoin.conf getinfo
To view Bitcoin Core log file:
tail -f $TARGET_DIR/.bitcoin/debug.log
To uninstall Bitcoin Core:
./install-full-node.sh -u
EOF
}
program_exists() {
if ! type "$1" > /dev/null 2>&1; then
return 1
else
return 0
fi
}
create_target_dir() {
print_info "\nCreating target directory: $TARGET_DIR"
mkdir -p $TARGET_DIR
}
install_miniupnpc() {
print_info "Installing miniupnpc from source.."
rm -rf miniupnpc-2.0 miniupnpc-2.0.tar.gz &&
wget -q http://miniupnp.free.fr/files/download.php?file=miniupnpc-2.0.tar.gz -O miniupnpc-2.0.tar.gz && \
tar xzf miniupnpc-2.0.tar.gz && \
cd miniupnpc-2.0 && \
sudo $MAKE install > build.out 2>&1 && \
cd .. && \
rm -rf miniupnpc-2.0 miniupnpc-2.0.tar.gz
}
install_debian_dependencies() {
sudo apt-get update
sudo apt-get install -y \
automake \
autotools-dev \
build-essential \
curl \
git \
libboost-all-dev \
libevent-dev \
libminiupnpc-dev \
libssl-dev \
libtool \
pkg-config
}
install_fedora_dependencies() {
sudo dnf install -y \
automake \
boost-devel \
curl \
gcc-c++ \
git \
libevent-devel \
libtool \
miniupnpc-devel \
openssl-devel
}
install_centos_dependencies() {
sudo yum install -y \
automake \
boost-devel \
curl \
gcc-c++ \
git \
libevent-devel \
libtool \
openssl-devel
install_miniupnpc
echo '/usr/lib' | sudo tee /etc/ld.so.conf.d/miniupnpc-x86.conf > /dev/null && sudo ldconfig
}
install_archlinux_dependencies() {
sudo pacman -S --noconfirm \
automake \
boost \
curl \
git \
libevent \
libtool \
miniupnpc \
openssl
}
install_alpine_dependencies() {
sudo apk update
sudo apk add \
autoconf \
automake \
boost-dev \
build-base \
curl \
git \
libevent-dev \
libtool \
openssl-dev
install_miniupnpc
}
install_mac_dependencies() {
if ! program_exists "gcc"; then
print_info "When the popup appears, click 'Install' to install the XCode Command Line Tools."
xcode-select --install
fi
if ! program_exists "brew"; then
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
fi
brew install \
--c++11 \
automake \
boost \
libevent \
libtool \
miniupnpc \
openssl \
pkg-config
}
install_freebsd_dependencies() {
sudo pkg install -y \
autoconf \
automake \
boost-libs \
curl \
git \
gmake \
libevent2 \
libtool \
openssl \
pkgconf \
wget
install_miniupnpc
}
install_dependencies() {
if program_exists "sudo"; then
print_info "\nInstalling required system packages.."
else
print_error "\nsudo program is required to install system packages. Please install sudo as root and rerun this script as normal user."
exit 1
fi
case "$SYSTEM" in
Linux)
if program_exists "apt-get"; then
install_debian_dependencies
elif program_exists "dnf"; then
install_fedora_dependencies
elif program_exists "yum"; then
install_centos_dependencies
elif program_exists "pacman"; then
install_archlinux_dependencies
elif program_exists "apk"; then
install_alpine_dependencies
else
print_error "\nSorry, your system is not supported by this installer."
exit 1
fi
;;
Darwin)
install_mac_dependencies
;;
FreeBSD)
install_freebsd_dependencies
;;
*)
print_error "\nSorry, your system is not supported by this installer."
exit 1
;;
esac
}
build_bitcoin_core() {
cd $TARGET_DIR
if [ ! -d "$TARGET_DIR/bitcoin" ]; then
print_info "\nDownloading Bitcoin Core source files.."
git clone --quiet $REPO_URL
fi
# Tune gcc to use less memory on single board computers.
cxxflags=""
if [ "$SYSTEM" = "Linux" ]; then
ram_kb=$(grep MemTotal /proc/meminfo | awk '{print $2}')
if [ $ram_kb -lt 1500000 ]; then
cxxflags="--param ggc-min-expand=1 --param ggc-min-heapsize=32768"
fi
fi
print_info "\nBuilding Bitcoin Core $VERSION"
print_info "Build output: $TARGET_DIR/bitcoin/build.out"
print_info "This can take up to an hour or more.."
rm -f build.out
cd bitcoin &&
git fetch > build.out 2>&1 &&
git checkout $VERSION 1>> build.out 2>&1 &&
git clean -f -d -x 1>> build.out 2>&1 &&
./autogen.sh 1>> build.out 2>&1 &&
./configure \
CXXFLAGS="$cxxflags" \
--without-gui \
--with-miniupnpc \
--disable-wallet \
--disable-tests \
--enable-upnp-default \
1>> build.out 2>&1 &&
$MAKE 1>> build.out 2>&1
if [ ! -f "$TARGET_DIR/bitcoin/src/bitcoind" ]; then
print_error "Build failed. See $TARGET_DIR/bitcoin/build.out"
exit 1
fi
}
install_bitcoin_core() {
cd $TARGET_DIR
print_info "\nInstalling Bitcoin Core $VERSION"
if [ ! -d "$TARGET_DIR/bin" ]; then
mkdir -p $TARGET_DIR/bin
fi
if [ ! -d "$TARGET_DIR/.bitcoin" ]; then
mkdir -p $TARGET_DIR/.bitcoin
fi
if [ "$SYSTEM" = "Darwin" ]; then
if [ ! -e "$HOME/Library/Application Support/Bitcoin" ]; then
ln -s $TARGET_DIR/.bitcoin "$HOME/Library/Application Support/Bitcoin"
fi
else
if [ ! -e "$HOME/.bitcoin" ]; then
ln -s $TARGET_DIR/.bitcoin $HOME/.bitcoin
fi
fi
cp "$TARGET_DIR/bitcoin/src/bitcoind" "$TARGET_DIR/bin/" &&
cp "$TARGET_DIR/bitcoin/src/bitcoin-cli" "$TARGET_DIR/bin/" &&
print_success "Bitcoin Core $VERSION installed successfully!"
cat > $TARGET_DIR/.bitcoin/bitcoin.conf <listen=1
bind=0.0.0.0
port=$PORT
maxconnections=64
dbcache=64
par=2
checkblocks=24
checklevel=0
disablewallet=1
rpcbind=127.0.0.1
rpcport=8332
rpcallowip=127.0.0.1
rpcuser=rpcuser
rpcpassword=$(LC_CTYPE=C tr -dc '[:alnum:]' < /dev/urandom | dd bs=4 count=16 2> /dev/null)
EOF
chmod go-rw $TARGET_DIR/.bitcoin/bitcoin.conf
cat > $TARGET_DIR/bin/start.sh <#!/bin/sh
if [ -f $TARGET_DIR/bin/bitcoind ]; then
$TARGET_DIR/bin/bitcoind -conf=$TARGET_DIR/.bitcoin/bitcoin.conf -datadir=$TARGET_DIR/.bitcoin -daemon
fi
EOF
chmod ugo+x $TARGET_DIR/bin/start.sh
cat > $TARGET_DIR/bin/stop.sh <#!/bin/sh
if [ -f $TARGET_DIR/.bitcoin/bitcoind.pid ]; then
kill \$(cat $TARGET_DIR/.bitcoin/bitcoind.pid)
fi
EOF
chmod ugo+x $TARGET_DIR/bin/stop.sh
}
start_bitcoin_core() {
if [ ! -f $TARGET_DIR/.bitcoin/bitcoind.pid ]; then
print_info "\nStarting Bitcoin Core.."
cd $TARGET_DIR/bin && ./start.sh
timer=0
until [ -f $TARGET_DIR/.bitcoin/bitcoind.pid ] || [ $timer -eq 5 ]; do
timer=$((timer + 1))
sleep $timer
done
if [ -f $TARGET_DIR/.bitcoin/bitcoind.pid ]; then
print_success "Bitcoin Core is running!"
else
print_error "Failed to start Bitcoin Core."
fi
fi
}
stop_bitcoin_core() {
if [ -f $TARGET_DIR/.bitcoin/bitcoind.pid ]; then
print_info "\nStopping Bitcoin Core.."
cd $TARGET_DIR/bin && ./stop.sh
timer=0
until [ ! -f $TARGET_DIR/.bitcoin/bitcoind.pid ] || [ $timer -eq 120 ]; do
timer=$((timer + 1))
sleep $timer
done
if [ ! -f $TARGET_DIR/.bitcoin/bitcoind.pid ]; then
print_success "Bitcoin Core stopped."
fi
fi
}
check_bitcoin_core() {
if [ -f $TARGET_DIR/.bitcoin/bitcoind.pid ]; then
if [ -f $TARGET_DIR/bin/bitcoin-cli ]; then
print_info "\nChecking Bitcoin Core.."
sleep 5
$TARGET_DIR/bin/bitcoin-cli -conf=$TARGET_DIR/.bitcoin/bitcoin.conf getinfo
fi
reachable=$(curl -I https://bitnodes.21.co/api/v1/nodes/me-$PORT/ 2> /dev/null | head -n 1 | cut -d ' ' -f2)
if [ $reachable -eq 200 ]; then
print_success "Bitcoin Core is accepting incoming connections at port $PORT!"
else
print_warning "Bitcoin Core is not accepting incoming connections at port $PORT. You may need to configure port forwarding on your router."
fi
fi
}
uninstall_bitcoin_core() {
stop_bitcoin_core
if [ -d "$TARGET_DIR" ]; then
print_info "\nUninstalling Bitcoin Core.."
rm -rf $TARGET_DIR
# Remove stale symlink.
if [ "$SYSTEM" = "Darwin" ]; then
if [ -L "$HOME/Library/Application Support/Bitcoin" ] && [ ! -d "$HOME/Library/Application Support/Bitcoin" ]; then
rm "$HOME/Library/Application Support/Bitcoin"
fi
else
if [ -L $HOME/.bitcoin ] && [ ! -d $HOME/.bitcoin ]; then
rm $HOME/.bitcoin
fi
fi
if [ ! -d "$TARGET_DIR" ]; then
print_success "Bitcoin Core uninstalled successfully!"
else
print_error "Uninstallation failed. Is Bitcoin Core still running?"
exit 1
fi
else
print_error "Bitcoin Core not installed."
fi
}
while getopts ":v:t:p:u" opt
do
case "$opt" in
v)
VERSION=${OPTARG}
;;
t)
TARGET_DIR=${OPTARG}
;;
p)
PORT=${OPTARG}
;;
u)
UNINSTALL=1
;;
h)
usage
exit 0
;;
?)
usage >& 2
exit 1
;;
esac
done
WELCOME_TEXT=$(cat <
Welcome!
You are about to install a Bitcoin full node based on Bitcoin Core $VERSION.
All files will be installed under $TARGET_DIR directory.
Your node will be configured to accept incoming connections from other nodes in
the Bitcoin network by using uPnP feature on your router.
For security reason, wallet functionality is not enabled by default.
After the installation, it may take several hours for your node to download a
full copy of the blockchain.
If you wish to uninstall Bitcoin Core later, you can download this script and
run "sh install-full-node.sh -u".
EOF
)
print_start
if [ $UNINSTALL -eq 1 ]; then
echo
read -p "WARNING: This will stop Bitcoin Core and uninstall it from your system. Uninstall? (y/n) " answer
if [ "$answer" = "y" ]; then
uninstall_bitcoin_core
fi
else
echo "$WELCOME_TEXT"
if [ -t 0 ]; then
# Prompt for confirmation when invoked in tty.
echo
read -p "Install? (y/n) " answer
else
# Continue installation when invoked via pipe, e.g. curl .. | sh
answer="y"
echo
echo "Starting installation in 10 seconds.."
sleep 10
fi
if [ "$answer" = "y" ]; then
install_dependencies
create_target_dir
stop_bitcoin_core
build_bitcoin_core
install_bitcoin_core
start_bitcoin_core
check_bitcoin_core
print_readme > $TARGET_DIR/README.md
cat $TARGET_DIR/README.md
print_success "If this your first install, Bitcoin Core may take several hours to download a full copy of the blockchain."
print_success "\nInstallation completed!"
fi
fi
print_end