release/src/router/dnscrypt/README-WINDOWS.markdown

   1 Using DNSCrypt on Windows
   2 =========================
   3
   4 On Windows, `dnscrypt-proxy` can be started from the command-line the same way
   5 as on other operating systems.
   6
   7 Alternatively, it can run as a Windows Service.
   8
   9 Note: Also check out Dominus Temporis' excellent tutorial on
  10 [DNSCrypt on Windows](http://dominustemporis.com/2014/05/dnscrypt-on-windows-update/)
  11
  12 Quickstart
  13 ----------
  14
  15 1) Download and extract the latest
  16 [Windows package for dnscrypt](http://download.dnscrypt.org/dnscrypt-proxy/LATEST-win32-full.zip).
  17
  18 2) Copy the `dnscrypt-proxy-win32` folder anywhere.
  19
  20 3) Open an elevated command prompt, enter the `dnscrypt-proxy-win32` folder
  21 and type:
  22
  23     dnscrypt-proxy.exe -R "name" --test=0
  24
  25 Replace `name` with one of the resolvers from CSV file. The (possibly
  26 updated) file can also be viewed online:
  27 [public DNS resolvers supporting DNSCrypt](https://github.com/jedisct1/dnscrypt-proxy/blob/master/dnscrypt-resolvers.csv)
  28
  29 This command should display the server key fingerprint and exit. If
  30 this is not the case, try a different server. If this is the case,
  31 install the service:
  32
  33     dnscrypt-proxy.exe -R "name" --install
  34
  35 4) Change your DNS settings to `127.0.0.1`
  36
  37 Congratulations, you're now using DNSCrypt!
  38
  39 How to open an elevated command prompt
  40 --------------------------------------
  41
  42 On Windows 8.1 and Windows 10, press the Windows key + the X key and
  43 select "Windows Command Prompt (Admin)" or "Windows PowerShell (Admin)".
  44
  45 Advanced usage
  46 --------------
  47
  48 The Windows build of `dnscrypt-proxy` adds the following command-line
  49 options:
  50
  51 - `--install`: install the proxy as a service.
  52 - `--uninstall`: uninstall the service.
  53
  54 Startup options should specified as subkeys from this registry key:
  55 `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\dnscrypt-proxy\Parameters`
  56
  57 The service is named `dnscrypt-proxy`.
  58
  59 The following subkeys are recognized and should be self-explanatory:
  60
  61     Plugins           (REG_MULTI_SZ)
  62     LocalAddress      (REG_SZ)
  63     ProviderKey       (REG_SZ)
  64     ProviderName      (REG_SZ)
  65     ResolverAddress   (REG_SZ)
  66     ResolverName      (REG_SZ)
  67     ResolversList     (REG_SZ)
  68     EDNSPayloadSize   (DWORD)
  69     MaxActiveRequests (DWORD)
  70     TCPOnly           (DWORD)
  71     ClientKeyFile     (REG_SZ)
  72     EphemeralKeys     (DWORD)
  73
  74 For example, in order to listen to local address that is not the default
  75 `127.0.0.1`, the key to put the custom IP address is
  76 `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\dnscrypt-proxy\Parameters\LocalAddress`.
  77
  78 Mandatory entries to run `dnscrypt-proxy` as a Windows service are:
  79 - `ResolversList`: has to be set to the full path to the `dnscrypt-resolvers.csv` file.
  80 - `ResolverName`: has to be set to the resolver name to be used. See
  81 the `dnscrypt-resolvers.csv` file for a list of compatible public resolvers.
  82
  83 These entries are automatically created/updated when installing the service.
  84
  85 Plugins should be listed as paths to the `.DLL` files, optionally
  86 followed by a coma and plugin-specific arguments:
  87
  88     dnscrypt-proxy -R name --plugin=libdcplugin_example_ldns_aaaa_blocking.dll
  89     dnscrypt-proxy -R name --plugin=libdcplugin_example_ldns_blocking.dll,--domains=C:/blacklisted-domains.txt
  90
  91 The service should be restarted after the registry has been updated.