This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.
[samba.git] / docs / docbook / smbdotconf / security / forcegroup.xml
1 <samba:parameter name="force group"
2                  context="S"
3                  xmlns:samba="http://samba.org/common">
4 <listitem>
5     <para>This specifies a UNIX group name that will be 
6     assigned as the default primary group for all users connecting 
7     to this service. This is useful for sharing files by ensuring 
8     that all access to files on service will use the named group for 
9     their permissions checking. Thus, by assigning permissions for this 
10     group to the files and directories within this service the Samba 
11     administrator can restrict or allow sharing of these files.</para>
12
13     <para>In Samba 2.0.5 and above this parameter has extended 
14     functionality in the following way. If the group name listed here 
15     has a '+' character prepended to it then the current user accessing 
16     the share only has the primary group default assigned to this group 
17     if they are already assigned as a member of that group. This allows 
18     an administrator to decide that only users who are already in a 
19     particular group will create files with group ownership set to that 
20     group. This gives a finer granularity of ownership assignment. For 
21     example, the setting <filename moreinfo="none">force group = +sys</filename> means 
22     that only users who are already in group sys will have their default
23     primary group assigned to sys when accessing this Samba share. All
24     other users will retain their ordinary primary group.</para>
25
26     <para>If the <link linkend="FORCEUSER"><parameter moreinfo="none">force user</parameter>
27     </link> parameter is also set the group specified in 
28     <parameter moreinfo="none">force group</parameter> will override the primary group
29     set in <parameter moreinfo="none">force user</parameter>.</para>
30
31     <para>See also <link linkend="FORCEUSER"><parameter moreinfo="none">force user</parameter></link>.</para>
32
33     <para>Default: <emphasis>no forced group</emphasis></para>
34
35     <para>Example: <command moreinfo="none">force group = agroup</command></para>
36 </listitem>
37 </samba:parameter>