From 33dbd7f0bb6cff21bc9d0093f33ac6b49a02e5b2 Mon Sep 17 00:00:00 2001 From: Guenther Deschner Date: Wed, 25 Nov 2009 14:54:48 +0000 Subject: [PATCH] Various updates to inline documentation in default smb.conf file resolves: #483703 Guenther cvs: ---------------------------------------------------------------------- --- samba.spec | 6 +- smb.conf.default | 311 +++++++++++++++++++++++++---------------------- 2 files changed, 174 insertions(+), 143 deletions(-) diff --git a/samba.spec b/samba.spec index 0215887..ec819cc 100644 --- a/samba.spec +++ b/samba.spec @@ -1,4 +1,4 @@ -%define main_release 48 +%define main_release 49 %define samba_version 3.4.3 %define tdb_version 1.1.3 %define talloc_version 1.3.0 @@ -654,6 +654,10 @@ exit 0 %{_datadir}/pixmaps/samba/logo-small.png %changelog +* Wed Nov 25 2009 Guenther Deschner - 3.4.3-49 +- Various updates to inline documentation in default smb.conf file +- resolves: #483703 + * Thu Oct 29 2009 Guenther Deschner - 3.4.3-48 - Update to 3.4.3 diff --git a/smb.conf.default b/smb.conf.default index 5be6fa0..5c2d217 100644 --- a/smb.conf.default +++ b/smb.conf.default @@ -1,102 +1,119 @@ -# This is the main Samba configuration file. You should read the -# smb.conf(5) manual page in order to understand the options listed -# here. Samba has a huge number of configurable options (perhaps too -# many!) most of which are not shown in this example +# This is the main Samba configuration file. For detailed information about the +# options listed here, refer to the smb.conf(5) manual page. Samba has a huge +# number of configurable options, most of which are not shown in this example. # -# For a step to step guide on installing, configuring and using samba, -# read the Samba-HOWTO-Collection. This may be obtained from: -# http://www.samba.org/samba/docs/Samba-HOWTO-Collection.pdf +# The Official Samba 3.2.x HOWTO and Reference Guide contains step-by-step +# guides for installing, configuring, and using Samba: +# http://www.samba.org/samba/docs/Samba-HOWTO-Collection.pdf # -# Many working examples of smb.conf files can be found in the -# Samba-Guide which is generated daily and can be downloaded from: -# http://www.samba.org/samba/docs/Samba-Guide.pdf +# The Samba-3 by Example guide has working examples for smb.conf. This guide is +# generated daily: http://www.samba.org/samba/docs/Samba-Guide.pdf # -# Any line which starts with a ; (semi-colon) or a # (hash) -# is a comment and is ignored. In this example we will use a # -# for commentry and a ; for parts of the config file that you -# may wish to enable +# In this file, lines starting with a semicolon (;) or a hash (#) are +# comments and are ignored. This file uses hashes to denote commentary and +# semicolons for parts of the file you may wish to configure. # -# NOTE: Whenever you modify this file you should run the command "testparm" -# to check that you have not made any basic syntactic errors. +# Note: Run the "testparm" command after modifying this file to check for basic +# syntax errors. # #--------------- -# SELINUX NOTES: +# Security-Enhanced Linux (SELinux) Notes: # -# If you want to use the useradd/groupadd family of binaries please run: +# Turn the samba_domain_controller Boolean on to allow Samba to use the useradd +# and groupadd family of binaries. Run the following command as the root user to +# turn this Boolean on: # setsebool -P samba_domain_controller on # -# If you want to share home directories via samba please run: +# Turn the samba_enable_home_dirs Boolean on if you want to share home +# directories via Samba. Run the following command as the root user to turn this +# Boolean on: # setsebool -P samba_enable_home_dirs on # -# If you create a new directory you want to share you should mark it as -# "samba-share_t" so that selinux will let you write into it. -# Make sure not to do that on system directories as they may already have -# been marked with othe SELinux labels. +# If you create a new directory, such as a new top-level directory, label it +# with samba_share_t so that SELinux allows Samba to read and write to it. Do +# not label system directories, such as /etc/ and /home/, with samba_share_t, as +# such directories should already have an SELinux label. # -# Use ls -ldZ /path to see which context a directory has +# Run the "ls -ldZ /path/to/directory" command to view the current SELinux +# label for a given directory. # -# Set labels only on directories you created! -# To set a label use the following: chcon -t samba_share_t /path +# Set SELinux labels only on files and directories you have created. Use the +# chcon command to temporarily change a label: +# chcon -t samba_share_t /path/to/directory # -# If you need to share a system created directory you can use one of the -# following (read-only/read-write): +# Changes made via chcon are lost when the file system is relabeled or commands +# such as restorecon are run. +# +# Use the samba_export_all_ro or samba_export_all_rw Boolean to share system +# directories. To share such directories and only allow read-only permissions: # setsebool -P samba_export_all_ro on -# or +# To share such directories and allow read and write permissions: # setsebool -P samba_export_all_rw on # -# If you want to run scripts (preexec/root prexec/print command/...) please -# put them into the /var/lib/samba/scripts directory so that smbd will be -# allowed to run them. -# Make sure you COPY them and not MOVE them so that the right SELinux context -# is applied, to check all is ok use restorecon -R -v /var/lib/samba/scripts +# To run scripts (preexec/root prexec/print command/...), copy them to the +# /var/lib/samba/scripts/ directory so that SELinux will allow smbd to run them. +# Note that if you move the scripts to /var/lib/samba/scripts/, they retain +# their existing SELinux labels, which may be labels that SELinux does not allow +# smbd to run. Copying the scripts will result in the correct SELinux labels. +# Run the "restorecon -R -v /var/lib/samba/scripts" command as the root user to +# apply the correct SELinux labels to these files. # #-------------- # #======================= Global Settings ===================================== - + [global] - -# ----------------------- Netwrok Related Options ------------------------- + +# ----------------------- Network-Related Options ------------------------- # -# workgroup = NT-Domain-Name or Workgroup-Name, eg: MIDEARTH +# workgroup = the Windows NT domain name or workgroup name, for example, MYGROUP. # -# server string is the equivalent of the NT Description field +# server string = the equivalent of the Windows NT Description field. # -# netbios name can be used to specify a server name not tied to the hostname +# netbios name = used to specify a server name that is not tied to the hostname. # -# Interfaces lets you configure Samba to use multiple interfaces -# If you have multiple network interfaces then you can list the ones -# you want to listen on (never omit localhost) +# interfaces = used to configure Samba to listen on multiple network interfaces. +# If you have multiple interfaces, you can use the "interfaces =" option to +# configure which of those interfaces Samba listens on. Never omit the localhost +# interface (lo). # -# Hosts Allow/Hosts Deny lets you restrict who can connect, and you can -# specifiy it as a per share option as well +# hosts allow = the hosts allowed to connect. This option can also be used on a +# per-share basis. + +# hosts deny = the hosts not allowed to connect. This option can also be used on +# a per-share basis. # workgroup = MYGROUP server string = Samba Server Version %v - + ; netbios name = MYSERVER - -; interfaces = lo eth0 192.168.12.2/24 192.168.13.2/24 + +; interfaces = lo eth0 192.168.12.2/24 192.168.13.2/24 ; hosts allow = 127. 192.168.12. 192.168.13. - + # --------------------------- Logging Options ----------------------------- # -# Log File let you specify where to put logs and how to split them up. +# log file = specify where log files are written to and how they are split. # -# Max Log Size let you specify the max size log files should reach - - # logs split per machine +# max log size = specify the maximum size log files are allowed to reach. Log +# files are rotated when they reach the size specified with "max log size". +# + + # log files split per-machine: log file = /var/log/samba/log.%m - # max 50KB per log file, then rotate + # maximum size of 50KB per log file, then rotate: max log size = 50 - + # ----------------------- Standalone Server Options ------------------------ # -# Scurity can be set to user, share(deprecated) or server(deprecated) +# security = the mode Samba runs in. This can be set to user, share +# (deprecated), or server (deprecated). +# +# passdb backend = the backend used to store user information in. New +# installations should use either tdbsam or ldapsam. No additional configuration +# is required for tdbsam. The "smbpasswd" utility is available for backwards +# compatibility. # -# Backend to store user information in. New installations should -# use either tdbsam or ldapsam. smbpasswd is available for backwards -# compatibility. tdbsam requires no further configuration. security = user passdb backend = tdbsam @@ -104,23 +121,24 @@ # ----------------------- Domain Members Options ------------------------ # -# Security must be set to domain or ads +# security = must be set to domain or ads. # -# Use the realm option only with security = ads -# Specifies the Active Directory realm the host is part of +# passdb backend = the backend used to store user information in. New +# installations should use either tdbsam or ldapsam. No additional configuration +# is required for tdbsam. The "smbpasswd" utility is available for backwards +# compatibility. # -# Backend to store user information in. New installations should -# use either tdbsam or ldapsam. smbpasswd is available for backwards -# compatibility. tdbsam requires no further configuration. +# realm = only use the realm option when the "security = ads" option is set. +# The realm option specifies the Active Directory realm the host is a part of. # -# Use password server option only with security = server or if you can't -# use the DNS to locate Domain Controllers -# The argument list may include: -# password server = My_PDC_Name [My_BDC_Name] [My_Next_BDC_Name] -# or to auto-locate the domain controller/s -# password server = * - - +# password server = only use this option when the "security = server" +# option is set, or if you cannot use DNS to locate a Domain Controller. The +# argument list can include My_PDC_Name, [My_BDC_Name], and [My_Next_BDC_Name]: +# +# password server = My_PDC_Name [My_BDC_Name] [My_Next_BDC_Name] +# +# Use "password server = *" to automatically locate Domain Controllers. + ; security = domain ; passdb backend = tdbsam ; realm = MY_REALM @@ -129,112 +147,123 @@ # ----------------------- Domain Controller Options ------------------------ # -# Security must be set to user for domain controllers +# security = must be set to user for domain controllers. # -# Backend to store user information in. New installations should -# use either tdbsam or ldapsam. smbpasswd is available for backwards -# compatibility. tdbsam requires no further configuration. +# passdb backend = the backend used to store user information in. New +# installations should use either tdbsam or ldapsam. No additional configuration +# is required for tdbsam. The "smbpasswd" utility is available for backwards +# compatibility. # -# Domain Master specifies Samba to be the Domain Master Browser. This -# allows Samba to collate browse lists between subnets. Don't use this -# if you already have a Windows NT domain controller doing this job +# domain master = specifies Samba to be the Domain Master Browser, allowing +# Samba to collate browse lists between subnets. Do not use the "domain master" +# option if you already have a Windows NT domain controller performing this task. # -# Domain Logons let Samba be a domain logon server for Windows workstations. +# domain logons = allows Samba to provide a network logon service for Windows +# workstations. # -# Logon Scrpit let yuou specify a script to be run at login time on the client -# You need to provide it in a share called NETLOGON +# logon script = specifies a script to run at login time on the client. These +# scripts must be provided in a share named NETLOGON. # -# Logon Path let you specify where user profiles are stored (UNC path) +# logon path = specifies (with a UNC path) where user profiles are stored. # -# Various scripts can be used on a domain controller or stand-alone -# machine to add or delete corresponding unix accounts # ; security = user ; passdb backend = tdbsam - -; domain master = yes + +; domain master = yes ; domain logons = yes - - # the login script name depends on the machine name + + # the following login script name is determined by the machine name + # (%m): ; logon script = %m.bat - # the login script name depends on the unix user used + # the following login script name is determined by the UNIX user used: ; logon script = %u.bat ; logon path = \\%L\Profiles\%u - # disables profiles support by specifing an empty path -; logon path = - + # use an empty path to disable profile support: +; logon path = + + # various scripts can be used on a domain controller or a stand-alone + # machine to add or delete corresponding UNIX accounts: + ; add user script = /usr/sbin/useradd "%u" -n -g users ; add group script = /usr/sbin/groupadd "%g" ; add machine script = /usr/sbin/useradd -n -c "Workstation (%u)" -M -d /nohome -s /bin/false "%u" ; delete user script = /usr/sbin/userdel "%u" ; delete user from group script = /usr/sbin/userdel "%u" "%g" ; delete group script = /usr/sbin/groupdel "%g" - - + + # ----------------------- Browser Control Options ---------------------------- # -# set local master to no if you don't want Samba to become a master -# browser on your network. Otherwise the normal election rules apply +# local master = when set to no, Samba does not become the master browser on +# your network. When set to yes, normal election rules apply. # -# OS Level determines the precedence of this server in master browser -# elections. The default value should be reasonable +# os level = determines the precedence the server has in master browser +# elections. The default value should be reasonable. +# +# preferred master = when set to yes, Samba forces a local browser election at +# start up (and gives itself a slightly higher chance of winning the election). # -# Preferred Master causes Samba to force a local browser election on startup -# and gives it a slightly higher chance of winning the election ; local master = no ; os level = 33 ; preferred master = yes - + #----------------------------- Name Resolution ------------------------------- -# Windows Internet Name Serving Support Section: -# Note: Samba can be either a WINS Server, or a WINS Client, but NOT both # -# - WINS Support: Tells the NMBD component of Samba to enable it's WINS Server +# This section details the support for the Windows Internet Name Service (WINS). # -# - WINS Server: Tells the NMBD components of Samba to be a WINS Client +# Note: Samba can be either a WINS server or a WINS client, but not both. # -# - WINS Proxy: Tells Samba to answer name resolution queries on -# behalf of a non WINS capable client, for this to work there must be -# at least one WINS Server on the network. The default is NO. +# wins support = when set to yes, the NMBD component of Samba enables its WINS +# server. # -# DNS Proxy - tells Samba whether or not to try to resolve NetBIOS names -# via DNS nslookups. - +# wins server = tells the NMBD component of Samba to be a WINS client. +# +# wins proxy = when set to yes, Samba answers name resolution queries on behalf +# of a non WINS capable client. For this to work, there must be at least one +# WINS server on the network. The default is no. +# +# dns proxy = when set to yes, Samba attempts to resolve NetBIOS names via DNS +# nslookups. + ; wins support = yes ; wins server = w.x.y.z ; wins proxy = yes - + ; dns proxy = yes - + # --------------------------- Printing Options ----------------------------- # -# Load Printers let you load automatically the list of printers rather -# than setting them up individually +# The options in this section allow you to configure a non-default printing +# system. # -# Cups Options let you pass the cups libs custom options, setting it to raw -# for example will let you use drivers on your Windows clients +# load printers = when set you yes, the list of printers is automatically +# loaded, rather than setting them up individually. # -# Printcap Name let you specify an alternative printcap file +# cups options = allows you to pass options to the CUPS library. Setting this +# option to raw, for example, allows you to use drivers on your Windows clients. # -# You can choose a non default printing system using the Printing option - +# printcap name = used to specify an alternative printcap file. +# + load printers = yes cups options = raw ; printcap name = /etc/printcap - #obtain list of printers automatically on SystemV + # obtain a list of printers automatically on UNIX System V systems: ; printcap name = lpstat ; printing = cups -# --------------------------- Filesystem Options --------------------------- +# --------------------------- File System Options --------------------------- # -# The following options can be uncommented if the filesystem supports -# Extended Attributes and they are enabled (usually by the mount option -# user_xattr). Thess options will let the admin store the DOS attributes -# in an EA and make samba not mess with the permission bits. +# The options in this section can be un-commented if the file system supports +# extended attributes, and those attributes are enabled (usually via the +# "user_xattr" mount option). These options allow the administrator to specify +# that DOS attributes are stored in extended attributes and also make sure that +# Samba does not change the permission bits. # -# Note: these options can also be set just per share, setting them in global -# makes them the default for all shares +# Note: These options can be used on a per-share basis. Setting them globally +# (in the [global] section) makes them the default for all shares. ; map archive = no ; map hidden = no @@ -244,14 +273,14 @@ #============================ Share Definitions ============================== - + [homes] comment = Home Directories browseable = no writable = yes ; valid users = %S ; valid users = MYDOMAIN\%S - + [printers] comment = All Printers path = /var/spool/samba @@ -259,26 +288,24 @@ guest ok = no writable = no printable = yes - -# Un-comment the following and create the netlogon directory for Domain Logons + +# Un-comment the following and create the netlogon directory for Domain Logons: ; [netlogon] ; comment = Network Logon Service ; path = /var/lib/samba/netlogon ; guest ok = yes ; writable = no ; share modes = no - - -# Un-comment the following to provide a specific roving profile share -# the default is to use the user's home directory + +# Un-comment the following to provide a specific roving profile share. +# The default is to use the user's home directory: ; [Profiles] ; path = /var/lib/samba/profiles ; browseable = no ; guest ok = yes - - -# A publicly accessible directory, but read only, except for people in -# the "staff" group + +# A publicly accessible directory that is read only, except for users in the +# "staff" group (which have write permissions): ; [public] ; comment = Public Stuff ; path = /home/samba