Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nymvpncli guide #5243

Merged
merged 3 commits into from
Dec 11, 2024
Merged

nymvpncli guide #5243

merged 3 commits into from
Dec 11, 2024

Conversation

mfahampshire
Copy link
Contributor

@mfahampshire mfahampshire commented Dec 10, 2024

  • modify to use nym-vpnc instead

This change is Reviewable

Copy link

vercel bot commented Dec 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-nextra 🛑 Canceled (Inspect) Dec 11, 2024 0:32am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
nym-next-explorer ⬜️ Ignored (Inspect) Visit Preview Dec 11, 2024 0:32am

@mfahampshire mfahampshire changed the base branch from develop to max/openapi-docs December 10, 2024 19:42
@mfahampshire mfahampshire changed the base branch from max/openapi-docs to develop December 10, 2024 19:42
@mfahampshire mfahampshire merged commit 1d0d62f into develop Dec 11, 2024
6 checks passed
@mfahampshire mfahampshire deleted the max/nymvpncli-guide branch December 11, 2024 16:00
Copy link
Contributor

@serinko serinko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Levft a few comments but it's not blocking, decide how to handle them - APPROVED

This is a short guide to setting up and using the `nym-vpnc` tool, which is used in conjunction with the `nym-vpnd` daemon.

<Callout type="warning" emoji="⚠️">
These binaries have superceded the older `nym-vpn-cli` binary. This still operates for the moment as it is being used in testing scenarios but will go out of date quickly.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if the white line in the beginning gets propagated.

## Download & Extract Binary
Check the [release page](https://github.com/nymtech/nym-vpn-client/releases/) page for the latest release version and modify the instructions accordingly. These instructions use the latest as of the time of writing.
```sh
wget -q https://github.com/nymtech/nym-vpn-client/releases/download/nym-vpn-core-v1.1.0-beta.3/nym-vpn-core-v1.1.0-beta.3_<YOUR_OPERATING_SYSTEM>.tar.gz &&
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't here a way to put latest tag or release tag to not to have to worry about updating it?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or use <BINARY> so ppl copy-paste the whole thing anyway and you have less future management work

Check the [release page](https://github.com/nymtech/nym-vpn-client/releases/) page for the latest release version and modify the instructions accordingly. These instructions use the latest as of the time of writing.
```sh
wget -q https://github.com/nymtech/nym-vpn-client/releases/download/nym-vpn-core-v1.1.0-beta.3/nym-vpn-core-v1.1.0-beta.3_<YOUR_OPERATING_SYSTEM>.tar.gz &&
tar -xzf nym-vpn-core-v1.1.0-beta.3_<YOUR_OPERATING_SYSTEM>.tar.gz &&
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or alternatively make it a bit more eye banging that a user has to think and replace:

tar -xzf <BINARY>.tar.gz

```

<Callout type="warning" emoji="⚠️">
Older Debian/Ubuntu versions need to manually install `protobuf-compiler` >= v3.21.12
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also starts with a whitespace


## Start the daemon
```sh
sudo ./PATH/TO/nym-vpnd
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would consider to:

import { VarInfo } from 'components/variable-info.tsx';

Then put

<VarInfo />

Somewhere on top and use the PATH cnvention like it's noted there.

https://nymtech.net/docs/operators/variables

Which is <PATH_TO>

## Run VPN
We have to first store the account we have created online:
```sh
./PATH/TO/nym-vpn-cli store-account --mnemonic "<MNEMONIC_FROM_GENERATION_STEP>"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would consider to:

import { VarInfo } from 'components/variable-info.tsx';

Then put

<VarInfo />

Somewhere on top and use the PATH cnvention like it's noted there.

https://nymtech.net/docs/operators/variables

Which is <PATH_TO>


You can then connect `nym-vpnc` (in this case, with 2 hop wireguard mode enabled):
```sh
./PATH/TO/nym-vpn-cli nym-vpnc connect --enable-two-hop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would consider to:

import { VarInfo } from 'components/variable-info.tsx';

Then put

<VarInfo />

Somewhere on top and use the PATH cnvention like it's noted there.

https://nymtech.net/docs/operators/variables

Which is <PATH_TO>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants