/
PM2 / Monit - Migration to systemd

PM2 / Monit - Migration to systemd

Jul 27, 2020

Ensure you are logged in as the non-root user being used to run zend and the node tracker

  • Install packages from the official guide

  • Stop tracker with pm2

  • Upgrade tracker to version 10.12.0

  • Create systemd unit for the node tracker

  • Start tracker with systemd

  • Stop zend with monit

  • Create systemd unit for zend

  • Start zend with systemd

  • Check status of zend and zentracker

  • Enable service units at boot

  • Ensure Firewall is monitored by systemd

  • Kill and remove pm2

  • Remove and purge monit

  • acme.sh - Migration to certbot


Description

Command

Description

Command

1

Install the universe repository and packages for certbot and ensure other packages are installed and up to date from the official guide

sudo apt install software-properties-common -y

Skip adding the universe repository on Debian systems, DO NOT SKIP THE OTHER ENTRIES IN THIS STEP

sudo add-apt-repository universe -y

Be sure to copy the entire command, especially for long command strings

sudo apt-get install build-essential software-properties-common apt-transport-https lsb-release dirmngr pwgen git jq ufw curl aria2 -y
2

Update the package cache

sudo apt-get update
3

Install curl and add the nodejs repository and update the package cache



NOTE: Skip this step for Ubuntu

Debian 9 only

sudo apt-get install curl -y curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash - sudo apt-get update
4

Install npm, upgrading it to the version 10.12.0

sudo apt-get install npm -y && sudo npm install -g n && sudo n 10.12.0
5

Stop the node tracker

NOTE: If for some reason you have more than one tracker running in pm2, you may have to change "0" to the number that corresponds with your tracker, and stop those as well. You can get a listing of the numbers from running: pm2 list

pm2 stop 0
6

Change directory to where the node tracker was cloned, this will be ~/nodetracker for the official guide and typically ~/zencash/secnodetracker for older documentation or other guides

cd ~/nodetracker

Perform the following command if the above command fails due to the directory not existing

mv ~/zencash/secnodetracker ~/nodetracker && cd ~/nodetracker
7

Update git with the new repository URL and retrieve the latest source code

git checkout -- package.json git remote set-url origin https://github.com/HorizenOfficial/nodetracker.git git fetch origin git checkout master git pull

NOTE: If git returns an error regarding any files run the following command (replacing 'filename with the file returned in the error message) and repeat the commands above

git checkout -- filename
8

Install the latest set of node modules required for the tracker

npm install
9

Only perform steps 9 and 10 if this has not already been ran. If you have already upgraded to nodetracker 0.3.1 this would have already been completed.

10

Locate your node's public IPv4 and/or IPv6 address(es) and append them to the zen.conf file as external IP address(es) connected over port 9033 (default)

ONLY SUPER NODES ARE REQUIRED TO PERFORM EVERY COMMAND IN THIS STEP

SECURE NODES REQUIRE AT LEAST ONE EXTERNAL ADDRESS AND PORT APPENDED INTO ZEN.CONF

NOTE: Secure Nodes only require one type of IP, Super Nodes require both

NOTE: Replace <IPv4> with the public IPv4 of your node, remove <brackets>

NOTE: Replace <IPv6> with the public IPv6 of your node in compressed notation without leading zeros, remove <brackets>

Use the following link to ensure your IPv6 address is in compressed notation:

https://www.ultratools.com/tools/ipv6Compress

Create environmental variables for IPv4

IPV4=<IPv4>

Append external IPv4 into zen.conf

echo "externalip=$IPV4" >> ~/.zen/zen.conf

Create environmental variables for IPv6

IPV6=<IPv6>

Append external IPv6 into zen.conf

echo "externalip=$IPV6" >> ~/.zen/zen.conf

Append port into zen.conf - SECURE AND SUPER

echo "port=9033" >> ~/.zen/zen.conf
11

Run node setup again to refresh the list of tracker servers and initialise the new tracker, press enter through each of the values to retain the current set

  • Enter 'secure' for the 'node category' prompt

node setup.js
12

Stop zend with monit, then stop monit. Both commands are shown to stop via systemctl and sysinit (only one should be needed, but both are here for completeness)

sudo monit stop zend && sleep 8 sudo systemctl stop monit sudo service monit stop
13

Create a systemd unit file for zend, copy and paste the entire block of text

echo \ "[Unit] Description=Zen daemon [Service] User=$USER Type=forking ExecStart=/usr/bin/zend -daemon -pid=$HOME/.zen/zend.pid PIDFile=$HOME/.zen/zend.pid Restart=always RestartSec=10 [Install] WantedBy=multi-user.target" | sudo tee /lib/systemd/system/zend.service
14

Test the zend unit file

sudo systemctl start zend && sleep 30
15

Create a systemd unit file for the Node Tracker, copy and paste the entire block of text

echo \ "[Unit] Description=Zen node daemon installed on ~/nodetracker/ [Service] User=$USER Type=simple WorkingDirectory=$HOME/nodetracker/ ExecStart=$(which node) $HOME/nodetracker/app.js Restart=always RestartSec=10 [Install] WantedBy=multi-user.target" | sudo tee /lib/systemd/system/zentracker.service
16

Test the tracker unit file

sudo systemctl start zentracker
17

Follow the tracker output log to check everything looks OK, if all appears fine, exit with CTRL+c

sudo journalctl -fu zentracker



18

Check the status of both zend and the tracker, both should return active (running). If the status doesn't send you back to a command prompt, exit the status details by pressing CTRL + c

sudo systemctl status zend zentracker



19

If both work correctly, enable them at boot

sudo systemctl enable zend zentracker
20

Use systemctl to enable the firewall

NOTE: Many guides lacked enabling this under systemctl

If the firewall is not installed, see: Part 5 - Securing the Host

sudo ufw -f enable sudo systemctl start ufw sudo systemctl enable ufw sudo systemctl status ufw



21

Remove pm2 from startup

sudo rm /etc/systemd/system/pm2* sudo rm /etc/systemd/system/multi-user.target.wants/pm2*
22

Kill and remove PM2 (if all of the above executed without error)

You may see a message about updating npm, you may ignore this

pm2 kill sudo npm remove pm2 -g sudo rm -r ~/.pm2





23

Remove monit from startup (you may not require both commands, both are present to accommodate either systemd, or init script)

Run both commands if you're unsure of which way monit was configured



NOTE: It is expected that you will see an error if you execute the command that doesn't correspond with how monit was setup. You can safely dismiss errors from the one command of the two presented here.

sudo systemctl disable monit sudo update-rc.d monit remove
24

Remove and purge monit from system and remove old repositories (if all of the above executed without error)



sudo apt-get remove monit -y sudo apt-get purge monit -y sudo apt-get -y autoremove rm -rf ~/zen_node.sh
25

acme.sh - Migration to certbot