Created by LaMAt - connect with me on Farcaster or Twitter

♡ Want to say thank you?

Apart from using my referral links below for Cherryservers and other providers, 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
• Node auto-installer: how to use the script
• Backup Your keys.yml and config.yml Files
• Setup the Firewall and gRPC Calls
• Tools and resources
• Useful Server Commands
• Commands for token transfers
• Migrate Node to a New Server
• Set SSH keys
• Troubleshooting

Here some good options. This section is still under construction as I collect reviews from others. Thank you for using my referral links and supporting my work :-)

• Cherryservers
  They support Quilibrium and are recommended by Cassie, the founder of the project.
  Here are some pre-configured server options: Cloud VDS 4 / E3-1240V3 / E3-1240V5 / E5-1620V4 / E5-1650V3 / E5-1650V4
• Latitude
• Perfect Quality Hosting
• Blue VPS

Only use these VPS after Quilibrium version 1.5 to avoid issues

• Contabo (any location outside of EU)
• Hostinger

Contabo and Hostinger got a lot of hate from the community (and for good reasons). These cheap VPS will never perform great, but they do work. After mainnet (1.5) the node resource consumption will be much lower, and you will be able to use these cheaper services without the risk of being throttled by the provider. On the other hand... lower specs nodes will also earn fewer rewards. Your choice!

If you are reinstalling your existing node, be sure to backup your keys.yml and config.yml files, they are in the root/ceremonyclient/node/.config folder. How do I do this?

Rent a server with at least 8 cores (best 12), 16 GB RAM (best 32), 250 GB SSD space (best 500), and 400 Mbit/s symmetric bandwidth.
(After Quilibrium 1.5 min specs will be: 4 cores, 8 GB RAM, and 400 Mbit/s symmetric bandwidth. Outbound traffic after 1.5 should be up to 5 TB per month ((raw approximation)), depending on how you set the node)
Also refer to the Quilibrium official docs.
If you can afford better specs than the minimum, your node will earn more rewards.

VDS (Virtual Dedicated Servers) and Bare Metal (Physical dedicated Servers) are your best choiche. Using a VPS (Virtual Private Server) may give you issues as often the providers oversell the resources. The community had a really bad experience with Contabo for instance.
That being said, after 1.5 is out a VPS or a home machine may work just fine.

Install the OS Ubuntu 22.04.X.
If your server has two disks, consider configuring them in "RAID 1" (typically offered by your provider). This setup mirrors one disk to the other, providing redundancy and safeguarding against data loss in case one disk fails.

Run the auto-installer script on your server (OS must be Ubuntu 22.04.X). I suggest you to use Termius to login

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

Auto-installer script for Almalinux 8 (untested)

The below script has not been tested yet, run it at you own risk!

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

After installing the node and making some necessary edits, the script will run your node for 10 minutes and then you will be prompted to reboot the system, type "Y" and reboot.

Wait 3 minutes, then login again in your server.

Run the command below. This will go to the node folder, create a persistent shell (session), start the node via the poor_mans_cd script (more info about this script below) and detach from the session again. You won't see any output after running the command, but you can move to Step 7.

cd ceremonyclient/node && tmux new-session -d -s quil './poor_mans_cd.sh'

Alternative: step by step commands

You can also run these command one after the other if you prefer.

cd ceremonyclient/node 

tmux new-session -s quil 

./poor_mans_cd.sh

To detach from tmux press CTRL+B then D. Now you can safely logout from your server and the node will keep running in its persistent shell.
To reattach to the tmux session and see your node log, just use tmux a -t quil. You can recognize when you are inside your tmux session because there will be a green bar at the bottom of the screen.
To stop the node, from inside tmux click CTRL+C
To restart the node, from inside tmux run ./poor_mans_cd.sh

The poor_mans_cd is a script used to run the node. It will also restart it, if it gets killed and will auto-update it when there is a new version available.

You are done! Now you can safely logout from your server and the node will keep running in its persistent shell.

If you want to see you node log you can reattach to the tmux session with tmux a -t quil
Once you are in the tmux session a green bar will appear at the bottom of the screen, to detach from tmux press CTRL+B then D.
It will usually takes 15-30 minutes before you will begin to see new log entries in the node log.

Let you node run for at least 30 minutes, then proceed to backup your your keys.yml and config.yml files, and setup your gRPC calls

This is optional, but recommended! Setup SSH keys to connect to your server and disable the password connection. Here is a guide to do this
To enhance even more your server security, you may install and setup Fail2ban, here is a guide.

After you node has been running for at least 30 minutes, run this command from your root folder to check the node info (Node version, Peer ID, Quil balance).
For this to work you need to setup the gRPC calls first.
If you have enabled the gRPC calls but you still get an error, it usually just means that your node needs to run some more in order to correctly connect to the newtork. Retry later.

cd /root/ceremonyclient/node && GOEXPERIMENT=arenas go run ./... -node-info

If the above command does not work, or you have not set the gRPC calls, there are alternative commands to check you PeerID and node version, just look in Useful Server Commands

After 30 minutes that then node has been running, it should have generated your keys and config files correctly. Use WinSCP or Termius SFTP feature 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! Is a good idea to put them in an encrypted folder using a free tool such as Encrypto

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.

These stpes are recommended but not requested for the node to work. Even if you receive errors, your node should not be affected and keep running normally.

Run the below script to setup the Firewall.

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

After your node has been running for 30 minutes, run the below script to setup the gRPC calls.

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

sudo apt update && sudo apt install vnstat

sudo apt-get install curl
curl -s https://packagecloud.io/install/repositories/ookla/speedtest-cli/script.deb.sh | sudo bash
sudo apt-get install speedtest

sudo apt update && sudo apt install htop

• 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
• If you need help come to the Quilibrium Community Discord or the Quilibrium Telegram group

• Website and Whitepaper
• Quilibrium channel on Warpcast
• Quilibrium "builders" channel on Warpcast
• Quilibrium blog
• Founder blog

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

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

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

cd ~/ceremonyclient/node && GOEXPERIMENT=arenas go run ./... --db-console

tmux a -t quil

cd ceremonyclient/node && tmux new-session -d -s quil './poor_mans_cd.sh' && tmux detach

echo '@reboot sleep 10 && bash -lc "export PATH=$PATH:/usr/local/go/bin && cd ~/ceremonyclient/node && tmux new-session -d -s quil '\''./poor_mans_cd.sh'\''"' | crontab -

pkill node && pkill -f "go run ./..."

sudo rm -r /root/ceremonyclient/node/.config/store

mkdir -p /root/backup && cp /root/ceremonyclient/node/.config/config.yml /root/backup && cp /root/ceremonyclient/node/.config/keys.yml /root/backup

cp /root/backup/{config.yml,keys.yml} /root/ceremonyclient/node/.config/

go install github.com/fullstorydev/grpcurl/cmd/grpcurl@latest

/root/go/bin/grpcurl -plaintext -max-msg-sz 5000000 localhost:8337 quilibrium.node.node.pb.NodeService.GetPeerInfo | grep peerId | wc -l

1. Use the auto-installer script in this guide to install the node on the new server and let it run for 10 minutes (or for the time necessary for the root/ceremonyclient/node/.config folder to appear) then stop it with CTRL+C . This step is clearly optional if you have already installed the node.
2. Grab your new server IP and password.
3. 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.

Alternatively you can migrate the files manually. If you already have a local backup of the config.yml and keys.yml files, you just need to upload them to your new server in the folder root/ceremonyclient/node/.config . You can use use WinSCP to do this.

Here is a comprehensive guide on how to set up SSH keys on your server.

Alternatively, you can use Termius, which offers a simpler method as outlined below:

1. Install Termius and follow this guide to generate an SSH key. Remember to securely store your key, either in an encrypted folder on your computer or on an encrypted USB drive.
2. Through Termius, you can easily export the SSH key to your host and create an identity as explained in the guide.
3. Test that you can successfully connect to the server using this SSH key.
4. If you have multiple nodes or servers, you can use the same SSH key for all of them.
5. Once logged into your server, run sudo nano /etc/ssh/sshd_config.
6. Scroll down using the down arrow until you locate the line # PasswordAuthentication yes. Uncomment the line (remove #) and set it to no, like so: PasswordAuthentication no.
7. To save the changes, press CTRL+X, then Y, then ENTER.
8. Restart your SSH service by running sudo systemctl restart ssh.

Now, you should only be able to access the server via SSH key, and password-based access will no longer work.

cd root

pkill node && pkill -f "go run ./..."

tmux a -t quil

./poor_mans_cd.sh

sudo swapoff /swap/swapfile 2>/dev/null; sudo sed -i '/\/swap\/swapfile/d' /etc/fstab; sudo rm /swap/swapfile 2>/dev/null; sudo rmdir /swap 2>/dev/null || sudo rm -rf /swap

sudo rm -rf /usr/local/go && sudo rm -rf /root/ceremonyclient

echo -e "\nexport PATH=\$PATH:/usr/local/go/bin:\$HOME/go\nexport GOEXPERIMENT=arenas" >> ~/.bashrc

export PATH=$PATH:/usr/local/go/bin:$HOME/go
export GOEXPERIMENT=arenas

export PATH=$PATH:/usr/local/go/bin:$HOME/go
export GOEXPERIMENT=arenas

./poor_mans_cd.sh

This guide and the script are unofficial and made just to support the project