Operators
Operator Guides
Maintenance
Automatic Node Upgrade: Nymvisor
Nymvisor Configuration

Nymvisor Configuration

ℹ️

Our documentation often refer to syntax annotated in <> brackets. We use this expression for variables that are unique to each user (like path, local moniker, versions etcetra). Any syntax in <> brackets needs to be substituted with your correct name or version, without the <> brackets. If you are unsure, please check our table of essential parameters and variables (opens in a new tab).

Nymvisor Automation with systemd

This section contains guide how to setup systemd automation for Nymvisor. If you are looking for other chapters, visit these pages: VPS setup, advanced terminal tools like tmux and nohup setup, nym-node automation or validator automation.

ℹ️

Since you're planning to run your node via a Nymvisor instance, as well as creating a Nymvisor .service file, you will also want to stop any previous node automation process you already have running.

SSH to your server as root or become one running sudo -i or su. If you prefer to administrate your VPS from a user environment, supply the commands with prefix sudo.

1. Create a service file

To automate with systemd use this init service file by saving it as /etc/systemd/system/nymvisor.service and follow the next steps.

  • Open service file in a text editor
nano /etc/systemd/system/nymvisor.service
  • Paste this config file, substitute <USER> and <PATH> with your correct values and add all flags to run your nymvisor to ExecStart line instead of <ARGUMENTS>:
[Unit]
Description=Nymvisor <VERSION>
StartLimitInterval=350
StartLimitBurst=10
 
[Service]
User=<USER> # replace this with whatever user you wish
LimitNOFILE=65536
ExecStart=<PATH>/nymvisor run <ARGUMENTS>
KillSignal=SIGINT
Restart=on-failure
RestartSec=30
 
[Install]
WantedBy=multi-user.target
  • Save config and exit
2. Following steps for nymvisor running as systemd service

Once your service file is saved follow these steps.

  • Reload systemctl to pickup the new unit file:
systemctl daemon-reload
  • Enable the newly created service:
systemctl enable nymvisor.service
  • Start your Nymvisor instance as a systemd service:
service nymvisor start

This will cause your Nymvisor instance to start at system boot time. If you restart your machine, your service will come back up automatically.

3. Useful systemd commands for easier management
  • You can monitor system logs of your node by running:
journalctl -u nymvisor -f
  • Or check service status by running:
systemctl status nymvisor.service
# for example systemctl status nymvisor.service
  • You can also do service nymvisor stop or service nymvisor restart.
4. Anytime you make any changes to your systemd script after you've enabled it, you will need to run:
systemctl daemon-reload
service nymvisor restart

This lets your operating system know it's ok to reload the service configuration and restarts the node in a graceful way.

Automatic Node Upgrade: NymvisorPerformance Monitoring & Testing