summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/misc
diff options
context:
space:
mode:
authorJeremy Allison <jra@samba.org>2006-05-19 01:22:17 +0000
committerGerald W. Carter <jerry@samba.org>2008-04-23 08:47:19 -0500
commit9b6c6fc14e8181968d2b426ddc4995492d72fb50 (patch)
treebf3fe420d4bbef259763d5019962288cb5e16323 /docs/smbdotconf/misc
parent78fd164d6d2f0da8f0f7e04991d2e6798ec87d1f (diff)
downloadsamba-9b6c6fc14e8181968d2b426ddc4995492d72fb50.tar.gz
samba-9b6c6fc14e8181968d2b426ddc4995492d72fb50.tar.bz2
samba-9b6c6fc14e8181968d2b426ddc4995492d72fb50.zip
Add usershare prefix allow/deny list docs.
Jeremy. (This used to be commit 13f6dba9d07ab294c413d5b36601a4919931c418)
Diffstat (limited to 'docs/smbdotconf/misc')
-rw-r--r--docs/smbdotconf/misc/usershareprefixallowlist.xml24
-rw-r--r--docs/smbdotconf/misc/usershareprefixdenylist.xml25
2 files changed, 49 insertions, 0 deletions
diff --git a/docs/smbdotconf/misc/usershareprefixallowlist.xml b/docs/smbdotconf/misc/usershareprefixallowlist.xml
new file mode 100644
index 0000000000..bacc2e9530
--- /dev/null
+++ b/docs/smbdotconf/misc/usershareprefixallowlist.xml
@@ -0,0 +1,24 @@
+<samba:parameter name="usershare prefix allow list"
+ context="G"
+ basic="1" advanced="1"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This parameter specifies a list of absolute pathnames
+ the root of which are allowed to be exported by user defined share definitions.
+ If the pathname exported doesn't start with one of the strings in this
+ list the user defined share will not be allowed. This allows the Samba
+ administrator to restrict the directories on the system that can be
+ exported by user defined shares.
+ </para>
+ <para>
+ If there is a "usershare prefix deny list" and also a
+ "usershare prefix allow list" the deny list is processed
+ first, followed by the allow list, thus leading to the most
+ restrictive interpretation.
+ </para>
+
+</description>
+<value type="default">NULL</value>
+<value type="example">/home /data /space</value>
+</samba:parameter>
diff --git a/docs/smbdotconf/misc/usershareprefixdenylist.xml b/docs/smbdotconf/misc/usershareprefixdenylist.xml
new file mode 100644
index 0000000000..75d4ba9afc
--- /dev/null
+++ b/docs/smbdotconf/misc/usershareprefixdenylist.xml
@@ -0,0 +1,25 @@
+<samba:parameter name="usershare prefix deny list"
+ context="G"
+ basic="1" advanced="1"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This parameter specifies a list of absolute pathnames
+ the root of which are NOT allowed to be exported by user defined share definitions.
+ If the pathname exported starts with one of the strings in this
+ list the user defined share will not be allowed. Any pathname not
+ starting with one of these strings will be allowed to be exported
+ as a usershare. This allows the Samba administrator to restrict the
+ directories on the system that can be exported by user defined shares.
+ </para>
+ <para>
+ If there is a "usershare prefix deny list" and also a
+ "usershare prefix allow list" the deny list is processed
+ first, followed by the allow list, thus leading to the most
+ restrictive interpretation.
+ </para>
+
+</description>
+<value type="default">NULL</value>
+<value type="example">/etc /dev /private</value>
+</samba:parameter>