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://dnscrypt.org) and open the `bin`
  17 directory.
  18
  19 2) Copy the `dnscrypt-proxy.exe` file to any location, as well as the
  20 dnscrypt-resolvers.csv file and the DLL files.
  21 All the files should be in the same location.
  22
  23 3) Open an elevated command prompt and type (you may need to specify
  24 the full path to the file):
  25
  26     dnscrypt-proxy.exe -R "name" -L "<full path to the dnscrypt-resolvers.csv file>" --test=0
  27
  28 Replace `name` with one of the resolvers from CSV file. The (possibly
  29 updated) file can also be viewed online:
  30 [public DNS resolvers supporting DNSCrypt](https://github.com/jedisct1/dnscrypt-proxy/blob/master/dnscrypt-resolvers.csv)
  31
  32 This command should display the server key fingerprint and exit. If
  33 this is not the case, try a different server. If this is the case,
  34 install the service:
  35
  36     dnscrypt-proxy.exe -R "name" -L "<full path to the dnscrypt-resolvers.csv file>" --install
  37
  38 4) Change your DNS settings to `127.0.0.1`
  39
  40 Congratulations, you're now using DNSCrypt.
  41
  42 How to open an elevated command prompt
  43 --------------------------------------
  44
  45 On Windows 8.1, press the Windows key + the X key and select "Windows
  46 Command Prompt (Admin)" or "Windows PowerShell (Admin)".
  47
  48 Advanced usage
  49 --------------
  50
  51 The Windows build of `dnscrypt-proxy` adds the following command-line
  52 options:
  53
  54 - `--install`: install the proxy as a service.
  55 - `--uninstall`: uninstall the service.
  56
  57 Startup options should specified as subkeys from this registry key:
  58 `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\dnscrypt-proxy\Parameters`
  59
  60 The service is named `dnscrypt-proxy`.
  61
  62 The following subkeys are recognized and should be self-explanatory:
  63
  64     Plugins           (REG_MULTI_SZ)
  65     LocalAddress      (REG_SZ)
  66     ProviderKey       (REG_SZ)
  67     ProviderName      (REG_SZ)
  68     ResolverAddress   (REG_SZ)
  69     ResolverName      (REG_SZ)
  70     ResolversList     (REG_SZ)
  71     EDNSPayloadSize   (DWORD)
  72     MaxActiveRequests (DWORD)
  73     TCPOnly           (DWORD)
  74
  75 For example, in order to listen to local address `127.0.0.7` instead
  76 of `127.0.0.1`, the string value `127.0.0.7` should be set for the key
  77 `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\dnscrypt-proxy\Parameters\LocalAddress`.
  78
  79 Mandatory entries to run `dnscrypt-proxy` as a Windows service are:
  80 - `ResolversList`: has to be set to the full path to the `dnscrypt-resolvers.csv` file.
  81 - `ResolverName`: has to be set to the resolver name to be used. See
  82 the `dnscrypt-resolvers.csv` file for a list of compatible public resolvers.
  83
  84 These entries are automatically created/updated when installing the service.
  85
  86 Plugins should be listed as full paths to .DLL files, optionally
  87 followed by a coma and plugin-specific arguments.
  88
  89 The service should be restarted after the registry has been updated.