487d8b8a9d18bb3f543b4d28620b2ba7d45a4b6e
[ira/wip.git] / docs-xml / smbdotconf / security / passdbbackend.xml
1 <samba:parameter name="passdb backend"
2                  context="G"
3                  type="list"
4                  advanced="1" developer="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7
8     <para>This option allows the administrator to chose which backend
9     will be used for storing user and possibly group information.  This allows 
10     you to swap between different storage mechanisms without recompile. </para>
11
12     <para>The parameter value is divided into two parts, the backend's name, and a 'location'
13     string that has meaning only to that particular backed.  These are separated
14     by a : character.</para>
15
16     <para>Available backends can include:
17         <itemizedlist>
18             <listitem>
19                 <para><command moreinfo="none">smbpasswd</command> - The default smbpasswd
20                 backend. Takes a path to the smbpasswd file as an optional argument.
21                 </para>
22             </listitem>
23                         
24             <listitem>
25                 <para><command moreinfo="none">tdbsam</command> - The TDB based password storage
26                 backend.  Takes a path to the TDB as an optional argument (defaults to passdb.tdb 
27                 in the <smbconfoption name="private dir"/> directory.</para>
28             </listitem>
29                         
30             <listitem>
31                 <para><command moreinfo="none">ldapsam</command> - The LDAP based passdb 
32                 backend.  Takes an LDAP URL as an optional argument (defaults to 
33                 <command moreinfo="none">ldap://localhost</command>)</para>
34                         
35                 <para>LDAP connections should be secured where possible.  This may be done using either
36                 Start-TLS (see <smbconfoption name="ldap ssl"/>) or by
37                 specifying <parameter moreinfo="none">ldaps://</parameter> in
38                 the URL argument. </para>
39
40                 <para>Multiple servers may also be specified in double-quotes.
41                 Whether multiple servers are supported or not and the exact
42                 syntax depends on the LDAP library you use.
43                 </para>
44
45             </listitem>
46         </itemizedlist>
47
48     </para>
49         Examples of use are:
50 <programlisting>
51 passdb backend = tdbsam:/etc/samba/private/passdb.tdb 
52
53 or multi server LDAP URL with OpenLDAP library:
54
55 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
56
57 or multi server LDAP URL with Netscape based LDAP library:
58
59 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap-2.example.com"
60 </programlisting>
61 </description>
62
63 <value type="default">smbpasswd</value>
64 </samba:parameter>