docs/docbook/smbdotconf/security/forcegroup.xml

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