Skip to content

Commit

Permalink
nymvpn guide first pass
Browse files Browse the repository at this point in the history
  • Loading branch information
mfahampshire committed Dec 10, 2024
1 parent fd47768 commit 85e971a
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
1 change: 1 addition & 0 deletions documentation/docs/pages/operators/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"tokenomics": "Tokenomics",
"faq": "FAQ",
"community-counsel": "Community Counsel",
"nymvpncli": "Nym VPN CLI",
"---": {
"type": "separator"
},
Expand Down
52 changes: 52 additions & 0 deletions documentation/docs/pages/operators/nymvpncli.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import { Callout } from 'nextra/components'

# Nym VPN CLI

This is a short guide to setting up and using the `nym-vpn-cli` tool. Download and run instructions for the GUIs can be found [here](https://nymvpn.com/en/download/linux).

## Download & Extract Binary
```sh
wget -q https://github.com/nymtech/nym-vpn-client/releases/download/nym-vpn-core-v1.1.0-beta.2/nym-vpn-core-v1.1.0-beta.2_<YOUR_OPERATING_SYSTEM>.tar.gz &&
tar -xzf nym-vpn-core-v1.1.0-beta.2_<YOUR_OPERATING_SYSTEM>.tar.gz &&
cd nym-vpn-core-v1.1.0-beta.2_<YOUR_OPERATING_SYSTEM>/ &&
chmod u+x *
```

## Build from Source
### Prerequisites
All operating systems require both [Rust](https://www.rust-lang.org/tools/install) and [Go](https://go.dev/doc/install).

**Ubuntu24 specific packages:**
```sh
apt install gcc make protobuf-compiler pkconfig libdbus-1-dev build-essential clang
```

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

**Arch specific packages:**
```sh
yay -S gcc make protobuf base-devel clang
```

### Clone & `make`
```sh
git clone https://github.com/nymtech/nym-vpn-client.git
cd nym-vpn-client/
make
```

## Mnemonic Generation
Create an account at [nymvpn.com](nymvpn.com) to obtain your mnemonic.

## Start the daemon
```sh
sudo ./nym-vpnd
```

## Run the CLI
```sh
sudo ./nym-vpn-cli store-account --mnemonic "<MNEMONIC_FROM_GENERATION_STEP>"
sudo ./nym-vpn-cli run --wireguard-mode
```

0 comments on commit 85e971a

Please sign in to comment.