Prevent potential side effects and use local variables here
[pdns-ldap-backend/landonf.git] / USAGE
blob02a56acdfdf02d2f5d5a3715baa0cf7335185b1a
1 Configuration Options
2 =====================
4 There are a few options through which the LDAP DNS backend can be configured
5 for your environment. Add them to the pdns.conf file located in /etc/powerdns
6 or /usr/local/etc/ (depends on your configuration while compiling):
8 * launch=ldap
9   You'll have to add the LDAP DNS backend to the PowerDNS backends first by
10   altering the launch declaration in the pdns.conf file. Otherwise the options
11   below won't have any effect.
13 * ldap-host (default "ldap://127.0.0.1:389/")
14   The values assigned to this parameter can be LDAP URIs (e.g. ldap://127.0.0.1/
15   or ldaps://127.0.0.1/) describing the connection to the LDAP server. There can
16   be multiple LDAP URIs specified for load balancing and high availability if
17   they are separated by spaces. In case the used LDAP client library doesn't
18   support LDAP URIs as connection parameter, use plain host names or
19   IP addresses instead (both may optionally be followed by a colon and the port).
21 * ldap-timeout (default "5")
22   The number of seconds to wait for LDAP operations to complete.
24 * ldap-reconnect-attempts (default "5")
25   The number of attempts to make to re-establish a lost connection to LDAP.
27 * ldap-starttls (default "no")
28   Use TLS encrypted connections to the LDAP server. This is only allowed if
29   ldap-host is a ldap:// URI or a host name / IP address.
31 * ldap-basedn (default "")
32   The PowerDNS LDAP DNS backend searches below this path for objects containing
33   the specified DNS information. The retrieval of attributes is limited to this
34   subtree. This option must be set to the path according to the layout of your
35   LDAP tree, e.g. ou=hosts,o=linuxnetworks,c=de is the DN to my objects
36   containing the DNS information.
38 * ldap-basedn-axfr-override (default "")
39   Override base dn for AXFR subtree search.
41 * ldap-bindmethod (default "simple")
42   The bind method to use to authenticate against the LDAP server.
43   - simple
44     Use a login / password pair (or anonymous if none is given). This is
45     configured further with the directives 'ldap-binddn' and 'ldap-bindsecret'.
46   - gssapi
47     Use GSSAPI authentication. This is configured with the directives
48     'ldap-krb5-keytab' and 'ldap-krb5-ccache'. See the 'GSSAPI' section below
49     for instruction to use this.
51 * ldap-binddn (default "")
52   Path to the object to authenticate against. Should only be used, if the LDAP
53   server doesn't support anonymous binds.
55 * ldap-secret (default "")
56   Password for authentication against the object specified by ldap-binddn
58 * ldap-krb5-keytab (default "")
59   The path to the keytab containing authentication data. The first principal
60   found in this file is used.
62 * ldap-krb5-ccache (default "")
63   The path to the kerberos ticket cache file to use. See below in the 'GSSAPI'
64   section for setting this up.
66 * ldap-method (default "simple")
67   - simple
68     Search the requested domain by comparing the associatedDomain attributes
69     with the domain string in the question.
70   - tree
71     Search entries by translating the domain string into a LDAP dn. Your LDAP
72     tree must be designed in the same way as your DNS LDAP tree. The question
73     for "myhost.linuxnetworks.de" would translate into
74     "dc=myhost,dc=linuxnetworks,dc=de,ou=hosts=..." and the entry where this
75     dn points to would be evaluated for dns records. 
76   - strict
77     Like simple, but generates PTR records from aRecords or aAAARecords.
78     Using "strict", you won't be able to do zone transfers for reverse zones.
80 * ldap-filter-axfr (default "(:target:)" )
81   LDAP filter for limiting AXFR results (zone transfers), e.g.
82   "(&(:target:)(active=yes))" for returning only entries whose attribute
83   "active" is set to "yes".
85 * ldap-filter-lookup (default "(:target:)" )
86   LDAP filter for limiting IP or name lookups, e.g. "(&(:target:)(active=yes))"
87   for returning only entries whose attribute "active" is set to "yes".
89 License
90 =======
92 This document is made available under CC BY-NC-SA 3.0
93 (http://creativecommons.org/licenses/by-nc-sa/3.0/) as it integrates text
94 originally published with this license. Original content is copyright
95 Norbert Sendetzky and can be found at
96 http://www.linuxnetworks.de/doc/index.php/PowerDNS_LDAP_Backend/Installation