README.md

Cardano Node Version Manager

Convenience commands for running a Cardano Node.

These scripts assume you followed the Armada Alliance environment setup.

🗄 Table of contents

• Cardano Node Version Manager
  • 🗄 Table of contents
  • 🧰 How to install
  • 📚 How to use
    • cnvm
      • $ cnvm install-binaries
      • $ cnvm download-config-files
      • $ cnvm download-snapshot
      • $ cnvm upgrade
      • $ cnvm upgrade-self
    • sysup

🧰 How to install

bash <(curl -Ls https://github.com/HofmannZ/cnvm/raw/master/scripts/install.sh)

📚 How to use

After installing you can use the following commands to manage your Cardano stake pool.

cnvm

Convenience alias to update your Cardano node binaries.

$ cnvm install-binaries

Installs the cardano-node, cardano-cli, and cardano-submit-api binaries. Version defaults to 8.9.4, use:

cnvm install-binaries

or for a specific version:

cnvm install-binaries 8.9.2

or with restart:

cnvm install-binaries --restart

$ cnvm download-config-files

Downloads and patches the latest cardano config files. Defaults to relay, use:

cnvm download-config-files

or for Block Producer:

cnvm download-config-files --producer

CNVM does not override your topology by default.

Use with the --topology flag to override the topology:

cnvm download-config-files --topology

$ cnvm download-snapshot

Downloads the latest database snapshot from csnapshots.io. Use:

cnvm download-snapshot

Make use you have stopped you cardano-node!

Or use with the --restart flag to automatically stop/start:

cnvm download-snapshot --restart

$ cnvm upgrade

Upgrades binaries and downloads the latest cardano config files. Optionally downloads the latest snapshot. Version defaults to 8.9.4, use:

cnvm upgrade

or for a specific version:

cnvm upgrade 8.9.2

or with snapshot:

cnvm upgrade --snapshot

or for Block Producer:

cnvm upgrade --producer

or with restart:

cnvm upgrade --restart

The underlying algorithm:

1. Stop the cardano-node (Optional via --restart flag).
2. Download the latest binaries (defaults to 8.9.4).
3. Download the latest node files (with the exception of the topology file).
4. Download the latest database snapshot from csnapshots.io. (Optional via --snapshot flag).
5. Start the cardano-node (Optional via --restart flag).

$ cnvm upgrade-self

Upgrades to the latest version of this script. Use:

cnvm upgrade-self

sysup

Convenience alias to update your system.

Wil run sudo apt update && sudo apt upgrade -y.