docs-xml/smbdotconf/logon/adduserscript.xml

   1 <samba:parameter name="add user script"
   2                  context="G"
   3                                  type="string"
   4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   5 <description>
   6         <para>
   7         This is the full pathname to a script that will be run <emphasis>AS ROOT</emphasis> by
   8         <citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry>
   9         under special circumstances described below.
  10         </para>
  11
  12         <para>
  13         Normally, a Samba server requires that UNIX users are created for all users accessing
  14         files on this server. For sites that use Windows NT account databases as their primary
  15         user database creating these users and keeping the user list in sync with the Windows
  16         NT PDC is an onerous task. This option allows smbd to create the required UNIX users
  17          <emphasis>ON DEMAND</emphasis> when a user accesses the Samba server.
  18         </para>
  19
  20         <para>
  21         When the Windows user attempts to access the Samba server, at login (session setup in
  22         the SMB protocol) time, <citerefentry><refentrytitle>smbd</refentrytitle>
  23         <manvolnum>8</manvolnum></citerefentry> contacts the <smbconfoption name="password server"/>
  24         and attempts to authenticate the given user with the given password. If the authentication
  25         succeeds then <command moreinfo="none">smbd</command> attempts to find a UNIX user in the UNIX
  26         password database to map the Windows user into. If this lookup fails, and
  27         <smbconfoption name="add user script"/> is set then <command moreinfo="none">smbd</command> will
  28         call the specified script <emphasis>AS ROOT</emphasis>, expanding any
  29         <parameter moreinfo="none">%u</parameter> argument to be the user name to create.
  30         </para>
  31
  32         <para>
  33         If this script successfully creates the user then <command moreinfo="none">smbd</command> will
  34         continue on as though the UNIX user already existed. In this way, UNIX users are dynamically created to
  35         match existing Windows NT accounts.
  36         </para>
  37
  38         <para>
  39         See also <smbconfoption name="security"/>, <smbconfoption name="password server"/>,
  40         <smbconfoption name="delete user script"/>.
  41         </para>
  42 </description>
  43
  44 <value type="default"/>
  45 <value type="example">/usr/local/samba/bin/add_user %u</value>
  46 </samba:parameter>