Skip to main content

Сonfiguring a node as a Linux service

Prerequisites

You need to download or compile the gear-node executable file for your OS. See more

Configuration

Copy the gear-node executable to the /root directory:

sudo cp gear-node /root/

To run the Gear node as one of the Linux services, you need to configure the systemd file:

cd /etc/systemd/system
sudo nano gear-node.service

Configure and save:

[Unit]
Description=Gear Node
After=network.target

[Service]
Type=simple
User=root
WorkingDirectory=/root/
ExecStart=/root/gear-node --name 'NODE_NAME' --telemetry-url 'ws://telemetry-backend-shard.gear-tech.io:32001/submit 0'
Restart=always
RestartSec=3
LimitNOFILE=10000

[Install]
WantedBy=multi-user.target
note

Declaration ExecStart points to the location of the gear-node binary file. In this case, it is in root directory. With -- additional launch parameters are indicated, but not mandatory.

That’s it. We can now start the service.

Starting the node

Run to start the service:

sudo systemctl start gear-node

Automatically get it to start on boot:

sudo systemctl enable gear-node

How to check status of gear-node service?

sudo systemctl status gear-node

Checking logs

You may see the service logs by running the following command:

journalctl -u gear-node

Use navigation keys to browse the logs and q key to exit.

You may see the last 50 lines of logs by adding -n 50 parameter:

journalctl -u gear-node -n 50

Add -f parameter to see the last lines of logs in continuous mode (press Ctrl+C to exit):

journalctl -u gear-node -fn 50

Update the node with the new version

You just need to replace the node executable (gear-node) with the latest version and restart the execution. For example, if your Linux executable is located at /root/gear-node (as we've configured above) you are to run:

wget https://builds.gear.rs/gear-nightly-linux-x86_64.tar.xz
sudo tar -xvf gear-nightly-linux-x86_64.tar.xz -C /root
rm gear-nightly-linux-x86_64.tar.xz
sudo systemctl restart gear-node

Remove the node

You are to remove the node's storage, the service configuration, and the executable itself:

sudo systemctl stop gear-node
sudo systemctl disable gear-node
sudo rm -rf /root/.local/share/gear-node
sudo rm /etc/systemd/system/gear-node.service
sudo rm /root/gear-node