quilibrium-node-auto-installer: A Shell repository from robbie-hunt

This is a script to auto-install your Quilibrium node in the easiest way.

♡ Want to say thank you?

Apart from using my referral links below for Cherryservers, you can buy me a cup of something with a small donation, here is my ERC-20 address

0x0fd383A1cfbcf4d1F493Dd71b798ebca89e8a013

Best server to run a Quilibrium node

Cherryservers support Quilibrium, is suggested by Cassie (Quilibrium founder), and they offer good solutions for a fair price. Thank you for using my referral links and supporting my work :-)

Here are some pre-configured server options, take a look. Cloud VDS 4 | E3-1240V3 | E3-1240V5 | E5-1620V4 | E5-1650V3 | E5-1650V4

Node auto-installer: how to use the script

Run the auto-installer script on your server (OS must be Ubuntu 22.04.X)

 wget -O - https://raw.githubusercontent.com/lamat1111/quilibrium-node-auto-installer/master/installer | bash

After installing the node and making some necessary edits, the script will run your node for 5 minutes and then you will be prompted to reboot the system, type "Y" and reboot.
Login again in your server.
Go to the node folder, create a persistent shell (session) and run the poor_mans_cd script. To do all this run these commands one after the other.

cd ceremonyclient/node

tmux new-session -s quil

./poor_mans_cd.sh

To detach from tmux press CTRL+B then D and ENTER. Now you can safely logout from your server and the node will keep running in its persistent shell.

To reattach later to the node session run the following tmux a -t quil The poor_mans_cd script will also restart your node if it gets killed and will auto-update it when there is a new version available.

Backup your keys.yml and config.yml files

Use WinSCP to navigate to the root/ceremonyclient/node/.config folder. You may have to enable visibility for hidden files in WinSCP if you don't see the .config folder. Select Options, Preferences from the main menu, then the Panels tab, and check the option to Show hidden files (Ctrl+Alt+H).

Download locally your keys.yml and config.yml files. Keep them safe and do not share them with anyone!

If you need to migrate the node elsewhere, after installing the node from scratch you just need to put these 2 files in the root/ceremonyclient/node/.config folder (changing the ones automatically created by the node). Here is a quick way to do this.

Tools and resources

To manage your nodes use Termius, the coolest SSH client and terminal around :)
To track your server uptime and resources usage use Hetrixtools.com, you can track up to 15 servers for free and the setup is very easy

Useful server commands.

Check node version

cat ~/ceremonyclient/node/config/version.go | grep -A 1 'func GetVersion() \[\]byte {' | grep -Eo '0x[0-9a-fA-F]+' | xargs printf '%d.%d.%d'

Get node peer ID

cd ~/ceremonyclient/node && GOEXPERIMENT=arenas go run ./... -peer-id

Check QUIL balance

cd ~/ceremonyclient/node && GOEXPERIMENT=arenas /root/go/bin/node -balance

Attach to existing tmux session

tmux a -t quil
#To detach from tmux press CTRL+B then release both keys and press D

Migrate node to a new server

Use the auto-installer script in this guide to install the node on the new server and let it run for 5 minutes.
Grab your new server IP and password.
Login to the old server and run this command. Change <NEW_SERVER_IP> with your new server IP and enter the new server password when requested.

scp -f /root/ceremonyclient/node/.config/keys.yml /root/ceremonyclient/node/.config/config.yml root@<NEW_SERVER_IP>:/root/ceremonyclient/node/.config/

ATTENTION: The command will ovewrite any existing keys.yml and config.yml files in the target server with no confirmation.

The command will move your keys.yml and config.yml to new server. For this to work the node must already be installed in the new server and the .config folder be generated.

Setup the Firewall and gRPC calls

Run the below script to setup the Firewall and gRPC calls automatically. You need to install the node first and let it run for 5 minutes in order to generat its .config folder.

wget -O - https://raw.githubusercontent.com/lamat1111/quilibrium-node-auto-installer/master/installer-gRPC-and-firewall | bash

robbie-hunt/quilibrium-node-auto-installer