From 8daa83a594a2e98f39d764422bfbdbc62c9efd44 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Fri, 19 Apr 2024 19:20:00 +0200
Subject: Adding upstream version 2:4.20.0+dfsg.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 docs-xml/smbdotconf/logon/adduserscript.xml | 47 +++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 docs-xml/smbdotconf/logon/adduserscript.xml

(limited to 'docs-xml/smbdotconf/logon/adduserscript.xml')

diff --git a/docs-xml/smbdotconf/logon/adduserscript.xml b/docs-xml/smbdotconf/logon/adduserscript.xml
new file mode 100644
index 0000000..4be1146
--- /dev/null
+++ b/docs-xml/smbdotconf/logon/adduserscript.xml
@@ -0,0 +1,47 @@
+<samba:parameter name="add user script"
+                 context="G"
+                 type="string"
+                 substitution="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>
+	This is the full pathname to a script that will be run <emphasis>AS ROOT</emphasis> by 
+	<citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> 
+	under special circumstances described below.
+	</para>
+
+	<para>
+	Normally, a Samba server requires that UNIX users are created for all users accessing 
+	files on this server. For sites that use Windows NT account databases as their primary 
+	user database creating these users and keeping the user list in sync with the Windows 
+	NT PDC is an onerous task. This option allows smbd to create the required UNIX users 
+	 <emphasis>ON DEMAND</emphasis> when a user accesses the Samba server.
+	</para>
+
+	<para>
+	When the Windows user attempts to access the Samba server, at login (session setup in 
+	the SMB protocol) time, <citerefentry><refentrytitle>smbd</refentrytitle>
+	<manvolnum>8</manvolnum></citerefentry> contacts the <smbconfoption name="password server"/> 
+	and attempts to authenticate the given user with the given password. If the authentication 
+	succeeds then <command moreinfo="none">smbd</command> attempts to find a UNIX user in the UNIX 
+	password database to map the Windows user into. If this lookup fails, and 
+	<smbconfoption name="add user script"/> is set then <command moreinfo="none">smbd</command> will
+	call the specified script <emphasis>AS ROOT</emphasis>, expanding any 
+	<parameter moreinfo="none">%u</parameter> argument to be the user name to create.
+	</para>
+
+	<para>
+	If this script successfully creates the user then <command moreinfo="none">smbd</command> will 
+	continue on as though the UNIX user already existed. In this way, UNIX users are dynamically created to
+	match existing Windows NT accounts.
+	</para>
+
+	<para>
+	See also <smbconfoption name="security"/>, <smbconfoption name="password server"/>,
+	<smbconfoption name="delete user script"/>.
+	</para>
+</description>
+
+<value type="default"/>
+<value type="example">/usr/local/samba/bin/add_user %u</value>
+</samba:parameter>
-- 
cgit v1.2.3