Skip to content

Commit

Permalink
Added --cap-add=SYS_MODULE (bubuntux#72)
Browse files Browse the repository at this point in the history
As Wireguard is a kernel implementation, NET-ADMIN isn't enough - adding SYS_MODULE capability will be need it if not already loaded.
  • Loading branch information
SlothCroissant authored Apr 21, 2020
1 parent 48057cb commit a170370
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,12 @@ This container was designed to be started first to provide a connection to other

## Starting an NordVPN instance

docker run -ti --cap-add=NET_ADMIN --device /dev/net/tun --name vpn \
docker run -ti --cap-add=NET_ADMIN --cap-add=SYS_MODULE --device /dev/net/tun --name vpn \
-e [email protected] -e PASS='pas$word' \
-e CONNECT=country -e TECHNOLOGY=NordLynx -d bubuntux/nordvpn

**NOTE**: `--cap-add=SYS_MODULE` is only required when selecting `TECHNOLOGY=NordLynx`. `TECHNOLOGY=OpenVPN` only requires `--cap-add=NET_ADMIN`.

Once it's up other containers can be started using it's network connection:

docker run -it --net=container:vpn -d some/docker-container
Expand Down Expand Up @@ -61,7 +63,8 @@ services:
image: bubuntux/nordvpn
network_mode: bridge
cap_add:
- net_admin
- NET_ADMIN
- SYS_MODULE # Required for TECHNOLOGY=NordLynx
devices:
- /dev/net/tun
environment:
Expand Down Expand Up @@ -97,7 +100,7 @@ All traffic going through the container is router to the vpn (unless whitelisted
- --group value, -g value Specify a server group to connect to. For example: 'us -g p2p'
* `TECHNOLOGY` - Specify Technology to use:
* OpenVPN - Traditional connection.
* NordLynx - NordVpn wireguard implementation (3x-5x times faster).
* NordLynx - NordVpn wireguard implementation (3x-5x times faster). NOTE: Requires `--cap-add=SYS_MODULE`
* `PROTOCOL` - TCP or UDP (only valid when using OpenVPN).
* `OBFUSCATE` - Enable or Disable. When enabled, this feature allows to bypass network traffic sensors which aim to detect usage of the protocol and log, throttle or block it (only valid when using OpenVpn).
* `CYBER_SEC` - Enable or Disable. When enabled, the CyberSec feature will automatically block suspicious websites so that no malware or other cyber threats can infect your device. Additionally, no flashy ads will come into your sight. More information on how it works: https://nordvpn.com/features/cybersec/.
Expand Down

0 comments on commit a170370

Please sign in to comment.