docs-xml/smbdotconf/security/passdbbackend.xml

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