docs-xml/smbdotconf/security/serverrole.xml

   1 <samba:parameter name="server role"
   2                  context="G"
   3                                  type="enum"
   4                  function="_server_role"
   5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   6 <description>
   7     <para>This option determines the basic operating mode of a Samba
   8     server and is one of the most important settings in the <filename
   9     moreinfo="none"> smb.conf</filename> file.</para>
  10
  11     <para>The default is <command moreinfo="none">server role = auto</command>, as causes
  12     Samba to operate according to the <smbconfoption name="security"/> setting, or if not
  13     specified as a simple file server that is not connected to any domain.</para>
  14
  15     <para>The alternatives are
  16     <command moreinfo="none">server role = standalone</command> or <command moreinfo="none">server role = member server
  17     </command>, which support joining Samba to a Windows domain, along with <command moreinfo="none">server role = domain controller</command>, which run Samba as a Windows domain controller.</para>
  18
  19     <para>You should use <command moreinfo="none">server role = standalone</command> and
  20     <smbconfoption name="map to guest"/> if you
  21     want to mainly setup shares without a password (guest shares). This
  22     is commonly used for a shared printer server. </para>
  23
  24     <para><anchor id="AUTO"/><emphasis>SERVER ROLE = AUTO</emphasis></para>
  25
  26     <para>This is the default server role in Samba, and causes Samba to consult
  27     the <smbconfoption name="security"/> parameter (if set) to determine the server role, giving compatable behaviours to previous Samba versions.</para>
  28
  29     <para><anchor id="STANDALONE"/><emphasis>SERVER ROLE = STANDALONE</emphasis></para>
  30
  31     <para>If <smbconfoption name="security"/> is also not specified, this is the default security setting in Samba.
  32     In standalone operation, a client must first &quot;log-on&quot; with a
  33     valid username and password (which can be mapped using the <smbconfoption name="username map"/>
  34     parameter) stored on this machine. Encrypted passwords (see the <smbconfoption name="encrypted passwords"/> parameter) are by default
  35     used in this security mode. Parameters such as <smbconfoption name="user"/> and <smbconfoption
  36         name="guest only"/> if set      are then applied and
  37     may change the UNIX user to use on this connection, but only after
  38     the user has been successfully authenticated.</para>
  39
  40     <para><anchor id="MEMBER SERVER"/><emphasis>SERVER ROLE = MEMBER SERVER</emphasis></para>
  41
  42     <para>This mode will only work correctly if <citerefentry><refentrytitle>net</refentrytitle>
  43     <manvolnum>8</manvolnum></citerefentry> has been used to add this
  44     machine into a Windows Domain. It expects the <smbconfoption name="encrypted passwords"/>
  45         parameter to be set to <constant>yes</constant>. In this
  46     mode Samba will try to validate the username/password by passing
  47     it to a Windows or Samba Domain Controller, in exactly
  48     the same way that a Windows Server would do.</para>
  49
  50     <para><emphasis>Note</emphasis> that a valid UNIX user must still
  51     exist as well as the account on the Domain Controller to allow
  52     Samba to have a valid UNIX account to map file access to.  Winbind can provide this.</para>
  53
  54     <para><anchor id="PDC"/><emphasis>SERVER ROLE = CLASSIC PRIMARY DOMAIN CONTROLLER</emphasis></para>
  55
  56     <para>This mode of operation runs a classic Samba primary domain
  57     controller, providing domain logon services to Windows and Samba
  58     clients of an NT4-like domain.  Clients must be joined to the domain to
  59     create a secure, trusted path across the network.  There must be
  60     only one PDC per NetBIOS scope (typcially a broadcast network or
  61     clients served by a single WINS server).</para>
  62
  63     <para><anchor id="BDC"/><emphasis>SERVER ROLE = NETBIOS BACKUP DOMAIN CONTROLLER</emphasis></para>
  64
  65     <para>This mode of operation runs a classic Samba backup domain
  66     controller, providing domain logon services to Windows and Samba
  67     clients of an NT4-like domain.  As a BDC, this allows
  68     multiple Samba servers to provide redundant logon services to a
  69     single NetBIOS scope.</para>
  70
  71     <para><anchor id="AD-DC"/><emphasis>SERVER ROLE = ACTIVE DIRECTORY DOMAIN CONTROLLER</emphasis></para>
  72
  73     <para>This mode of operation runs Samba as an active directory
  74     domain controller, providing domain logon services to Windows and
  75     Samba clients of the domain.  This role requires special
  76     configuration, see the <ulink
  77     url="http://wiki.samba.org/index.php/Samba4/HOWTO">Samba4
  78     HOWTO</ulink></para>
  79
  80 </description>
  81
  82 <related>security</related>
  83 <related>realm</related>
  84 <related>encrypt passwords</related>
  85
  86 <value type="default">AUTO</value>
  87 <value type="example">DOMAIN CONTROLLER</value>
  88 </samba:parameter>