pdns/recursordist/docs/manpages/pdns_recursor.1.rst

   1 pdns_recursor
   2 =============
   3
   4 Synopsis
   5 --------
   6 **pdns_recursor** [*OPTION*]...
   7
   8 Description
   9 -----------
  10 :program:`pdns_recursor` is a high performance, simple and secure recursing
  11 nameserver. It currently powers hundreds of millions internet connections.
  12
  13 The recursor is configured via a configuration file, but each item in
  14 that file can be overridden on the command line.
  15
  16 This manpage lists the core set of features needed to get the PowerDNS Recursor
  17 working, for full and up to date details head to `<https://doc.powerdns.com/>`_.
  18
  19 Examples
  20 --------
  21 To listen on 192.0.2.53 and allow the 192.0.2.0/24 subnet to recurse, and run
  22 as in the background, execute::
  23
  24     # pdns_recursor --local-address=192.0.2.53 --allow-from=192.0.2.0/24 --daemon
  25
  26 To stop the recursor by hand, run::
  27
  28     # rec_control quit
  29
  30 However, the recommended way of starting and stopping the recursor is to use
  31 :manpage:`systemctl(1)` or the init.d script.
  32
  33 Options
  34 -------
  35 For authoritative listing of options, consult the online documentation
  36 at `<https://doc.powerdns.com/>`
  37
  38 --allow-from=<networks>
  39     If set, only allow these comma separated *networks*,
  40     with network mask to recurse. For example: 192.0.2.0/24,203.0.113.128/25.
  41 --auth-zones=<authzones>
  42     Where *authzone* is <zonename>=<filename>.
  43     Serve *zonename* from *filename* authoritatively. For example:
  44     ds9a.nl=/var/zones/ds9a.nl,powerdns.com=/var/zones/powerdns.com.
  45 --chroot=<directory>
  46     chroot the process to *directory*.
  47 --client-tcp-timeout=<num>
  48     Timeout in seconds when talking to TCP clients.
  49 --config
  50     Show the current configuration. Since 4.8.0 there are three optional values:
  51     ``--config=default`` to show the default configuration.
  52     ``--config=diff``    show modified options in the current configuration.
  53     ``--config=check``   to check the current configuration for errors.
  54 --config-dir=<directory>
  55     Location of configuration directory (recursor.conf), the default
  56     depends on the SYSCONFDIR option at build-time, which is usually
  57     /etc/powerdns. The default can be found with
  58     ``pdns_recursor --config | grep ' config-dir='``.
  59 --daemon
  60     Operate as a daemon.
  61 --entropy-source=<file>
  62     Read new entropy from *file*, defaults to /dev/urandom.
  63 --export-etc-hosts
  64     If set, this flag will export the hostnames and IP addresses
  65     mentioned in /etc/hosts.
  66 --forward-zones=<forwardzones>
  67     Where *forwardzone* is <zonename>=<address>.
  68     Queries for *zonename* will be forwarded to *address*. *address*
  69     should be an IP address, not a hostname (to prevent chicken and egg
  70     problems). Example: forward-zones= ds9a.nl=213.244.168.210,
  71     powerdns.com=127.0.0.1.
  72 --forward-zones-file=<filename>
  73     Similar to *--forward-zones*, but read the options from *filename*.
  74     *filename* should contain one zone per line, like:
  75     ds9a.nl=213.244.168.210.
  76 --help
  77     Show a summary of options.
  78 --hint-file=<filename>
  79     Load root hints from this *filename*
  80 --local-address=<address>
  81     Listen on *address*, separated by spaces or commas.
  82     Addresses specified can include port numbers; any which do not
  83     include port numbers will listen on *--local-port*.
  84 --local-port=<port>
  85     Listen on *port*.
  86 --log-common-errors
  87     If we should log rather common errors.
  88 --max-cache-entries=<num>
  89     Maximum number of entries in the main cache.
  90 --max-negative-ttl=<num>
  91     maximum number of seconds to keep a negative cached entry in memory.
  92 --max-tcp-clients=<num>
  93     Maximum number of simultaneous TCP clients.
  94 --max-tcp-per-client=<num>
  95     If set, maximum number of TCP sessions per client (IP address).
  96 --query-local-address=<address[,address...]>
  97     Use *address* as Source IP address when sending queries.
  98 --quiet
  99     Suppress logging of questions and answers.
 100 --server-id=<text>
 101     Return *text* WHen queried for 'id.server' TXT, defaults to
 102     hostname.
 103 --serve-rfc1918
 104     On by default, this makes the server authoritatively aware of:
 105     10.in-addr.arpa, 168.192.in-addr.arpa and 16-31.172.in-addr.arpa,
 106     which saves load on the AS112 servers. Individual parts of these
 107     zones can still be loaded or forwarded.
 108 --setgid=<gid>
 109     If set, change group id to *gid* for more security.
 110 --setuid=<uid>
 111     If set, change user id to *uid* for more security.
 112 --single-socket
 113     If set, only use a single socket for outgoing queries.
 114 --socket-dir=<directory>
 115     The controlsocket will live in *directory*.
 116 --spoof-nearmiss-max=<num>
 117     If non-zero, assume spoofing after this many near misses.
 118 --trace
 119     if we should output heaps of logging.
 120 --version-string=<text>
 121     *text* WILL be reported on version.pdns or version.bind queries.
 122
 123 See also
 124 --------
 125 :manpage:`rec_control(1)`
 126 :manpage:`systemctl(1)`
 127 `<https://docs.powerdns.com/recursor>`__