diff --git a/documentation/dev-portal/book.toml b/documentation/dev-portal/book.toml index 9f57151580..8533a08344 100644 --- a/documentation/dev-portal/book.toml +++ b/documentation/dev-portal/book.toml @@ -33,8 +33,10 @@ wallet_release_version = "1.2.8" # nym-vpn related variables nym_vpn_releases = "https://github.com/nymtech/nym-vpn-client/releases" nym_vpn_form_url = "https://opnform.com/forms/nymvpn-user-research-at-37c3-yccqko-2" -nym_vpn_gui_version = "0.0.6" -nym_vpn_cli_version = "0.0.4" + +# versions are pulled by cmdrun now +# nym_vpn_gui_version = "0.0.6" +# nym_vpn_cli_version = "0.0.4" [preprocessor.last-changed] command = "mdbook-last-changed" diff --git a/documentation/dev-portal/src/nymvpn/cli-linux.md b/documentation/dev-portal/src/nymvpn/cli-linux.md index fcf80f84a2..2c8f932e0a 100644 --- a/documentation/dev-portal/src/nymvpn/cli-linux.md +++ b/documentation/dev-portal/src/nymvpn/cli-linux.md @@ -9,24 +9,28 @@ NymVPN is an experimental software and it's for [testing](./testing.md) purposes > Any syntax in `<>` brackets is a user's/version unique variable. Exchange with a corresponding name without the `<>` brackets. 1. Open Github [releases page]({{nym_vpn_releases}}) and download the binary for Debian based Linux -2. Verify sha hash of your downloaded binary with the one listed on the [releases page]({{nym_vpn_releasesl}}). You can use a simple `shasum` command and compare strings (ie with Python) or run in the same directory the following command, exchanging `` with the one of your binary, like in the example: + +2. Verify sha hash of your downloaded binary with the one listed on the [releases page]({{nym_vpn_releases}}). You can use a simple `shasum` command and compare strings (ie with Python) or run in the same directory the following command, exchanging `` with the one of your binary, like in the example: ```sh echo "" | shasum -a 256 -c # choose a correct one according to your binary, this is just an example -# echo "0e4abb461e86b2c168577e0294112a3bacd3a24bf8565b49783bfebd9b530e23 nym-vpn-cli_{{nym_vpn_cli_version}}_ubuntu-22.04_amd64.zip" | shasum -a 256 -c +# echo "0e4abb461e86b2c168577e0294112a3bacd3a24bf8565b49783bfebd9b530e23 nym-vpn-cli__ubuntu-22.04_amd64.tar.gz" | shasum -a 256 -c ``` -1. Extract files: + +3. Extract files: ```sh -tar -xvf +tar -xvf .tar.gz # for example -# tar -xvf nym-vpn-cli_{{nym_vpn_cli_version}}_ubuntu-22.04_x86_64.tar.gz +# tar -xvf nym-vpn-cli__ubuntu-22.04_x86_64.tar.gz ``` -2. Make executable by running: + +4. Make executable by running: ```sh # make sure you are in the right sub-directory 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: ```sh curl -o sandbox.env -L https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env diff --git a/documentation/dev-portal/src/nymvpn/cli-mac.md b/documentation/dev-portal/src/nymvpn/cli-mac.md index 745b8601ed..fa75a90659 100644 --- a/documentation/dev-portal/src/nymvpn/cli-mac.md +++ b/documentation/dev-portal/src/nymvpn/cli-mac.md @@ -9,18 +9,18 @@ NymVPN is an experimental software and it's for [testing](./testing.md) purposes > Any syntax in `<>` brackets is a user's/version unique variable. Exchange with a corresponding name without the `<>` brackets. 1. Open Github [releases page]({{nym_vpn_releases}}) and download the binary for MacOS -2. Verify sha hash of your downloaded binary with the one listed on the [releases page]({{nym_vpn_releasesl}}). You can use a simple `shasum` command and compare strings (ie with Python) or run in the same directory the following command, exchanging `` with the one of your binary, like in the example: +2. Verify sha hash of your downloaded binary with the one listed on the [releases page]({{nym_vpn_releases}}). You can use a simple `shasum` command and compare strings (ie with Python) or run in the same directory the following command, exchanging `` with the one of your binary, like in the example: ```sh echo "" | shasum -a 256 -c # choose a correct one according to your binary, this is just an example -# echo "96623ccc69bc4cc0e4e3e18528b6dae6be69f645d0a592d926a3158ce2d0c269 nym-vpn-cli_{{nym_vpn_cli_version}}_macos_x86_64.zip" | shasum -a 256 -c +# echo "96623ccc69bc4cc0e4e3e18528b6dae6be69f645d0a592d926a3158ce2d0c269 nym-vpn-cli__macos_x86_64.zip" | shasum -a 256 -c ``` 3. Extract files: ```sh tar -xvf # for example -# tar -xvf nym-vpn-cli_{{nym_vpn_cli_version}}_macos_aarch64.tar.gz +# tar -xvf nym-vpn-cli__macos_aarch64.tar.gz ``` 4. Make executable by running: ```sh diff --git a/documentation/dev-portal/src/nymvpn/cli.md b/documentation/dev-portal/src/nymvpn/cli.md index 0fc239b0e9..7151082e2a 100644 --- a/documentation/dev-portal/src/nymvpn/cli.md +++ b/documentation/dev-portal/src/nymvpn/cli.md @@ -5,18 +5,17 @@ Our alpha testing round is done with participants at live workshop events. This **If you commit to test NymVPN alpha, please start with the [user research form]({{nym_vpn_form_url}}) where all the steps will be provided**. If you disagree with any of the conditions listed, please leave this page. ``` - Follow the simple [automated script](#automated-script-for-cli-installation) below to install and run NymVPN CLI. If you prefer to do a manual setup follow the steps in the guide for [Linux](cli-linux.md) or [MacOS](cli-mac.md). Visit NymVPN alpha latest [release page]({{nym_vpn_releases}}) to check sha sums or download the binaries directly. ## Automated Script for CLI Installation -We wrote a [script](https://gist.github.com/tommyv1987/87267ded27e1eb7651aa9cc745ddf4af) which does download of the CLI, sha256 verification, extraction, installation and configuration for Linux and MacOS users automatically following the steps below: +We wrote a [script](https://gist.github.com/serinko/d65450653d6bbafacbcee71c9cb8fb31) which does download of the CLI, sha256 verification, extraction, installation and configuration for Linux and MacOS users automatically following the steps below: 1. Open a terminal window in a directory where you want the script and NymVPN CLI binary be downloaded and run ```sh -curl -o execute-nym-vpn-cli-binary.sh -L https://gist.githubusercontent.com/tommyv1987/87267ded27e1eb7651aa9cc745ddf4af/raw/df78e30101c7357b57b311e06d5487e15d3335cb/execute-nym-vpn-cli-binary.sh && chmod u+x execute-nym-vpn-cli-binary.sh && sudo -E ./execute-nym-vpn-cli-binary.sh +curl -o execute-nym-vpn-cli-binary.sh -L https://gist.githubusercontent.com/serinko/d65450653d6bbafacbcee71c9cb8fb31/raw/4b70371fb000fd08910c0f778e78566d002e1319/execute-nym-vpn-cli-binary.sh && chmod u+x execute-nym-vpn-cli-binary.sh && sudo -E ./execute-nym-vpn-cli-binary.sh ``` 2. Follow the prompts in the program diff --git a/documentation/dev-portal/src/nymvpn/gui-linux.md b/documentation/dev-portal/src/nymvpn/gui-linux.md index 46506ac528..2f66420bf1 100644 --- a/documentation/dev-portal/src/nymvpn/gui-linux.md +++ b/documentation/dev-portal/src/nymvpn/gui-linux.md @@ -13,31 +13,34 @@ NymVPN is an experimental software and it's for [testing](./testing.md) purposes ### Installation 1. Open Github [releases page]({{nym_vpn_releases}}) and download the binary for Debian based Linux + 2. Required (if you don't want to check shasum, skip this point): Verify sha hash of your downloaded binary with the one listed on the [releases page]({{nym_vpn_releases}}). You can use a simple `shasum` command and compare strings (ie with Python) or run in the same directory the following command, exchanging `` with the one of your binary, like in the example: ```sh echo "" | shasum -a 256 -c # choose a correct one according to your binary, this is just an example -# echo "a5f91f20d587975e30b6a75d3a9e195234cf1269eac278139a5b9c39b039e807 nym-vpn-desktop_0.0.3_ubuntu-22.04_x86_64.zip" | shasum -a 256 -c +# echo "a5f91f20d587975e30b6a75d3a9e195234cf1269eac278139a5b9c39b039e807 nym-vpn-desktop__ubuntu-22.04_x86_64.tar.gz" | shasum -a 256 -c ``` + 3. Extract files: ```sh tar -xvf .tar.gz # for example -# tar -xvf nym-vpn-desktop_{{nym_vpn_gui_version}}_ubuntu-22.04_x86_64.tar.gz +# tar -xvf nym-vpn-desktop__ubuntu-22.04_x86_64.tar.gz ``` 4. If you prefer to run `.AppImage` make executable by running: ```sh # make sure you cd into the right sub-directory after extraction -chmod u+x ./nym-vpn_{{nym_vpn_gui_version}}_amd64.AppImage +chmod u+x ./nym-vpn__amd64.AppImage ``` + 5. If you prefer to use the `.deb` version for installation (works on Debian based Linux only), open terminal in the same directory and run: ```sh # make sure you cd into the right sub-directory after extraction -sudo dpkg -i ./nym-vpn_{{nym_vpn_gui_version}}_amd64.deb +sudo dpkg -i ./nym-vpn__amd64.deb # or -sudo apt-get install -f ./nym-vpn_{{nym_vpn_gui_version}}_amd64.deb +sudo apt-get install -f ./nym-vpn__amd64.deb ``` NymVPN alpha version runs over Nym testnet (called sandbox), a little extra configuration is needed for the application to work. @@ -71,7 +74,7 @@ Open terminal and run: ```sh # .AppImage must be run from the same directory as the binary -sudo -E ./nym-vpn_{{nym_vpn_gui_version}}_amd64.AppImage +sudo -E ./nym-vpn__amd64.AppImage # .deb installation shall be executable from anywhere as sudo -E nym-vpn diff --git a/documentation/dev-portal/src/nymvpn/gui-mac.md b/documentation/dev-portal/src/nymvpn/gui-mac.md index 0b1653f5dd..9602f608cf 100644 --- a/documentation/dev-portal/src/nymvpn/gui-mac.md +++ b/documentation/dev-portal/src/nymvpn/gui-mac.md @@ -24,14 +24,14 @@ mkdir -p "$HOME/nym-vpn-latest" echo "" | shasum -a 256 -c # choose a correct one according to your binary, this is just an example -# echo "da4c0bf8e8b52658312d341fa3581954cfcb6efd516d9a448c76d042a454b5df nym-vpn-desktop_0.0.3_macos_x86_64.zip" | shasum -a 256 -c +# echo "da4c0bf8e8b52658312d341fa3581954cfcb6efd516d9a448c76d042a454b5df nym-vpn-desktop__macos_x86_64.zip" | shasum -a 256 -c ``` 3. Extract the downloaded file manually or by a command: ```sh tar -xvf .tar.gz # for example -# tar -xvf nym-vpn-desktop_{{nym_vpn_gui_version}}_macos_aarch64.tar.gz +# tar -xvf nym-vpn-desktop__macos_aarch64.tar.gz ``` _ubuntu-22.04_x86_64/nym-vpn__amd64.AppImage # Linux .deb sudo -E nym-vpn diff --git a/documentation/dev-portal/src/nymvpn/intro.md b/documentation/dev-portal/src/nymvpn/intro.md index 7a42df06ca..b0648c063e 100644 --- a/documentation/dev-portal/src/nymvpn/intro.md +++ b/documentation/dev-portal/src/nymvpn/intro.md @@ -44,7 +44,7 @@ The client can optionally do the first hop (local client to Entry Gateway) using ## NymVPN Resources & Guides * [NymVPN webpage](https://nymvpn.com) -* [Alpha release page]({{nym_vpn_latest_binary_url}}) +* [Alpha release page]({{nym_vpn_releases}}) * [NymVPN application (GUI) guide](gui.md) * [NymVPN Command Line Interface (CLI) guide](cli.md) * [Troubleshooting](troubleshooting.md) diff --git a/documentation/dev-portal/src/nymvpn/scripts/nym_vpn_cli_version.sh b/documentation/dev-portal/src/nymvpn/scripts/nym_vpn_cli_version.sh new file mode 100755 index 0000000000..2801762bbf --- /dev/null +++ b/documentation/dev-portal/src/nymvpn/scripts/nym_vpn_cli_version.sh @@ -0,0 +1,6 @@ +#!/bin/bash + +release_url="https://api.github.com/repos/nymtech/nym-vpn-client/releases" +current_cli_version=$(curl -s $release_url | jq -r '.[].tag_name' | grep '^nym-vpn-cli-v' | sort -Vr | head -n 1 | awk -F'-v' '{print $NF}') + +echo "${current_cli_version}" diff --git a/documentation/dev-portal/src/nymvpn/scripts/nym_vpn_desktop_version.sh b/documentation/dev-portal/src/nymvpn/scripts/nym_vpn_desktop_version.sh new file mode 100755 index 0000000000..443509b70b --- /dev/null +++ b/documentation/dev-portal/src/nymvpn/scripts/nym_vpn_desktop_version.sh @@ -0,0 +1,6 @@ +#!/bin/bash + +release_url="https://api.github.com/repos/nymtech/nym-vpn-client/releases" +version=$(curl -s $release_url | jq -r '.[].tag_name' | grep '^nym-vpn-desktop-v' | sort -Vr | head -n 1 | awk -F'-v' '{print $NF}') + +echo "${version}" diff --git a/documentation/dev-portal/src/nymvpn/troubleshooting.md b/documentation/dev-portal/src/nymvpn/troubleshooting.md index 7d33991c75..9e00554518 100644 --- a/documentation/dev-portal/src/nymvpn/troubleshooting.md +++ b/documentation/dev-portal/src/nymvpn/troubleshooting.md @@ -45,7 +45,9 @@ If you are running NymVPN on mac OS for the first time, you may see this alert m 2. Confirm with your password or TouchID 3. Possibly you may have to confirm again upon running the application +