Update docs

config.cfg

@@ -62,6 +62,7 @@ adblock_lists:
 
 # Enable DNS encryption.
 # If 'false', 'dns_servers' should be specified below.
+# DNS encryption can not be disabled if DNS adblocking is enabled
 dns_encryption: true
 
 # DNS servers which will be used if 'dns_encryption' is 'true'. Multiple

docs/cloud-do.md

@@ -84,7 +84,7 @@ ansible-playbook main.yml -e "provider=digitalocean
                                 server_name=algo
                                 ondemand_cellular=true
                                 ondemand_wifi=true
-                                local_dns=false
+                                dns_adblocking=false
                                 ssh_tunneling=false
                                 windows=false
                                 store_cakey=true

docs/deploy-from-ansible.md

@@ -15,7 +15,7 @@ ansible-playbook main.yml -e "provider=digitalocean
                                 server_name=algo
                                 ondemand_cellular=false
                                 ondemand_wifi=false
-                                local_dns=true
+                                dns_adblocking=true
                                 ssh_tunneling=true
                                 windows=false
                                 store_cakey=true
@@ -32,7 +32,7 @@ See below for more information about variables and roles.
 - `ondemand_cellular` (Optional) VPN On Demand when connected to cellular networks with IPsec. Default: false
 - `ondemand_wifi` - (Optional. See `ondemand_wifi_exclude`) VPN On Demand when connected to WiFi networks with IPsec. Default: false
 - `ondemand_wifi_exclude` (Required if `ondemand_wifi` set) - WiFi networks to exclude from using the VPN. Comma-separated values
-- `local_dns` - (Optional) Enable a DNS resolver. Default: false
+- `dns_adblocking` - (Optional) Enable a DNS resolver. Default: false
 - `ssh_tunneling` - (Optional) Enable SSH tunneling for each user. Default: false
 - `windows` - (Optional) Enables compatible ciphers and key exchange to support Windows clients, less secure. Default: false
 - `store_cakey` - (Optional) Whether or not keep the CA key (required to add users in the future, but less secure). Default: false

docs/deploy-from-script-or-cloud-init-to-localhost.md

@@ -20,7 +20,7 @@ The command will prepare the environment and install AlgoVPN with the default pa
 `ONDEMAND_WIFI_EXCLUDE` - List the names of any trusted Wi-Fi networks where macOS/iOS IPsec clients should not use "Connect On Demand". Comma-separated list.
 `WINDOWS` - To support Windows 10 or Linux Desktop clients. Default: false.
 `STORE_CAKEY` - To retain the CA key. (required to add users in the future, but less secure). Default: false.
-`LOCAL_DNS` - To install an ad blocking DNS resolver. Default: false.
+`DNS_ADBLOCKING` - To install an ad blocking DNS resolver. Default: false.
 `SSH_TUNNELING` -  Enable SSH tunneling for each user. Default: false.
 `ENDPOINT` - The public IP address or domain name of your server: (IMPORTANT! This is used to verify the certificate). It will be gathered automatically for DigitalOcean, AWS, GCE, Azure or Vultr if the `METHOD` is cloud. Otherwise you need to define this variable according to your public IP address.  
 `USERS` - list of VPN users. Comma-separated list. Default: user1.

install.sh

@@ -8,7 +8,7 @@ ONDEMAND_WIFI="${3:-${ONDEMAND_WIFI:-false}}"
 ONDEMAND_WIFI_EXCLUDE="${4:-${ONDEMAND_WIFI_EXCLUDE:-_null}}"
 WINDOWS="${5:-${WINDOWS:-false}}"
 STORE_CAKEY="${6:-${STORE_CAKEY:-false}}"
-LOCAL_DNS="${7:-${LOCAL_DNS:-false}}"
+DNS_ADBLOCKING="${7:-${DNS_ADBLOCKING:-false}}"
 SSH_TUNNELING="${8:-${SSH_TUNNELING:-false}}"
 ENDPOINT="${9:-${ENDPOINT:-localhost}}"
 USERS="${10:-${USERS:-user1}}"
@@ -38,7 +38,7 @@ installRequirements() {
 getAlgo() {
   [ ! -d "algo" ] && git clone "https://github.com/${REPO_SLUG}" -b "${REPO_BRANCH}" algo
   cd algo
-  
+
   python -m virtualenv --python="$(command -v python2)" .venv
   # shellcheck source=/dev/null
   . .venv/bin/activate
@@ -92,7 +92,7 @@ deployAlgo() {
     -e "ondemand_wifi_exclude=${ONDEMAND_WIFI_EXCLUDE}" \
     -e "windows=${WINDOWS}" \
     -e "store_cakey=${STORE_CAKEY}" \
-    -e "local_dns=${LOCAL_DNS}" \
+    -e "dns_adblocking=${DNS_ADBLOCKING}" \
     -e "ssh_tunneling=${SSH_TUNNELING}" \
     -e "endpoint=$ENDPOINT" \
     -e "users=$(echo "$USERS" | jq -Rc 'split(",")')" \

tests/cloud-init.sh

@@ -6,7 +6,7 @@ export ONDEMAND_WIFI=true
 export ONDEMAND_WIFI_EXCLUDE=test1,test2
 export WINDOWS=true
 export STORE_CAKEY=true
-export LOCAL_DNS=true
+export DNS_ADBLOCKING=true
 export SSH_TUNNELING=true
 export ENDPOINT=10.0.8.100
 export USERS=desktop,user1,user2

tests/local-deploy.sh

@@ -2,7 +2,7 @@
 
 set -ex
 
-DEPLOY_ARGS="provider=local server=10.0.8.100 ssh_user=ubuntu endpoint=10.0.8.100 apparmor_enabled=false ondemand_cellular=true ondemand_wifi=true ondemand_wifi_exclude=test local_dns=true ssh_tunneling=true windows=true store_cakey=true install_headers=false tests=true local_service_ip=172.16.0.1"
+DEPLOY_ARGS="provider=local server=10.0.8.100 ssh_user=ubuntu endpoint=10.0.8.100 apparmor_enabled=false ondemand_cellular=true ondemand_wifi=true ondemand_wifi_exclude=test dns_adblocking=true ssh_tunneling=true windows=true store_cakey=true install_headers=false tests=true local_service_ip=172.16.0.1"
 
 if [ "${DEPLOY}" == "docker" ]
 then