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 Quickstart
  10 ----------
  11
  12 1) Download and extract the latest
  13 [Windows package for dnscrypt](http://dnscrypt.org)
  14
  15 2) Copy the `dnscrypt-proxy.exe` file to any location.
  16
  17 3) Open a terminal (run `cmd.exe`) and type (you may need to specify
  18 the full path to the file):
  19
  20     dnscrypt-proxy.exe --install
  21
  22 4) Change your DNS settings to `127.0.0.1`
  23
  24 Congratulations, you're now using DNSCrypt.
  25
  26 Advanced usage
  27 --------------
  28
  29 The Windows build of `dnscrypt-proxy` adds the following command-line
  30 options:
  31
  32 - `--install`: install the proxy as a service.
  33 - `--reinstall`: ditto.
  34 - `--uninstall`: uninstall the service.
  35
  36 Startup options should specified as subkeys from this registry key:
  37 `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\dnscrypt-proxy\Parameters`
  38
  39 The service is named `dnscrypt-proxy`.
  40
  41 The following subkeys are recognized and should be self-explanatory:
  42
  43     Plugins           (REG_MULTI_SZ)
  44     LocalAddress      (REG_SZ)
  45     ProviderKey       (REG_SZ)
  46     ProviderName      (REG_SZ)
  47     ResolverAddress   (REG_SZ)
  48     EDNSPayloadSize   (DWORD)
  49     MaxActiveRequests (DWORD)
  50     TCPOnly           (DWORD)
  51
  52 For example, in order to listen to local address `127.0.0.7` instead
  53 of `127.0.0.1`, the string value `127.0.0.7` should be set for the key
  54 `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\dnscrypt-proxy\Parameters\LocalAddress`.
  55
  56 Plugins should be listed as full paths to .DLL files, optionally
  57 followed by a coma and plugin-specific arguments.
  58
  59 The service should be restarted after the registry has been updated.