Skip to content

Commit 1604cf7

Browse files
committed
docs: update readme
1 parent b012ef0 commit 1604cf7

2 files changed

Lines changed: 20 additions & 26 deletions

File tree

README.md

Lines changed: 18 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,6 @@ The client is in experimental mode, so it is important to know which parts of th
1616

1717
## Installation
1818

19-
### Prerequisites
20-
21-
WireGuard tools are required for MBVPN to function properly. Install them using your distribution's package manager. For example:
22-
23-
- **Ubuntu/Debian**: `sudo apt install wireguard wireguard-tools`
24-
- **Fedora**: `sudo dnf install wireguard-tools`
25-
- **Arch Linux**: `sudo pacman -S wireguard-tools`
26-
2719
### Installation via Go Package Manager (Recommended)
2820

2921
Install MBVPN directly using Go's package manager:
@@ -32,23 +24,31 @@ Install MBVPN directly using Go's package manager:
3224
go install github.com/malwarebytes/mbvpn-linux/cmd/mbvpn@latest
3325
```
3426

27+
> Note: Ensure that your `$GOPATH/bin` is included in your system's `$PATH` to run the `mbvpn` command directly.
28+
3529
### Alternative: Download from Releases
3630

3731
1. Download the latest release for your architecture from the [Releases](https://github.com/Malwarebytes/mbvpn-linux/releases) page
3832
2. Extract the binary and place it in a directory in your `$PATH` (e.g., `/usr/local/bin`)
3933

34+
### Provide network capabilities
35+
36+
To allow mbvpn to create WireGuard interfaces without running as root, grant it the necessary capabilities:
37+
38+
```bash
39+
sudo setcap cap_net_admin,cap_net_raw+eip $(which mbvpn)
40+
```
41+
42+
> Note: You may need to reapply these capabilities after updating the binary.
43+
4044
## Usage
4145

4246
> You can access help information using `mbvpn --help` or `mbvpn <command> --help` if you want to read details about specific commands.
4347
44-
First, authenticate yourself using the `login` command with license key or MB-code:
48+
First, authenticate yourself using the `login` command with MB-code:
4549

4650
`mbvpn login --code MB-XXXXXX`
4751

48-
or
49-
50-
`mbvpn login --key XXXX-XXXX-XXXX-XXXX`
51-
5252
### Managing Servers
5353

5454
View available servers and locations:
@@ -60,15 +60,15 @@ View available servers and locations:
6060
### Connection Management
6161

6262
Connect to a server:
63-
`sudo mbvpn connect <server>` (or the shorthand `sudo mbvpn c <server>`)
63+
`mbvpn connect <server>`
6464

6565
Disconnect from VPN:
66-
`sudo mbvpn disconnect` (or the shorthand `sudo mbvpn d`)
66+
`mbvpn disconnect`
6767

6868
Check connection status:
69-
`sudo mbvpn status`
69+
`mbvpn status`
7070

71-
End your session:
71+
End your session and free up the license seat:
7272
`mbvpn logout`
7373

7474
## Troubleshooting
@@ -81,13 +81,7 @@ The `mbvpn logout` command deactivates your device (makes the license seat free)
8181

8282
### Cannot disconnect, lost internet access
8383

84-
Use `sudo mbvpn disconnect` (without specifying a server). The tool will attempt to disconnect from all WireGuard connections.
85-
86-
If that doesn't help, manually disconnect using WireGuard directly:
87-
1. Find your connection: `wg show`
88-
2. Disconnect: `sudo wg-quick down <interface_name>`
89-
90-
> After connecting/disconnecting, give the tool a few seconds to establish or terminate the connection.
84+
Use `mbvpn disconnect` (without specifying a server). The tool will attempt to disconnect from all WireGuard connections.
9185

9286
---
9387

pkg/config/env.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ var (
1313

1414
// Version information
1515
VersionMajor = "0"
16-
VersionMinor = "0"
17-
VersionPatch = "11"
16+
VersionMinor = "1"
17+
VersionPatch = "0"
1818
)
1919

2020
func Debug() bool {

0 commit comments

Comments
 (0)