Node-manager Documentation

Development Documentation, Manuals, Wikis
1

Frameworking and layout work - hide details seems to be the best way to be readable without it being daunting to open. Other suggestions welcome.

Quickstart
Linux

Get safeup and get the latest version of node manager:

curl -sSL https://raw.githubusercontent.com/maidsafe/safeup/main/install.sh | bash
safeup node-manager

You can also specify a specific version of node-manager by adding --version {version_number} to the end

Add your nodes:

  • From a home network (normal router) with no port forwarding
sudo $HOME/.local/bin/safenode-manager add --count {number_of_nodes} --home-network
  • From home network with port forwarding
sudo $HOME/.local/bin/safenode-manager add --count {number_of_nodes} --node-port {start_port}-{start_port + number_of_nodes}
  • from VPS or other open network the command is the same as port forwarding above.

At this point your nodes are added as services, but they are not currently running. You can start them with:

sudo $HOME/.local/bin/safenode-manager start --interval 10000

This will start all services that are not currently running. --interval is an optional flag and not really needed if you’re starting a few nodes. Once you start pushing the node count higher it is highly recommended. Time is in milliseconds so the above command will wait 10 seconds between starting nodes.

You can get the status of all of your nodes by running

safenode-manager status

Status has an optional flag --details which will give much more detailed information about your nodes.

Windows

I haven’t gotten it working yet. Could use this tutorial myself if someone wants to write it.

Command overview

Usage: safenode-manager [OPTIONS] <COMMAND>

Commands:
  add      Add one or more safenode services
  daemon   Manage Daemon service
  faucet   Manage faucet services
  kill     Kill the running local network
  join     Join an existing local network
  remove   Remove safenode service(s)
  run      Run a local network
  start    Start safenode service(s)
  status   Get the status of services
  stop     Stop safenode service(s)
  upgrade  Upgrade safenode services
  help     Print this message or the help of the given subcommand(s)

Options:
  -v, --verbose...  
  -h, --help        Print help
  -V, --version     Print version
3 Likes