From aa5691447df6606de208da811dbd8dfc3da2b8a3 Mon Sep 17 00:00:00 2001 From: serinko <97586125+serinko@users.noreply.github.com> Date: Thu, 7 Mar 2024 13:00:46 +0100 Subject: [PATCH] update version, new script and simplify releases var --- documentation/dev-portal/book.toml | 2 +- .../dev-portal/src/nymvpn/cli-linux.md | 4 +- .../dev-portal/src/nymvpn/cli-mac.md | 4 +- documentation/dev-portal/src/nymvpn/cli.md | 16 +---- .../dev-portal/src/nymvpn/gui-linux.md | 15 +++-- .../dev-portal/src/nymvpn/gui-mac.md | 4 +- documentation/dev-portal/src/nymvpn/gui.md | 13 ++-- .../dev-portal/src/nymvpn/old-gui-mac.md | 61 ------------------- .../dev-portal/src/nymvpn/testing.md | 2 +- 9 files changed, 26 insertions(+), 95 deletions(-) delete mode 100644 documentation/dev-portal/src/nymvpn/old-gui-mac.md diff --git a/documentation/dev-portal/book.toml b/documentation/dev-portal/book.toml index 3b6b9f077d..5e6c22b0a0 100644 --- a/documentation/dev-portal/book.toml +++ b/documentation/dev-portal/book.toml @@ -31,7 +31,7 @@ assets_version = "3.0.0" # do not edit: managed by `mdbook-admonish install` minimum_rust_version = "1.66" wallet_release_version = "1.2.8" # nym-vpn related variables -nym_vpn_latest_binary_url = "https://github.com/nymtech/nym/releases/tag/nym-vpn-alpha-0.0.4" +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" [preprocessor.last-changed] diff --git a/documentation/dev-portal/src/nymvpn/cli-linux.md b/documentation/dev-portal/src/nymvpn/cli-linux.md index eb08043535..92f129f5e3 100644 --- a/documentation/dev-portal/src/nymvpn/cli-linux.md +++ b/documentation/dev-portal/src/nymvpn/cli-linux.md @@ -8,8 +8,8 @@ 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_latest_binary_url}}) 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_latest_binary_url}}). 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: +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: ```sh echo "" | shasum -a 256 -c diff --git a/documentation/dev-portal/src/nymvpn/cli-mac.md b/documentation/dev-portal/src/nymvpn/cli-mac.md index a4093168db..85b65cd551 100644 --- a/documentation/dev-portal/src/nymvpn/cli-mac.md +++ b/documentation/dev-portal/src/nymvpn/cli-mac.md @@ -8,8 +8,8 @@ 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_latest_binary_url}}) and download the binary for MacOS -2. Verify sha hash of your downloaded binary with the one listed on the [releases page]({{nym_vpn_latest_binary_url}}). 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: +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: ```sh echo "" | shasum -a 256 -c diff --git a/documentation/dev-portal/src/nymvpn/cli.md b/documentation/dev-portal/src/nymvpn/cli.md index ea0a7f0e9a..2c2ae285a7 100644 --- a/documentation/dev-portal/src/nymvpn/cli.md +++ b/documentation/dev-portal/src/nymvpn/cli.md @@ -16,22 +16,12 @@ We wrote a [script](https://gist.github.com/serinko/d65450653d6bbafacbcee71c9cb8 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/serinko/d65450653d6bbafacbcee71c9cb8fb31/raw/0cbcdd18f7ee94f559692b936061248ebbbf2773/execute-nym-vpn-cli-binary.sh +curl -o execute-nym-vpn-cli-binary.sh -L https://gist.githubusercontent.com/serinko/d65450653d6bbafacbcee71c9cb8fb31/raw/0cbcdd18f7ee94f559692b936061248ebbbf2773/execute-nym-vpn-cli-binary.sh && chmod u+x execute-nym-vpn-cli-binary.sh && sudo -E ./execute-nym-vpn-cli-binary.sh ``` -2. Make the script executable -```sh -chmod u+x execute-nym-vpn-cli-binary.sh -``` +2. Follow the prompts in the program -3. Start the script, turn off any VPN and run -```sh -sudo -E ./execute-nym-vpn-cli-binary.sh -``` - -4. Follow the prompts in the program - -5. The script will automatically start the client. Make sure to **turn off any other VPNs** and follow the prompts: +3. The script will automatically start the client. Make sure to **turn off any other VPNs** and follow the prompts: * It prints a JSON view of existing Gateways and prompt you to: - *Make sure to use two different Gateways for entry and exit!* diff --git a/documentation/dev-portal/src/nymvpn/gui-linux.md b/documentation/dev-portal/src/nymvpn/gui-linux.md index 713142c2eb..794b22904f 100644 --- a/documentation/dev-portal/src/nymvpn/gui-linux.md +++ b/documentation/dev-portal/src/nymvpn/gui-linux.md @@ -12,8 +12,8 @@ NymVPN is an experimental software and it's for [testing](./testing.md) purposes ### Installation -1. Open Github [releases page]({{nym_vpn_latest_binary_url}}) 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_latest_binary_url}}). 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: +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 @@ -30,15 +30,14 @@ tar -xvf 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 ./appimage/nym-vpn_0.0.4_amd64.AppImage +chmod u+x ./nym-vpn_0.0.5-dev_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 -cd deb - -sudo dpkg -i ./nym-vpn_0.0.4_amd64.deb +# make sure you cd into the right sub-directory after extraction +sudo dpkg -i ./nym-vpn_0.0.5-dev_amd64.deb # or -sudo apt-get install -f ./nym-vpn_0.0.4_amd64.deb +sudo apt-get install -f ./nym-vpn-dev_0.0.5_amd64.deb ``` NymVPN alpha version runs over Nym testnet (called sandbox), a little extra configuration is needed for the application to work. @@ -72,7 +71,7 @@ Open terminal and run: ```sh # .AppImage must be run from the same directory as the binary -sudo -E ./nym-vpn_0.0.4_amd64.AppImage +sudo -E ./nym-vpn-dev_0.0.5_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 336a0cede2..854e5dcaf8 100644 --- a/documentation/dev-portal/src/nymvpn/gui-mac.md +++ b/documentation/dev-portal/src/nymvpn/gui-mac.md @@ -17,9 +17,9 @@ mkdir -p "$HOME/nym-vpn-latest" ``` --> -1. Open Github [releases page]({{nym_vpn_latest_binary_url}}) and download the binary for your version of MacOS +1. Open Github [releases page]({{nym_vpn_releases}}) and download the binary for your version of MacOS -2. Recommended (skip this point if you don't want to verify): Verify sha hash of your downloaded binary with the one listed on the [releases page]({{nym_vpn_latest_binary_url}}). 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. Recommended (skip this point if you don't want to verify): 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 diff --git a/documentation/dev-portal/src/nymvpn/gui.md b/documentation/dev-portal/src/nymvpn/gui.md index 779ddab4dd..dc12e610b5 100644 --- a/documentation/dev-portal/src/nymvpn/gui.md +++ b/documentation/dev-portal/src/nymvpn/gui.md @@ -10,23 +10,26 @@ This is the alpha version of NymVPN desktop application (GUI). A demo of how the Follow the simple [automated script](#automated-script-for-gui-installation) below to install and run NymVPN GUI. If the script didn't work for your distribution or you prefer to do a manual setup follow the steps in the guide for [Linux](gui-linux.md) or [MacOS](gui-mac.md) . -Visit NymVPN alpha latest [release page]({{nym_vpn_latest_binary_url}}) to check sha sums or download the binaries directly. +Visit NymVPN alpha latest [release page]({{nym_vpn_releases}}) to check sha sums or download the binaries directly. ## Automated Script for GUI Installation -We wrote a [script](https://gist.github.com/serinko/e0a9f7ff3d79e974ec6f6783caa1137e) which does download of dependencies and the application, sha256 verification, extraction, installation and configuration for Linux and MacOS users automatically. Turn off all VPNs and follow the steps below. +We wrote a [script](https://gist.github.com/tommyv1987/7d210d4daa8f7abc61f9a696d0321f19) which does download of dependencies and the application, sha256 verification, extraction, installation and configuration for Linux and MacOS users automatically. Turn off all VPNs and follow the steps below. 1. Open a terminal window in a directory where you want the script to be downloaded and run ```sh -curl -o nym-vpn-desktop-install-run.sh -L https://gist.githubusercontent.com/serinko/e0a9f7ff3d79e974ec6f6783caa1137e/raw/227c8c348a1e58f68cb500e4504b22412177c680/nym-vpn-desktop-install-run.sh && chmod u+x nym-vpn-desktop-install-run.sh && sudo -E ./nym-vpn-desktop-install-run.sh +curl -o nym-vpn-desktop-install-run.sh -L https://gist.githubusercontent.com/tommyv1987/7d210d4daa8f7abc61f9a696d0321f19/raw/8e673170da309996b31de2cfcd3a65bd4d7c158f/nym-vpn-client-install-run.sh && chmod u+x nym-vpn-desktop-install-run.sh && sudo -E ./nym-vpn-desktop-install-run.sh ``` 2. Follow the prompts in the program To start the application again, reconnect your wifi and run ```sh -# Linux -sudo -E ~/nym-vpn-latest/nym-vpn_0.0.4_amd64.AppImage +# Linux .AppImage +sudo -E ~/nym-vpn-latest/nym-vpn-desktop_0.0.5-dev_ubuntu-22.04_x86_64/nym-vpn_0.0.5_amd64.AppImage + +# Linux .deb +sudo -E nym-vpn # MacOS sudo -E $HOME/nym-vpn-latest/nym-vpn diff --git a/documentation/dev-portal/src/nymvpn/old-gui-mac.md b/documentation/dev-portal/src/nymvpn/old-gui-mac.md deleted file mode 100644 index ba74a23f41..0000000000 --- a/documentation/dev-portal/src/nymvpn/old-gui-mac.md +++ /dev/null @@ -1,61 +0,0 @@ -# NymVPN alpha - Desktop: Guide for Mac OS - -```admonish info -NymVPN is an experimental software and it's for [testing](./testing.md) purposes only. All users testing the client are expected to sign GDPR Information Sheet and Consent Form (shared at the workshop) so we use their results to improve the client, and submit the form [*NymVPN User research*]({{nym_vpn_form_url}}) with the testing results. -``` - -## Preparation - -> Any syntax in `<>` brackets is a user's/version unique variable. Exchange with a corresponding name without the `<>` brackets. - -### Installation - -1. Create a directory `~/nym-vpn-latest` -```sh -mkdir -p "$HOME/nym-vpn-latest" -``` -2. Open Github [releases page]({{nym_vpn_latest_binary_url}}) and download the binary for MacOS -3. Verify sha hash of your downloaded binary with the one listed on the [releases page]({{nym_vpn_latest_binary_url}}). 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 "da4c0bf8e8b52658312d341fa3581954cfcb6efd516d9a448c76d042a454b5df nym-vpn-desktop_0.0.3_macos_x86_64.zip" | shasum -a 256 -c -``` -4. Extract files: -```sh -tar -xvf -# for example -# tar -xvf nym-vpn-desktop_0.0.4_macos_aarch64.tar.gz -``` -5. Move to the application directory and make executable -```sh -cd "macos/nym-vpn.app/Contents/MacOS" - -chmod u+x nym-vpn -``` -6. Move `nym-vpn` to your `~/nym-vpn-latest` directory -```sh -mv nym-vpn "$HOME/nym-vpn-latest" -``` - -### Configuration - -7. Create the configuration file by opening a text editor and saving the lines below as `config.toml` in the same directory `~/nym-vpn-latest` -```toml -env_config_file = ".env" -``` -8. Create testnet configuration file by saving [this](https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env) as `.env` in the same directory `~/nym-vpn-latest` -```sh -curl -L "https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env" -o "$HOME/nym-vpn-latest/.env" -``` -## Run NymVPN - -**For NymVPN to work, all other VPNs must be switched off!** At this alpha stage of NymVPN, the network connection (wifi) must be reconnected after or in between the testing rounds. - -Run: -```sh -sudo -E $HOME/nym-vpn-latest/nym-vpn -``` - -In case of errors check out the [troubleshooting](troubleshooting.html#installing-gui-on-macos-not-working) section. diff --git a/documentation/dev-portal/src/nymvpn/testing.md b/documentation/dev-portal/src/nymvpn/testing.md index f5e6558bf4..849b670d8f 100644 --- a/documentation/dev-portal/src/nymvpn/testing.md +++ b/documentation/dev-portal/src/nymvpn/testing.md @@ -14,7 +14,7 @@ One of the main aims of NymVPN alpha release is testing; your results will help > Any syntax in `<>` brackets is a user's/version unique variable. Exchange with a corresponding name without the `<>` brackets. -1. Create a directory called `nym-vpn-tests` and copy your `nym-vpn-cli` binary ([download here]({{nym_vpn_latest_binary_url}})) +1. Create a directory called `nym-vpn-tests` and copy your `nym-vpn-cli` binary ([download here]({{nym_vpn_releases}})) 2. Copy or download [`sandbox.env`](https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env) testnet config file to the same directory ```sh curl -o sandbox.env -L https://raw.githubusercontent.com/nymtech/nym/develop/envs/sandbox.env