Skip to content

Latest commit

 

History

History
40 lines (37 loc) · 1.29 KB

README.md

File metadata and controls

40 lines (37 loc) · 1.29 KB

Availup

To run an Avail light client, simply run the following command:

curl -sL1 avail.sh | sh

or, with wget:

wget --https-only --secure-protocol=TLSv1_2 --quiet -O - avail.sh | sh

You can pass additional flags to the script like:

curl -sL1 avail.sh | sh -s -- --network goldberg

Currently available flags are:

  • network: can be one of the following: [kate, goldberg, local]
  • config: path to the configuration file, availup will generate a config if this flag is not specified
  • app_id: application ID to run the light client (defaults to 0)
  • upgrade: takes y and yes as valid arguments, indicating that the avail-light binary should be upgraded

You can modify the existing default config by running and rerun availup to use the new config:

# create the config:
touch ~/config.yml
# edit the config:
nano ~/config.yml
# and rerunning the script:
curl -sL1 avail.sh | sh -s -- --config ~/config.yml

Alternatively, you can pass a specific application ID with availup:

rm ~/.avail/goldberg/config.yml
# and rerunning the script with flags:
curl -sL1 avail.sh | sh -s -- --app_id 1

To upgrade the light client to a latest version, you can simply pass the --upgrade flag like:

curl -sL1 avail.sh | sh -s -- --upgrade y