aboutsummarylogtreecommitdiffstats
path: root/README.md
blob: 97f1aeaa5061fd7ca9e93db3821361bbb6fa9afe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# nordconnect
A simple shell script to connect to a NordVPN server through OpenVPN.

## Installation
nordconnect is composed by a single script file, just add it to your path.

### Arch Linux
If you are on Arch Linux, you can install the [nordconnect AUR package](https://aur.archlinux.org/packages/nordconnect/).

## Usage
```
nordconnect [--init | --update | server]
```

For a detailed list of options, run `nordconnect --help`.

### First use
Run `nordconnect --init` to initialize nordconnect. It will ask for your username and password.

### Update
Run `nordconnect --update` to download latest server definitions from NordVPN.

### Examples
```
# Just connect to a server
$ nordconnect us123

# Using nordselect to pick a server
$ nordconnect $(nordselect us)
```

### Systemd service
nordconnect ships with a systemd service unit, taking a server argument. Start/enable it with:
```
systemctl --user start nordconnect@<server>.service
```

## License
This project is licensed under the [GNU General Public License version 3](https://opensource.org/licenses/GPL-3.0)