-
Notifications
You must be signed in to change notification settings - Fork 235
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fd47768
commit 85e971a
Showing
2 changed files
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |