vpn-policy-routing: fix README .ovpn instructions 12485/head
authorStan Grishin <stangri@melmac.net>
Thu, 11 Jun 2020 21:42:35 +0000 (21:42 +0000)
committerStan Grishin <stangri@melmac.net>
Thu, 11 Jun 2020 21:42:35 +0000 (21:42 +0000)
Signed-off-by: Stan Grishin <stangri@melmac.net>
net/vpn-policy-routing/files/README.md

index 55ce64ad22b6c628a32cf1f00438e586eba1f8d2..8bb8304cf75d12858db9feb1fb42e69f6c7f09a2 100644 (file)
@@ -115,6 +115,8 @@ opkg install vpn-policy-routing luci-app-vpn-policy-routing
 
 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@master/README.md#on-your-router) first.
 
+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```.
+
 ### Requirements
 
 This service requires the following packages to be installed on your router: ```ipset```, ```resolveip```, ```ip-full``` (or a ```busybox``` built with ```ip``` support), ```kmod-ipt-ipset``` and ```iptables```.
@@ -746,7 +748,11 @@ config openvpn 'vpnc'
 
 5. <a name="footnote5"> </a> When using the ```dnsmasq.ipset``` option, please make sure to flush the DNS cache of the local devices, otherwise domain policies may not work until you do. If you're not sure how to flush the DNS cache (or if the device/OS doesn't offer an option to flush its DNS cache), reboot your local devices when starting to use the service and/or when connecting data-capable device to your WiFi.
 
-6. <a name="footnote6"> </a> When using the policies targeting physical devices, make sure you have the following packages installed: ```kmod-br-netfilter```, ```kmod-ipt-physdev``` and ```iptables-mod-physdev```.
+6. <a name="footnote6"> </a> When using the policies targeting physical devices, make sure you have the following packages installed: ```kmod-br-netfilter```, ```kmod-ipt-physdev``` and ```iptables-mod-physdev```. Also, if your physical device is a part of the bridge, you may have to set ```net.bridge.bridge-nf-call-iptables``` to `1` in your ```/etc/sysctl.conf```.
+
+### First Troubleshooting Step
+
+If your router is set to use [default routing via VPN tunnel](#a-word-about-default-routing) and the WAN-targeting policies do not work, you need to stop your VPN tunnel first and ensure that you still have internet connection. If your router is set up to use the default routing via VPN tunnel and when you stop the VPN tunnel you have no internet connection, this package can't help you. You first need to make sure that you do have internet connection when the VPN tunnel is stopped.
 
 ### Multiple OpenVPN Clients
 
@@ -821,13 +827,13 @@ Set the following to the appropriate section of your ```.ovpn``` file:
 - For OpenVPN 2.4 and newer client ```.ovpn``` file:
 
     ```text
-    pull_filter 'ignore "redirect-gateway"'
+    pull-filter ignore "redirect-gateway"
     ```
 
 - For OpenVPN 2.3 and older client ```.ovpn``` file:
 
     ```text
-    route_nopull '1'
+    route-nopull "1"
     ```
 
 #### Wireguard tunnel