docs-xml/smbdotconf/logon/logonpath.xml

   1 <samba:parameter name="logon path"
   2                  context="G"
   3                                  type="string"
   4                  advanced="1" developer="1"
   5                  constant="1"
   6                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   7 <description>
   8         <para>
   9         This parameter specifies the directory where roaming profiles (Desktop, NTuser.dat, etc) are
  10         stored.  Contrary to previous versions of these manual pages, it has nothing to do with Win 9X roaming
  11         profiles.  To find out how to handle roaming profiles for Win 9X system, see the
  12         <smbconfoption name="logon home"/> parameter.
  13         </para>
  14
  15         <para>
  16         This option takes the standard substitutions, allowing you to have separate logon scripts for each user or
  17         machine.  It also specifies the directory from which the &quot;Application Data&quot;, <filename
  18         moreinfo="none">desktop</filename>, <filename moreinfo="none">start menu</filename>, <filename
  19         moreinfo="none">network neighborhood</filename>, <filename moreinfo="none">programs</filename> and other
  20         folders, and their contents, are loaded and displayed on your Windows NT client.
  21         </para>
  22
  23         <para>
  24         The share and the path must be readable by the user for the preferences and directories to be loaded onto the
  25         Windows NT client. The share must be writeable when the user logs in for the first time, in order that the
  26         Windows NT client can create the NTuser.dat and other directories.
  27         Thereafter, the directories and any of the contents can, if required, be made read-only.  It is not advisable
  28         that the NTuser.dat file be made read-only - rename it to NTuser.man to achieve the desired effect (a
  29         <emphasis>MAN</emphasis>datory profile).
  30         </para>
  31
  32         <para>
  33         Windows clients can sometimes maintain a connection to the [homes] share, even though there is no user logged
  34         in.  Therefore, it is vital that the logon path does not include a reference to the homes share (i.e. setting
  35         this parameter to \\%N\homes\profile_path will cause problems).
  36         </para>
  37
  38         <para>
  39         This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine.
  40         </para>
  41
  42         <warning><para>
  43         Do not quote the value. Setting this as <quote>\\%N\profile\%U</quote>
  44         will break profile handling. Where the tdbsam or ldapsam passdb backend
  45         is used, at the time the user account is created the value configured
  46         for this parameter is written to the passdb backend and that value will
  47         over-ride the parameter value present in the smb.conf file. Any error
  48         present in the passdb backend account record must be editted using the
  49         appropriate tool (pdbedit on the command-line, or any other locally
  50         provided system tool).
  51         </para></warning>
  52
  53         <para>Note that this option is only useful if Samba is set up as a domain controller.</para>
  54
  55         <para>
  56         Disable the use of roaming profiles by setting the value of this parameter to the empty string. For
  57         example, <smbconfoption name="logon path">""</smbconfoption>. Take note that even if the default setting
  58         in the smb.conf file is the empty string, any value specified in the user account settings in the passdb
  59         backend will over-ride the effect of setting this parameter to null. Disabling of all roaming profile use
  60         requires that the user account settings must also be blank.
  61         </para>
  62
  63         <para>
  64         An example of use is:
  65 <programlisting>
  66 logon path = \\PROFILESERVER\PROFILE\%U
  67 </programlisting>
  68         </para>
  69 </description>
  70 <value type="default">\\%N\%U\profile</value>
  71 </samba:parameter>