Moving docs tree to docs-xml to make room for generated docs in the release tarball.
[Samba.git] / docs-xml / smbdotconf / security / forcegroup.xml
blobf6c9974f99dae0b9d666ef1145db2ed6bbb6a9f0
1 <samba:parameter name="force group"
2                  context="S"
3                                  type="string"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <synonym>group</synonym>
6 <description>
7     <para>This specifies a UNIX group name that will be 
8     assigned as the default primary group for all users connecting 
9     to this service. This is useful for sharing files by ensuring 
10     that all access to files on service will use the named group for 
11     their permissions checking. Thus, by assigning permissions for this 
12     group to the files and directories within this service the Samba 
13     administrator can restrict or allow sharing of these files.</para>
15     <para>In Samba 2.0.5 and above this parameter has extended 
16     functionality in the following way. If the group name listed here 
17     has a '+' character prepended to it then the current user accessing 
18     the share only has the primary group default assigned to this group 
19     if they are already assigned as a member of that group. This allows 
20     an administrator to decide that only users who are already in a 
21     particular group will create files with group ownership set to that 
22     group. This gives a finer granularity of ownership assignment. For 
23     example, the setting <filename moreinfo="none">force group = +sys</filename> means 
24     that only users who are already in group sys will have their default
25     primary group assigned to sys when accessing this Samba share. All
26     other users will retain their ordinary primary group.</para>
28     <para>
29         If the <smbconfoption name="force user"/> parameter is also set the group specified in 
30     <parameter moreinfo="none">force group</parameter> will override the primary group
31     set in <parameter moreinfo="none">force user</parameter>.</para>
33 </description>
35 <related>force user</related>
37 <value type="default"/>
38 <value type="example">agroup</value>
39 </samba:parameter>