Difference between revisions of "Running a full open node on a Linux server"

From DigiByte Wiki
Jump to: navigation, search
m
(Tidied up)
Line 5: Line 5:
  
 
Basic Linux system administration knowledge is assumed and you may need to install additional packages if an error is encountered.
 
Basic Linux system administration knowledge is assumed and you may need to install additional packages if an error is encountered.
 +
 +
 
  
 
== System Requirements ==
 
== System Requirements ==
Line 12: Line 14:
 
The server needs at least 4GB of RAM and 40 GB disk space to be able to operate smoothly.
 
The server needs at least 4GB of RAM and 40 GB disk space to be able to operate smoothly.
  
 +
 
  
 
== Swap space ==
 
== Swap space ==
  
 
If you are using the minimum of 4GB of memory, it is recommended to have at least 8GB of swap space available. To check the current swap, run the ''free'' command.
 
If you are using the minimum of 4GB of memory, it is recommended to have at least 8GB of swap space available. To check the current swap, run the ''free'' command.
<pre>$ free -hm</pre>
+
<pre>free -h</pre>
 +
 
 +
&nbsp;
  
To add 8GB of swap space, run the following commands as '''root''' user.
+
If you do not have 8GB+ of swap space, you can run the following commands as '''root''' user to create a swapfile.
<pre># fallocate -l 8G /swap
+
<pre>fallocate -l 8G /swap
# chmod 0600 /swap
+
chmod 0600 /swap
# mkswap /swap
+
mkswap /swap
# swapon /swap</pre>
+
swapon /swap</pre>
  
 
Then verify if the swap has been added.
 
Then verify if the swap has been added.
<pre>$ free -hm</pre>
+
<pre>free -h</pre>
  
To make this swap permanent after every boot, edit the file /etc/fstab and add the line:
+
To make this swap permanent after every boot, we will add the required information to the fstab file:
 +
<pre>echo "/swap swap swap defaults 0 0" >> /etc/fstab
 +
</pre>
  
''/swap swap swap defaults 0 0''
+
&nbsp;
  
 
== Create user ==
 
== Create user ==
  
If not already exists, create a user name digibyte&nbsp;as '''root''' user.
+
If a non-root user does not already exist, create a user name digibyte, running the following commands&nbsp;as '''root''' user.
  
 
=== CentOS: ===
 
=== CentOS: ===
<pre># useradd -G wheel digibyte -m -s /bin/bash</pre>
+
<pre>useradd -G wheel digibyte -m -s /bin/bash</pre>
  
 
=== Ubuntu: ===
 
=== Ubuntu: ===
<pre># useradd -G sudo digibyte -m -s /bin/bash</pre>
+
<pre>useradd -G sudo digibyte -m -s /bin/bash</pre>
  
 
Set the password for the new user.
 
Set the password for the new user.
<pre># passwd digibyte</pre>
+
<pre>passwd digibyte</pre>
  
 
Logon as user digibyte.
 
Logon as user digibyte.
<pre># su - digibyte</pre>
+
<pre>su - digibyte</pre>
  
 
&nbsp;
 
&nbsp;
Line 51: Line 58:
 
== Create a DigiByte configuation file ==
 
== Create a DigiByte configuation file ==
  
Execute this command to create a basic DigiByte configuration file. As we are running on a server, there is no need for the wallet and is disabled.
+
First of all we need to create the DigiByte directory for us to put the .conf in:
<pre>$ cat <<EOF > ~/.digibyte/digibyte.conf
+
<pre>mkdir -vp ~/.digibyte</pre>
server=1
+
 
listen=1
+
We will now create a basic DigiByte configuration file. As we are running on a server, there is no need for the wallet functionality and as such we will just relay the blockchain:
 +
<pre>cat <<EOF > ~/.digibyte/digibyte.conf
 
daemon=1
 
daemon=1
maxconnections=150
+
maxconnections=300
 
disablewallet=1
 
disablewallet=1
 
EOF</pre>
 
EOF</pre>
 +
 +
If you are on a bandwidth-limited data connection, you may want to consider decreating the maxconnections, or alternatively look to increase your data plan to a flat-rate unlimited plan.
 +
 +
&nbsp;
  
 
== Install DigiByte software ==
 
== Install DigiByte software ==
  
 
Execute these commands to retrieve and unpack the DigiByte software. If you run on the ARM architecture, you will need to use&nbsp;''digibyte-7.17.2-aarch64-linux-gnu.tar.gz'' instead.
 
Execute these commands to retrieve and unpack the DigiByte software. If you run on the ARM architecture, you will need to use&nbsp;''digibyte-7.17.2-aarch64-linux-gnu.tar.gz'' instead.
<pre>$ cd $HOME
+
<pre>cd ~/
$ wget https://github.com/digibyte/digibyte/releases/download/v7.17.2/digibyte-7.17.2-x86_64-linux-gnu.tar.gz
+
wget -c https://github.com/digibyte/digibyte/releases/download/v7.17.2/digibyte-7.17.2-x86_64-linux-gnu.tar.gz -O - | tar xz
$ tar xvzf digibyte-7.17.2-x86_64-linux-gnu.tar.gz</pre>
+
</pre>
  
Create a symbolic link to make upgrading DigiByte in the future easier.
+
We can now launch the DigiByte daemon (Core Wallet), and it will begin to run as a background process:
<pre>$ cd ~/digibyte-7.17.2
+
<pre>~/digibyte-7.17.2/bin/digibyted
$ ln -s digibyte-7.17.2 digibyte</pre>
+
</pre>
  
This means that binaries now are always available in ''~/digibyte/bin ''regardless of the release number.
+
&nbsp;
  
 
== Add service file ==
 
== Add service file ==
Line 89: Line 101:
 
Type=forking
 
Type=forking
 
PIDFile=/home/digibyte/.digibyte/digibyted.pid
 
PIDFile=/home/digibyte/.digibyte/digibyted.pid
ExecStart=/home/digibyte/digibyte/bin/digibyted -daemon -pid=/home/digibyte/.digibyte/digibyted.pid \
+
ExecStart=/home/digibyte/digibyte-7.17.2/bin/digibyted -daemon -pid=/home/digibyte/.digibyte/digibyted.pid \
 
-conf=/home/digibyte/.digibyte/digibyte.conf -datadir=/home/digibyte/.digibyte -disablewallet
 
-conf=/home/digibyte/.digibyte/digibyte.conf -datadir=/home/digibyte/.digibyte -disablewallet
  
Line 115: Line 127:
 
Type=forking
 
Type=forking
 
PIDFile=/home/digiminer/.digibyte/digibyted.pid
 
PIDFile=/home/digiminer/.digibyte/digibyted.pid
ExecStart=/home/digibyte/digibyte/bin/digibyted -daemon -pid=/home/digiminer/.digibyte/digibyted.pid \
+
ExecStart=/home/digibyte/digibyte-7.17.2/bin/digibyted -daemon -pid=/home/digiminer/.digibyte/digibyted.pid \
 
-conf=/home/digiminer/.digibyte/digibyte.conf -datadir=/home/digiminer/.digibyte -disablewallet
 
-conf=/home/digiminer/.digibyte/digibyte.conf -datadir=/home/digiminer/.digibyte -disablewallet
  
Line 138: Line 150:
 
<pre>$ tail -f ~/.digibyte/debug.log</pre>
 
<pre>$ tail -f ~/.digibyte/debug.log</pre>
  
This should output the current actions or show any error.
+
This should output the current actions or show any error. The initial synchronization of the local block chain can take several hours, but on a decent server will take <2hrs.
 
+
The initial synchronization of the local block chain will take several hours.&nbsp;
+
  
 
If you are behind a router, TCP port 12024 should be forwarded in order run as an open node. See '''''[[Running_a_full_node|Running a full node]]'''''&nbsp;for details.
 
If you are behind a router, TCP port 12024 should be forwarded in order run as an open node. See '''''[[Running_a_full_node|Running a full node]]'''''&nbsp;for details.

Revision as of 14:13, 24 August 2019

These instructions will explain how to run a full open DigiByte node on a Linux server. These are all command line based, so no GUI is required. Ideal to turn your Web Site Server or Email server into a DigiByte full node server.

Separate instructions will become available of how to install a node and optionally the wallet on a Linux Desktop machine.

Basic Linux system administration knowledge is assumed and you may need to install additional packages if an error is encountered.

 

System Requirements

Most Linux distributions are either a Debian (ie Ubuntu) or a Redhat (ie CentOS) variant. Most commands are the same, but where there are differences it will be mentioned.

The server needs at least 4GB of RAM and 40 GB disk space to be able to operate smoothly.

 

Swap space

If you are using the minimum of 4GB of memory, it is recommended to have at least 8GB of swap space available. To check the current swap, run the free command.

free -h

 

If you do not have 8GB+ of swap space, you can run the following commands as root user to create a swapfile.

fallocate -l 8G /swap
chmod 0600 /swap
mkswap /swap
swapon /swap

Then verify if the swap has been added.

free -h

To make this swap permanent after every boot, we will add the required information to the fstab file:

echo "/swap swap swap defaults 0 0" >> /etc/fstab

 

Create user

If a non-root user does not already exist, create a user name digibyte, running the following commands as root user.

CentOS:

useradd -G wheel digibyte -m -s /bin/bash

Ubuntu:

useradd -G sudo digibyte -m -s /bin/bash

Set the password for the new user.

passwd digibyte

Logon as user digibyte.

su - digibyte

 

Create a DigiByte configuation file

First of all we need to create the DigiByte directory for us to put the .conf in:

mkdir -vp ~/.digibyte

We will now create a basic DigiByte configuration file. As we are running on a server, there is no need for the wallet functionality and as such we will just relay the blockchain:

cat <<EOF > ~/.digibyte/digibyte.conf
daemon=1
maxconnections=300
disablewallet=1
EOF

If you are on a bandwidth-limited data connection, you may want to consider decreating the maxconnections, or alternatively look to increase your data plan to a flat-rate unlimited plan.

 

Install DigiByte software

Execute these commands to retrieve and unpack the DigiByte software. If you run on the ARM architecture, you will need to use digibyte-7.17.2-aarch64-linux-gnu.tar.gz instead.

cd ~/
wget -c https://github.com/digibyte/digibyte/releases/download/v7.17.2/digibyte-7.17.2-x86_64-linux-gnu.tar.gz -O - | tar xz

We can now launch the DigiByte daemon (Core Wallet), and it will begin to run as a background process:

~/digibyte-7.17.2/bin/digibyted

 

Add service file

For DigiByte to run as a service and to be able to start automatically upon boot, a service file needs to be installed. Execute the following as root user.

CentOS:

# cat <<EOF > /usr/lib/systemd/system/digibyted.service
[Unit]
Description=DigiByte's distributed currency daemon
After=network.target

[Service]
User=digibyte
Group=digibyte

Type=forking
PIDFile=/home/digibyte/.digibyte/digibyted.pid
ExecStart=/home/digibyte/digibyte-7.17.2/bin/digibyted -daemon -pid=/home/digibyte/.digibyte/digibyted.pid \
-conf=/home/digibyte/.digibyte/digibyte.conf -datadir=/home/digibyte/.digibyte -disablewallet

Restart=always
PrivateTmp=true
TimeoutStopSec=60s
TimeoutStartSec=2s
StartLimitInterval=120s
StartLimitBurst=5

[Install]
WantedBy=multi-user.target
EOF

Ubuntu:

# cat <<EOF > /etc/systemd/system/digibyted.service
[Unit]
Description=DigiByte's distributed currency daemon
After=network.target

[Service]
User=digiminer
Group=digiminer

Type=forking
PIDFile=/home/digiminer/.digibyte/digibyted.pid
ExecStart=/home/digibyte/digibyte-7.17.2/bin/digibyted -daemon -pid=/home/digiminer/.digibyte/digibyted.pid \
-conf=/home/digiminer/.digibyte/digibyte.conf -datadir=/home/digiminer/.digibyte -disablewallet

Restart=always
PrivateTmp=true
TimeoutStopSec=60s
TimeoutStartSec=2s
StartLimitInterval=120s
StartLimitBurst=5

[Install]
WantedBy=multi-user.target
EOF

Enable the service on boot.

$ sudo systemctl enable digibyted.service

Start the service.

$ sudo systemctl start digibyted.service


Check the log file

$ tail -f ~/.digibyte/debug.log

This should output the current actions or show any error. The initial synchronization of the local block chain can take several hours, but on a decent server will take <2hrs.

If you are behind a router, TCP port 12024 should be forwarded in order run as an open node. See Running a full node for details.