summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/logon/logonscript.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/smbdotconf/logon/logonscript.xml')
-rw-r--r--docs/smbdotconf/logon/logonscript.xml43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/smbdotconf/logon/logonscript.xml b/docs/smbdotconf/logon/logonscript.xml
new file mode 100644
index 0000000000..7e7561ca65
--- /dev/null
+++ b/docs/smbdotconf/logon/logonscript.xml
@@ -0,0 +1,43 @@
+<samba:parameter name="logon script"
+ context="G"
+ advanced="1" developer="1"
+ type="string"
+ xmlns:samba="http://samba.org/common">
+<description>
+ <para>This parameter specifies the batch file (.bat) or
+ NT command file (.cmd) to be downloaded and run on a machine when
+ a user successfully logs in. The file must contain the DOS
+ style CR/LF line endings. Using a DOS-style editor to create the
+ file is recommended.</para>
+
+ <para>The script must be a relative path to the [netlogon]
+ service. If the [netlogon] service specifies a <link linkend="PATH">
+ <parameter moreinfo="none">path</parameter></link> of <filename
+ moreinfo="none">/usr/local/samba/netlogon</filename>, and <command
+ moreinfo="none">logon script = STARTUP.BAT</command>, then
+ the file that will be downloaded is:</para>
+
+ <para><filename moreinfo="none">/usr/local/samba/netlogon/STARTUP.BAT</filename></para>
+
+ <para>The contents of the batch file are entirely your choice. A
+ suggested command would be to add <command moreinfo="none">NET TIME \\SERVER /SET
+ /YES</command>, to force every machine to synchronize clocks with
+ the same time server. Another use would be to add <command moreinfo="none">NET USE
+ U: \\SERVER\UTILS</command> for commonly used utilities, or <screen>
+ <userinput>NET USE Q: \\SERVER\ISO9001_QA</userinput></screen> for example.</para>
+
+ <para>Note that it is particularly important not to allow write
+ access to the [netlogon] share, or to grant users write permission
+ on the batch files in a secure environment, as this would allow
+ the batch files to be arbitrarily modified and security to be
+ breached.</para>
+
+ <para>This option takes the standard substitutions, allowing you
+ to have separate logon scripts for each user or machine.</para>
+
+ <para>This option is only useful if Samba is set up as a logon
+ server.</para>
+</description>
+<value type="default"></value>
+<value type="example">scripts\%U.bat</value>
+</samba:parameter>