net/vpnbypass/files/README.md

   1 <!-- markdownlint-disable MD013 -->
   2 # VPN Bypass
   3
   4 [![HitCount](http://hits.dwyl.com/stangri/openwrt/vpnbypass.svg)](http://hits.dwyl.com/stangri/openwrt/vpnbypass)
   5
   6 A simple [procd](https://openwrt.org/docs/techref/procd)-based ```vpnbypass``` service for OpenWrt/LEDE Project. This is useful if your router accesses Internet through a VPN client/tunnel, but you want specific traffic (ports, IP ranges, domains or local IP ranges) to be routed outside of this tunnel.
   7
   8 ## Features
   9
  10 - Define local ports so traffic to them is routed outside of the VPN tunnel (by default it routes Plex Media Server traffic (port 32400) outside of the VPN tunnel).
  11 - Define IPs/subnets in local networks so their traffic is routed outside the VPN tunnel (by default it routes traffic from 192.168.1.81-192.168.1.87 outside the VPN tunnel).
  12 - Define remote IP ranges that are accessed outside the VPN tunnel (by default, LogmeIn Hamachi traffic (25.0.0.0/8) is routed outside the VPN tunnel).
  13 - Creates list of domain names which should be accessed outside the VPN tunnel (useful for Netflix, Hulu, etc).
  14 - Does not reside in RAM -- creates `iptables` rules which are automatically updated on WAN up/down events.
  15 - A companion package (`luci-app-vpnbypass`) is provided so all features may be configured from the Web UI.
  16 - Proudly made in Canada, using locally-sourced electrons.
  17
  18 ## Screenshot (luci-app-vpnbypass)
  19
  20 ![screenshot](https://cdn.jsdelivr.net/gh/stangri/openwrt_packages/screenshots/vpnbypass/screenshot02.png "screenshot")
  21
  22 ## Requirements
  23
  24 This service requires the following packages to be installed on your router: ```ipset``` and ```iptables```. Additionally, if you want to use the Domain Bypass feature, you need to install ```dnsmasq-full``` (```dnsmasq-full``` requires you uninstall ```dnsmasq``` first).
  25
  26 To fully satisfy the requirements for both IP/Port VPN Bypass and Domain Bypass features connect via ssh to your router and run the following commands:
  27
  28 ```sh
  29 opkg update; opkg remove dnsmasq; opkg install ipset iptables dnsmasq-full
  30 ```
  31
  32 To satisfy the requirements for just IP/Port VPN Bypass connect to your router via ssh and run the following commands:
  33
  34 ```sh
  35 opkg update; opkg install ipset iptables
  36 ```
  37
  38 ### Unmet dependencies
  39
  40 If you are running a development (trunk/snapshot) build of OpenWrt/LEDE Project on your router and your build is outdated (meaning that packages of the same revision/commit hash are no longer available and when you try to satisfy the [requirements](#requirements) you get errors), please flash either current LEDE release image or current development/snapshot image.
  41
  42 ## How to install
  43
  44 <!---
  45 #### From Web UI/Luci
  46 Navigate to System->Software page on your router and then perform the following actions:
  47 1. Click "Update Lists"
  48 2. Wait for the update process to finish.
  49 3. In the "Download and install package:" field type ```vpnbypass luci-app-vpnbypass```
  50 4. Click "OK" to install ```vpnbypass``` and ```luci-app-vpnbypass```
  51
  52 If you get an ```Unknown package 'vpnbypass'``` error, your router is not set up with the access to a repository containing these packages and you need to add the custom repository to your router first.
  53
  54 #### From console/ssh
  55 --->
  56 Please ensure that the [requirements](#requirements) are satisfied and install ```vpnbypass``` and ```luci-app-vpnbypass``` from the Web UI or connect to your router via ssh and run the following commands:
  57
  58 ```sh
  59 opkg update
  60 opkg install vpnbypass luci-app-vpnbypass
  61 ```
  62
  63 If these packages are not found in the official feed/repo for your version of OpenWrt/LEDE Project, you will need to add a custom repo to your router following instructions on [GitHub](https://github.com/stangri/openwrt_packages/blob/master/README.md#on-your-router)/[jsDelivr](https://cdn.jsdelivr.net/gh/stangri/openwrt_packages/README.md#on-your-router) first.
  64
  65 These packages have been designed to be backwards compatible with OpenWrt 19.07, OpenWrt 18.06, LEDE Project 17.01 and OpenWrt 15.05. However, on systems older than OpenWrt 18.06.6 and/or a system which has deviated too far (or haven't been updated to keep in-sync) with official OpenWrt release you may get a message about missing ```luci-compat``` dependency, which (and only which) you can safely ignore and force-install the luci app using ```opkg install --force-depends``` command instead of ```opkg install```.
  66
  67 ## Default Settings
  68
  69 The default configuration ships with the service disabled, use the Web UI to enable/start the service or run ```uci set vpnbypass.config.enabled=1; uci commit vpnbypass;```. It routes Plex Media Server traffic (port 32400) and LogmeIn Hamachi traffic (25.0.0.0/8) outside of the VPN tunnel. Internet traffic from local IPs `192.168.1.81-192.168.1.87` is also routed outside the VPN tunnel. You can safely delete these example rules if they do not apply to you.
  70
  71 ## Documentation / Discussion
  72
  73 Please head to [OpenWrt Forum](https://forum.openwrt.org/t/vpn-bypass-split-tunneling-service-luci-ui/1106) for discussions of this service.
  74
  75 ### Bypass Domains Format/Syntax
  76
  77 Domain lists should be in the following format/syntax: ```/domain1.com/domain2.com/vpnbypass```. Please do not forget the leading ```/``` and trailing ```/vpnbypass```. There is no validation if you enter something incorrectly -- it simply will not work. Please see [Notes/Known Issues](#notesknown-issues) if you wish to edit this setting manually, without using the Web UI.
  78
  79 ## What's New
  80
  81 1.3.0:
  82
  83 - No longer depends on hardcoded WAN interface name (```wan```) works with other interface names (like ```wwan```).
  84 - Table ID, IPSET name and FW_MARK as well as FW_MASK can be defined in config file.
  85 - Uses iptables, not ip rules for handling local IPs/ranges.
  86 - More reliable creation/destruction of VPNBYPASS iptables chain.
  87 - Updated Web UI enables, starts and stops the service.
  88
  89 ## Notes/Known Issues
  90
  91 1. Domains to be accessed outside of VPN tunnel are handled by dnsmasq and thus are not defined in ```/etc/config/vpnpass```, but rather in ```/etc/config/dhcp```. To add/delete/edit domains you can use VPN Bypass Web UI or you can edit ```/etc/config/dhcp``` manually or run the following commands:
  92
  93 ```sh
  94 uci add_list dhcp.@dnsmasq[-1].ipset='/github.com/plex.tv/google.com/vpnbypass'
  95 uci add_list dhcp.@dnsmasq[-1].ipset='/hulu.com/netflix.com/nhl.com/vpnbypass'
  96 uci commit dhcp
  97 /etc/init.d/dnsmasq restart
  98 ```
  99
 100 This feature requires ```dnsmasq-full``` to work. See the [Requirements](#requirements) section for more details.