release/src/router/dnscrypt/man/dnscrypt-proxy.8.markdown

   1 dnscrypt-proxy(8) -- A DNSCrypt forwarder
   2 =========================================
   3
   4 ## SYNOPSIS
   5
   6 `dnscrypt-proxy` [<options>]
   7
   8 ## DESCRIPTION
   9
  10 **dnscrypt-proxy** accepts DNS requests, authenticates and encrypts
  11 them using dnscrypt and forwards them to a remote dnscrypt-enabled
  12 resolver.
  13
  14 Replies from the resolver are expected to be authenticated and
  15 encrypted or else they will be discarded.
  16
  17 The proxy verifies the replies, decrypts them, and transparently
  18 forwards them to the local stub resolver.
  19
  20 `dnscrypt-proxy` listens to `127.0.0.1` / port `53` by default.
  21
  22 ## WARNING
  23
  24 **dnscrypt-proxy** is not a DNS cache. Unless your operating system
  25 already provides a decent built-in cache (and by default, most systems
  26 don't), clients shouldn't directly send requests to **dnscrypt-proxy**.
  27
  28 Intead, run a DNS cache like **Unbound**, and configure it to use
  29 **dnscrypt-proxy** as a forwarder. Both can safely run on the same
  30 machine as long as they use different IP addresses and/or different
  31 ports.
  32
  33 ## OPTIONS
  34
  35   * `-a`, `--local-address=<ip>[:port]`: what local IP the daemon will listen
  36     to, with an optional port. The default port is 53.
  37
  38   * `-d`, `--daemonize`: detach from the current terminal and run the server
  39     in background.
  40
  41   * `-e`, `--edns-payload-size=<bytes>`: transparently add an OPT
  42     pseudo-RR to outgoing queries in order to enable the EDNS0
  43     extension mechanism. The payload size is the size of the largest
  44     response we accept from the resolver before retrying over TCP.
  45     This feature is enabled by default, with a payload size of 1252
  46     bytes. Any value below 512 disables it.
  47
  48   * `-h`, `--help`: show usage.
  49
  50   * `-k`, `--provider-key=<key>`: specify the provider public key (see below).
  51
  52   * `-L`, `--resolvers-list=<file>`: path to the CSV file containing
  53     the list of available resolvers, and the parameters to use them.
  54
  55   * `-l`, `--logfile=<file>`: log events to this file instead of the
  56     standard output.
  57
  58   * `-m`, `--loglevel=<level>`: don't log events with priority above
  59     this level after the service has been started up. Default is the value
  60     for `LOG_INFO`.
  61
  62   * `-n`, `--max-active-requests=<count>`: set the maximum number of
  63     simultaneous active requests. The default value is 250.
  64
  65   * `-p`, `--pidfile=<file>`: write the PID number to a file.
  66
  67   * `-R`, `--resolver-name=<name>`: name of the resolver to use, from
  68     the list of available resolvers (see `-L`).
  69
  70   * `-r`, `--resolver-address=<ip>[:port]`: a DNSCrypt-capable resolver IP
  71     address with an optional port. The default port is 443.
  72
  73   * `-t`, `--test=<margin>`: don't actually start the proxy, but check that
  74     a valid certificate can be retrieved from the server and that it
  75     will remain valid for the next <margin> minutes. The exit code is 0
  76     if a valid certificate can be used, 2 if no valid certificates can be used,
  77     3 if a timeout occurred, and 4 if a currently valid certificate is
  78     going to expire before <margin>. The margin is always specificied in
  79     minutes.
  80
  81   * `-u`, `--user=<user name>`: chroot(2) to this user's home directory
  82     and drop privileges.
  83
  84   * `-N`, `--provider-name=<FQDN>`: the fully-qualified name of the
  85     dnscrypt certificate provider.
  86
  87   * `-T`, `--tcp-only`: always use TCP. A connection made using UDP
  88     will get a truncated response, so that the (stub) resolver retries using
  89     TCP.
  90
  91   * `-V`, `--version`: show version number.
  92
  93 A public key is 256-bit long, and it has to be specified as a hexadecimal
  94 string, with optional columns.
  95
  96 ## SIMPLE USAGE EXAMPLE
  97
  98     $ dnscrypt-proxy --daemonize --resolver-name=...
  99
 100 ## ADVANCED USAGE EXAMPLE
 101
 102     $ dnscrypt-proxy --provider-key=B735:1140:206F:225D:3E2B:D822:D7FD:691E:A1C3:3CC8:D666:8D0C:BE04:BFAB:CA43:FB79 --provider-name=2.dnscrypt-cert.dnscrypt.org. --resolver-address=208.67.220.220:53 --daemonize
 103
 104 ## SEE ALSO
 105
 106 hostip(8)