|
1 | 1 | ## Availup |
2 | 2 | To run an Avail light client, simply run the following command: |
3 | 3 | ```bash |
4 | | -curl -sL1 avail.sh | sh |
| 4 | +curl -sL1 avail.sh | bash |
5 | 5 | ``` |
6 | 6 | or, with `wget`: |
7 | 7 | ```bash |
8 | | -wget --https-only --secure-protocol=TLSv1_2 --quiet -O - avail.sh | sh |
| 8 | +wget --https-only --secure-protocol=TLSv1_2 --quiet -O - avail.sh | bash |
9 | 9 | ``` |
10 | 10 | You can pass additional flags to the script like: |
11 | 11 | ```bash |
12 | | -curl -sL1 avail.sh | sh -s -- --network goldberg |
| 12 | +curl -sL1 avail.sh | bash -s -- --network goldberg |
13 | 13 | ``` |
14 | 14 | Currently available flags are: |
15 | | -* `network`: can be one of the following: [`kate`, `goldberg`, `local`] |
| 15 | +* `network`: can be one of the following: [`goldberg`, `local`] |
16 | 16 | * `config`: path to the configuration file, availup will generate a config if this flag is not specified |
| 17 | +* `identity`: path to the identity file, availup will generate a config if this flag is not specified |
17 | 18 | * `app_id`: application ID to run the light client (defaults to `0`) |
18 | 19 | * `upgrade`: takes `y` and `yes` as valid arguments, indicating that the `avail-light` binary should be upgraded |
19 | 20 |
|
20 | 21 | You can modify the existing default config by running and rerun `availup` to use the new config: |
21 | 22 | ```bash |
22 | 23 | # create the config: |
23 | | -touch ~/config.yml |
| 24 | +touch ~/.avail/config/config.yml |
24 | 25 | # edit the config: |
25 | | -nano ~/config.yml |
| 26 | +nano ~/.avail/config/config.yml |
26 | 27 | # and rerunning the script: |
27 | | -curl -sL1 avail.sh | sh -s -- --config ~/config.yml |
| 28 | +curl -sL1 avail.sh | bash -s -- --config ~/.avail/config/config.yml |
28 | 29 | ``` |
29 | 30 |
|
30 | 31 | Alternatively, you can pass a specific application ID with `availup`: |
31 | 32 | ```bash |
32 | 33 | rm ~/.avail/goldberg/config.yml |
33 | 34 | # and rerunning the script with flags: |
34 | | -curl -sL1 avail.sh | sh -s -- --app_id 1 |
| 35 | +curl -sL1 avail.sh | bash -s -- --app_id 1 |
35 | 36 | ``` |
36 | 37 |
|
37 | 38 | To upgrade the light client to a latest version, you can simply pass the `--upgrade` flag like: |
38 | 39 | ```bash |
39 | | -curl -sL1 avail.sh | sh -s -- --upgrade y |
| 40 | +curl -sL1 avail.sh | bash -s -- --upgrade y |
40 | 41 | ``` |
0 commit comments