[DOC]: Edit commands and text flow (#4337)

* syntax hotfix

erase a white space

* edit numbering

* edit numbering

* edit numbering

* syntax edit

* syntax edit
This commit is contained in:
serinko
2024-01-18 11:30:10 +00:00
committed by GitHub
parent d6d36364b0
commit ae602ae771
5 changed files with 18 additions and 18 deletions
@@ -13,13 +13,13 @@ NymVPN is an experimental software and it's for [testing](./testing.md) purposes
```sh
sha256sum ./nym-vpn-cli_0.1.0_ubuntu-22.04_amd64.zip
```
2. Compare the output with the sha256 hash shared on the [release page]({{nym_vpn_latest_binary_url}})
3. Extract files with `unzip` command or manually as you are used to
4. Make executable by running:
3. Compare the output with the sha256 hash shared on the [release page]({{nym_vpn_latest_binary_url}})
4. Extract files with `unzip` command or manually as you are used to
5. Make executable by running:
```sh
chmod u+x ./nym-vpn-cli
```
5. Create Sandbox environment config file by saving [this](https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env) as `sandbox.env` in the same directory as your NymVPN binaries by running:
6. Create Sandbox environment config file by saving [this](https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env) as `sandbox.env` in the same directory as your NymVPN binaries by running:
```sh
curl -o sandbox.env -L https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env
```
@@ -17,13 +17,13 @@ sha256sum ./nym-vpn-cli_0.1.0_macos_x86_64.zip
# aarch64
sha256sum ./nym-vpn-cli_0.1.0_macos_aarch64.zip
```
2. Compare the output with the sha256 hash shared on the [release page]({{nym_vpn_latest_binary_url}})
3. Extract files with `unzip` command or manually as you are used to
4. Make executable by running:
3. Compare the output with the sha256 hash shared on the [release page]({{nym_vpn_latest_binary_url}})
4. Extract files with `unzip` command or manually as you are used to
5. Make executable by running:
```sh
chmod u+x ./nym-vpn-cli
```
5. Create Sandbox environment config file by saving [this](https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env) as `sandbox.env` in the same directory as your NymVPN binaries by running:
6. Create Sandbox environment config file by saving [this](https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env) as `sandbox.env` in the same directory as your NymVPN binaries by running:
```sh
curl -L "https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env" -o sandbox.env
```
+1 -1
View File
@@ -40,5 +40,5 @@ sudo ./execute-nym-vpn-cli-binary.sh
- `do you want five hop or two hop?`: type `five` or `two`
- `enable WireGuard? (yes/no):` if you chose yes, find your private key and wireguard IP [here](https://nymvpn.com/en/alpha)
6. To run the `nym-vpn-cli` again, reconnect your wifi and follow the easy steps for [Linux](cli-linux.md#run-nymvpn) or [MacOS](cli-mac.md#run-nymvpn)
6. To run `nym-vpn-cli` again, reconnect your wifi and follow the easy steps for [Linux](cli-linux.md#run-nymvpn) or [MacOS](cli-mac.md#run-nymvpn)
@@ -15,13 +15,13 @@ NymVPN is an experimental software and it's for [testing](./testing.md) purposes
```sh
sha256sum ./nym-vpn-ui_0.0.2_ubuntu-22.04_amd64.zip
```
2. Compare the output with the sha256 hash shared on the [release page]({{nym_vpn_latest_binary_url}})
3. Extract files with `unzip` command or manually as you are used to
4. If you prefer to run `.AppImage` make executable by running:
3. Compare the output with the sha256 hash shared on the [release page]({{nym_vpn_latest_binary_url}})
4. Extract files with `unzip` command or manually as you are used to
5. If you prefer to run `.AppImage` make executable by running:
```sh
chmod u+x ./appimage/nym-vpn_0.0.2_amd64.AppImage
```
5. If you prefer to use the `.deb` version for installation (Linux only), open terminal in the same directory and run:
6. If you prefer to use the `.deb` version for installation (Linux only), open terminal in the same directory and run:
```sh
cd deb
@@ -33,16 +33,16 @@ sudo apt-get install -f ./nym-vpn_0.0.2_amd64.deb
### Configuration
6. Create a NymVPN config directory called `nym-vpn` in your `~/.config`, either manually or by a command:
7. Create a NymVPN config directory called `nym-vpn` in your `~/.config`, either manually or by a command:
```sh
mkdir $HOME/.config/nym-vpn/
```
7. Create the network config by saving [this](https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env) as `sandbox.env` in the directory `~/.config/nym-vpn/` you just created by running:
8. Create the network config by saving [this](https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env) as `sandbox.env` in the directory `~/.config/nym-vpn/` you just created by running:
```sh
curl -o $HOME/.config/nym-vpn/sandbox.env -L https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env
```
8. Create NymVPN main config file called `config.toml` in the same directory `~/.config/nym-vpn/` with this content:
9. Create NymVPN main config file called `config.toml` in the same directory `~/.config/nym-vpn/` with this content:
```toml
# change <USER> to your username
env_config_file = "/home/<USER>/.config/nym-vpn/sandbox.env"
+2 -2
View File
@@ -16,7 +16,7 @@ We wrote a [script](https://gist.github.com/tommyv1987/7d210d4daa8f7abc61f9a696d
1. To download the script, open a terminal in a directory where you want to download the script and run:
```sh
curl -o nym-vpn-client-installer.sh - L https://gist.githubusercontent.com/tommyv1987/7d210d4daa8f7abc61f9a696d0321f19/raw/181968941ce268a3937e82239ddfd293dd96bb60/nym-vpn-client-installer.sh
curl -o nym-vpn-client-installer.sh -L https://gist.githubusercontent.com/tommyv1987/7d210d4daa8f7abc61f9a696d0321f19/raw/181968941ce268a3937e82239ddfd293dd96bb60/nym-vpn-client-installer.sh
```
2. Make the script executable
```sh
@@ -33,7 +33,7 @@ sudo ./nym-vpn-client-installer.sh
```
5. The script will run the application and it will prompt you for a country code to exit, chose one of the offered options in the same format as listed
6. To run the application again, reconnect your wifi and run
6. To start the application again, reconnect your wifi and run
```sh
# Linux
sudo -E ~/nym-vpn-latest/nym-vpn_0.0.2_amd64.AppImage