Home
Main website
Display Sidebar
Hide Ads
Recent Changes
View Source:
smb.conf(5)
Edit
PageHistory
Diff
Info
LikePages
SMB.CONF !!!SMB.CONF NAME SYNOPSIS FILE FORMAT SECTION DESCRIPTIONS SPECIAL SECTIONS PARAMETERS VARIABLE SUBSTITUTIONS NAME MANGLING NOTE ABOUT USERNAME/PASSWORD VALIDATION COMPLETE LIST OF GLOBAL PARAMETERS COMPLETE LIST OF SERVICE PARAMETERS EXPLANATION OF EACH PARAMETER WARNINGS VERSION SEE ALSO AUTHOR ---- !!NAME smb.conf - The configuration file for the Samba suite !!SYNOPSIS The ''smb.conf'' file is a configuration file for the Samba suite. ''smb.conf'' contains runtime configuration information for the Samba programs. The ''smb.conf'' file is designed to be configured and administered by the __swat(8)__ program. The complete description of the file format and possible parameters held within are here for reference purposes. !!FILE FORMAT The file consists of sections and parameters. A section begins with the name of the section in square brackets and continues until the next section begins. Sections contain parameters of the form ''name'' = ''value'' The file is line-based - that is, each newline-terminated line represents either a comment, a section name or a parameter. Section and parameter names are not case sensitive. Only the first equals sign in a parameter is significant. Whitespace before or after the first equals sign is discarded. Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading and trailing whitespace in a parameter value is discarded. Internal whitespace within a parameter value is retained verbatim. Any line beginning with a semicolon (';') or a hash ('#') character is ignored, as are lines containing only whitespace. Any line ending in a '' is continued on the next line in the customary UNIX fashion. The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 0/1 or true/false. Case is not significant in boolean values, but is preserved in string values. Some items such as create modes are numeric. !!SECTION DESCRIPTIONS Each section in the configuration file (except for the [[global] section) describes a shared resource (known as a There are three special sections, [[global], [[homes] and [[printers], which are described under __special sections__. The following notes apply to ordinary section descriptions. A share consists of a directory to which access is being given plus a description of the access rights which are granted to the user of the service. Some housekeeping options are also specifiable. Sections are either file share services (used by the client as an extension of their native file systems) or printable services (used by the client to access print services on the host running the server). Sections may be designated __guest__ services, in which case no password is required to access them. A specified UNIX __guest account__ is used to define access privileges in this case. Sections other than guest services will require a password to access them. The client provides the username. As older clients only provide passwords and not usernames, you may specify a list of usernames to check against the password using the Note that the access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host system. The server does not grant more access than the host system grants. The following sample section defines a file space share. The user has write access to the path ''/home/bar''. The share is accessed via the share name '' [[foo] path = /home/bar writeable = true The following sample section defines a printable share. The share is readonly, but printable. That is, the only write access permitted is via calls to open, write to and close a spool file. The __guest ok__ parameter means access will be permitted as the default guest user (specified elsewhere): [[aprinter] path = /usr/spool/public writeable = false printable = true guest ok = true !!SPECIAL SECTIONS __THE GLOBAL SECTION__ parameters in this section apply to the server as a whole, or are defaults for sections which do not specifically define certain items. See the notes under PARAMETERS for more information. __THE HOMES SECTION__ If a section called homes is included in the configuration file, services connecting clients to their home directories can be created on the fly by the server. When the connection request is made, the existing sections are scanned. If a match is found, it is used. If no match is found, the requested section name is treated as a user name and looked up in the local password file. If the name exists and the correct password has been given, a share is created by cloning the [[homes] section. Some modifications are then made to the newly created share: The share name is changed from homes to the located username. If no path was given, the path is set to the user's home directory. If you decide to use a __path =__ line in your [[homes] section then you may find it useful to use the %S macro. For example : __path = /data/pchome/%S__ would be useful if you have different home directories for your PCs than for UNIX access. This is a fast and simple way to give a large number of clients access to their home directories with a minimum of fuss. A similar process occurs if the requested section name is The [[homes] section can specify all the parameters a normal service section can specify, though some make more sense than others. The following is a typical and suitable [[homes] section: [[homes] writeable = yes An important point is that if guest access is specified in the [[homes] section, all home directories will be visible to all clients __without a password__. In the very unlikely event that this is actually desirable, it would be wise to also specify __read only access__. Note that the __browseable__ flag for auto home directories will be inherited from the global browseable flag, not the [[homes] browseable flag. This is useful as it means setting __browseable = no__ in the [[homes] section will hide the [[homes] share but make any auto home directories visible. __THE PRINTERS SECTION__ This section works like [[homes], but for printers. If a [[printers] section occurs in the configuration file, users are able to connect to any printer specified in the local host's printcap file. When a connection request is made, the existing sections are scanned. If a match is found, it is used. If no match is found, but a [[homes] section exists, it is used as described above. Otherwise, the requested section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested section name is a valid printer share name. If a match is found, a new printer share is created by cloning the [[printers] section. A few modifications are then made to the newly created share: The share name is set to the located printer name If no printer name was given, the printer name is set to the located printer name If the share does not permit guest access and no username was given, the username is set to the located printer name. Note that the [[printers] service MUST be printable - if you specify otherwise, the server will refuse to load the configuration file. Typically the path specified would be that of a world-writeable spool directory with the sticky bit set on it. A typical [[printers] entry would look like this: [[printers] path = /usr/spool/public guest ok = yes printable = yes All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned. If your printing subsystem doesn't work like that, you will have to set up a pseudo-printcap. This is a file consisting of one or more lines like this: alias|alias|alias|alias... Each alias should be an acceptable printer name for your printing subsystem. In the [[global] section, specify the new file as your printcap. The server will then only recognize names found in your pseudo-printcap, which of course can contain whatever aliases you like. The same technique could be used simply to limit access to a subset of your local printers. An alias, by the way, is defined as any component of the first entry of a printcap record. Records are separated by newlines, components (if there are more than one) are separated by vertical bar symbols ('|'). NOTE: On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use !!PARAMETERS parameters define the specific attributes of sections. Some parameters are specific to the [[global] section (e.g., __security__). Some parameters are usable in all sections (e.g., __create mode__). All others are permissible only in normal sections. For the purposes of the following descriptions the [[homes] and [[printers] sections will be considered normal. The letter __G__ in parentheses indicates that a parameter is specific to the [[global] section. The letter __S__ indicates that a parameter can be specified in a service specific section. Note that all __S__ parameters can also be specified in the [[global] section - in which case they will define the default behavior for all services. parameters are arranged here in alphabetical order - this may not create best bedfellows, but at least you can find them! Where there are synonyms, the preferred synonym is described, others refer to the preferred synonym. !!VARIABLE SUBSTITUTIONS Many of the strings that are settable in the config file can take substitutions. For example the option These substitutions are mostly noted in the descriptions below, but there are some general substitutions which apply whenever they might be relevant. These are: __%S__ the name of the current service, if any. __%P__ the root directory of the current service, if any. __%u__ user name of the current service, if any. __%g__ primary group name of %u. __%U__ session user name (the user name that the client wanted, not necessarily the same as the one they got). __%G__ primary group name of %U. __%H__ the home directory of the user given by %u. __%v__ the Samba version. __%h__ the Internet hostname that Samba is running on. __%m__ the NetBIOS name of the client machine (very useful). __%L__ the NetBIOS name of the server. This allows you to change your config based on what the client calls you. Your server can have a __%M__ the Internet name of the client machine. __%N__ the name of your NIS home directory server. This is obtained from your NIS auto.map entry. If you have not compiled Samba with the __--with-automount__ option then this value will be the same as %L. __%p__ the path of the service's home directory, obtained from your NIS auto.map entry. The NIS auto.map entry is split up as __%R__ the selected protocol level after protocol negotiation. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1. __%d__ The process id of the current server process. __%a__ the architecture of the remote machine. Only some are recognized, and those may not be 100% reliable. It currently recognizes Samba, !WfWg, Win95, WinNT and Win2k. Anything else will be known as __%I__ The IP address of the client machine. __%T__ the current date and time. __%$(__''envvar''__)__ The value of the environment variable ''envar''. There are some quite creative things that can be done with these substitutions and other smb.conf options. !!NAME MANGLING Samba supports There are several options that control the way mangling is performed, and they are grouped here rather than listed separately. For the defaults look at the output of the testparm program. All of these options can be set separately for each service (or globally, of course). The options are: __mangle case = yes/no__ controls if names that have characters that aren't of the no__. __case sensitive = yes/no__ controls whether filenames are case sensitive. If they aren't then Samba must do a filename search and match on passed names. Default __no__. __default case = upper/lower__ controls what the default case is for new filenames. Default __lower__. __preserve case = yes/no__ controls if new files are created with the case that the client passes, or if they are forced to be the yes__. __short preserve case = yes/no__ controls if new files which conform to 8.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the yes__. By default, Samba 2.2 has the same semantics as a Windows NT server, in that it is case insensitive but case preserving. !!NOTE ABOUT USERNAME/PASSWORD VALIDATION There are a number of ways in which a user can connect to a service. The server uses the following steps in determining if it will allow a connection to a specified service. If all the steps fail, then the connection request is rejected. However, if one of the steps succeeds, then the following steps are not checked. If the service is marked 1. If the client has passed a username/password pair and that username/password pair is validated by the UNIX system's password programs then the connection is made as that username. Note that this includes the \serverservice%''username'' method of passing a username. 2. If the client has previously registered a username with the system and now supplies a correct password for that username then the connection is allowed. 3. The client's NetBIOS name and any previously used user names are checked against the supplied password, if they match then the connection is allowed as the corresponding user. 4. If the client has previously validated a username/password pair with the server and the client has passed the validation token then that username is used. 5. If a smb.conf'' file for the service and the client has supplied a password, and that password matches (according to the UNIX system's password checking) with one of the usernames from the '' 6. If the service is a guest service then a connection is made as the username given in the !!COMPLETE LIST OF GLOBAL PARAMETERS Here is a list of all global parameters. See the section of each parameter for details. Note that some are synonyms. ''abort shutdown script'' ''add printer command'' ''add share command'' ''add user script'' ''add machine script'' ''allow trusted domains'' ''announce as'' ''announce version'' ''auto services'' ''bind interfaces only'' ''browse list'' ''change notify timeout'' ''change share command'' ''character set'' ''client code page'' ''code page directory'' ''coding system'' ''config file'' ''deadtime'' ''debug hires timestamp'' ''debug pid'' ''debug timestamp'' ''debug uid'' ''debuglevel'' ''default'' ''default service'' ''delete printer command'' ''delete share command'' ''delete user script'' ''dfree command'' ''disable spoolss'' ''dns proxy'' ''domain admin group'' ''domain guest group'' ''domain logons'' ''domain master'' ''encrypt passwords'' ''enhanced browsing'' ''enumports command'' ''getwd cache'' ''hide local users'' ''hide unreadable'' ''homedir map'' ''host msdfs'' ''hosts equiv'' ''interfaces'' ''keepalive'' ''kernel oplocks'' ''lanman auth'' ''large readwrite'' ''ldap admin dn'' ''ldap filter'' ''ldap port'' ''ldap server'' ''ldap ssl'' ''ldap suffix'' ''lm announce'' ''lm interval'' ''load printers'' ''local master'' ''lock dir'' ''lock directory'' ''log file'' ''log level'' ''logon drive'' ''logon home'' ''logon path'' ''logon script'' ''lpq cache time'' ''machine password timeout'' ''mangled stack'' ''map to guest'' ''max disk size'' ''max log size'' ''max mux'' ''max open files'' ''max protocol'' ''max smbd processes'' ''max ttl'' ''max wins ttl'' ''max xmit'' ''message command'' ''min passwd length'' ''min password length'' ''min protocol'' ''min wins ttl'' ''name resolve order'' ''netbios aliases'' ''netbios name'' ''netbios scope'' ''nis homedir'' ''nt pipe support'' ''nt smb support'' ''null passwords'' ''obey pam restrictions'' ''oplock break wait time'' ''os level'' ''os2 driver map'' ''pam password change'' ''panic action'' ''passwd chat'' ''passwd chat debug'' ''passwd program'' ''password level'' ''password server'' ''prefered master'' ''preferred master'' ''preload'' ''printcap'' ''printcap name'' ''printer driver file'' ''protocol'' ''read bmpx'' ''read raw'' ''read size'' ''remote announce'' ''remote browse sync'' ''restrict anonymous'' ''root'' ''root dir'' ''root directory'' ''security'' ''server string'' ''show add printer wizard'' ''shutdown script'' ''smb passwd file'' ''socket address'' ''socket options'' ''source environment'' ''ssl'' ''ssl CA certDir'' ''ssl CA certFile'' ''ssl ciphers'' ''ssl client cert'' ''ssl client key'' ''ssl compatibility'' ''ssl egd socket'' ''ssl entropy bytes'' ''ssl entropy file'' ''ssl hosts'' ''ssl hosts resign'' ''ssl require clientcert'' ''ssl require servercert'' ''ssl server cert'' ''ssl server key'' ''ssl version'' ''stat cache'' ''stat cache size'' ''strip dot'' ''syslog'' ''syslog only'' ''template homedir'' ''template shell'' ''time offset'' ''time server'' ''timestamp logs'' ''total print jobs'' ''unix extensions'' ''unix password sync'' ''update encrypted'' ''use mmap'' ''use rhosts'' ''username level'' ''username map'' ''utmp'' ''utmp directory'' ''valid chars'' ''winbind cache time'' ''winbind enum users'' ''winbind enum groups'' ''winbind gid'' ''winbind separator'' ''winbind uid'' ''wins hook'' ''wins proxy'' ''wins server'' ''wins support'' ''workgroup'' ''write raw'' !!COMPLETE LIST OF SERVICE PARAMETERS Here is a list of all service parameters. See the section on each parameter for details. Note that some are synonyms. ''admin users'' ''allow hosts'' ''available'' ''blocking locks'' ''browsable'' ''browseable'' ''case sensitive'' ''casesignames'' ''comment'' ''copy'' ''create mask'' ''create mode'' ''default case'' ''default devmode'' ''delete readonly'' ''delete veto files'' ''deny hosts'' ''directory'' ''directory mask'' ''directory mode'' ''directory security mask'' ''dont descend'' ''dos filemode'' ''dos filetime resolution'' ''dos filetimes'' ''exec'' ''fake directory create times'' ''fake oplocks'' ''follow symlinks'' ''force create mode'' ''force directory mode'' ''force directory security mode'' ''force group'' ''force security mode'' ''force user'' ''fstype'' ''group'' ''guest account'' ''guest ok'' ''guest only'' ''hide dot files'' ''hide files'' ''hosts allow'' ''hosts deny'' ''include'' ''inherit permissions'' ''invalid users'' ''level2 oplocks'' ''locking'' ''lppause command'' ''lpq command'' ''lpresume command'' ''lprm command'' ''magic output'' ''magic script'' ''mangle case'' ''mangled map'' ''mangled names'' ''mangling char'' ''map archive'' ''map hidden'' ''map system'' ''max connections'' ''max print jobs'' ''min print space'' ''msdfs root'' ''nt acl support'' ''only guest'' ''only user'' ''oplock contention limit'' ''oplocks'' ''path'' ''posix locking'' ''postexec'' ''postscript'' ''preexec'' ''preexec close'' ''preserve case'' ''print command'' ''print ok'' ''printable'' ''printer'' ''printer admin'' ''printer driver'' ''printer driver location'' ''printer name'' ''printing'' ''public'' ''queuepause command'' ''queueresume command'' ''read list'' ''read only'' ''root postexec'' ''root preexec'' ''root preexec close'' ''security mask'' ''set directory'' ''short preserve case'' ''status'' ''strict allocate'' ''strict locking'' ''strict sync'' ''sync always'' ''use client driver'' ''user'' ''username'' ''users'' ''valid users'' ''veto files'' ''veto oplock files'' ''vfs object'' ''vfs options'' ''volume'' ''wide links'' ''writable'' ''write cache size'' ''write list'' ''write ok'' ''writeable'' !!EXPLANATION OF EACH PARAMETER __abort shutdown script (G)__ __This parameter only exists in the HEAD cvs branch__ This a full path name to a script called by __smbd(8)__that should stop a shutdown procedure issued by the ''shutdown script''. This command will be run as user. Default: __None__. Example: __abort shutdown script = /sbin/shutdown -c__ __add printer command (G)__ With the introduction of MS-RPC based printing support for Windows NT/2000 clients in Samba 2.2, The MS Add Printer Wizard (APW) icon is now also available in the For a Samba host this means that the printer must be physically added to the underlying printing system. The ''add printer command'' defines a script to be run which will perform the necessary operations for adding the printer to the print system and to add the appropriate service definition to the ''smb.conf'' file in order that it can be shared by __smbd(8)__ The ''add printer command'' is automatically invoked with the following parameter (in order: ''printer name'' ''share name'' ''port name'' ''driver name'' ''location'' ''Windows 9x driver location'' All parameters are filled in from the PRINTER_INFO_2 structure sent by the Windows NT/2000 client with one exception. The Once the ''add printer command'' has been executed, __smbd__ will reparse the ''smb.conf'' to determine if the share defined by the APW exists. If the sharename is still invalid, then __smbd__ will return an ACCESS_DENIED error to the client. See also ''delete printer command'', ''printing'', ''show add printer wizard'' Default: __none__ Example: __addprinter command = /usr/bin/addprinter__ __add share command (G)__ Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The ''add share command'' is used to define an external program or script which will add a new service definition to ''smb.conf''. In order to successfully execute the ''add share command'', __smbd__ requires that the administrator be connected using a root account (i.e. uid == 0). When executed, __smbd__ will automatically invoke the ''add share command'' with four parameters. ''configFile'' - the location of the global ''smb.conf'' file. ''shareName'' - the name of the new share. ''pathName'' - path to an **existing** directory on disk. ''comment'' - comment string to associate with the new share. This parameter is only used for add file shares. To add printer shares, see the ''add printer command''. See also ''change share command'', ''delete share command''. Default: __none__ Example: __add share command = /usr/local/bin/addshare__ __add machine script (G)__ This is the full pathname to a script that will be run by smbd(8)when a machine is added to it's domain using the administrator username and password method. This option is only required when using sam back-ends tied to the Unix uid method of RID calculation such as smbpasswd. This option is only available in Samba 3.0. Default: __add machine script = __ Example: __add machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u__ __add user script (G)__ This is the full pathname to a script that will be run __AS ROOT__ by smbd(8) under special circumstances described below. Normally, a Samba server requires that UNIX users are created for all users accessing files on this server. For sites that use Windows NT account databases as their primary user database creating these users and keeping the user list in sync with the Windows NT PDC is an onerous task. This option allows smbdto create the required UNIX users __ON DEMAND__ when a user accesses the Samba server. In order to use this option, smbd must be set to ''security = server'' or ''security = domain'' and ''add user script'' must be set to a full pathname for a script that will create a UNIX user given one argument of ''%u'', which expands into the UNIX user name to create. When the Windows user attempts to access the Samba server, at login (session setup in the SMB protocol) time, smbdcontacts the ''password server'' and attempts to authenticate the given user with the given password. If the authentication succeeds then __smbd__ attempts to find a UNIX user in the UNIX password database to map the Windows user into. If this lookup fails, and ''add user script'' is set then __smbd__ will call the specified script __AS ROOT__, expanding any ''%u'' argument to be the user name to create. If this script successfully creates the user then __smbd__ will continue on as though the UNIX user already existed. In this way, UNIX users are dynamically created to match existing Windows NT accounts. See also ''security'', ''password server'', ''delete user script''. Default: __add user script = __ Example: __add user script = /usr/local/samba/bin/add_user %u__ __admin users (S)__ This is a list of users who will be granted administrative privileges on the share. This means that they will do all file operations as the super-user (root). You should use this option very carefully, as any user in this list will be able to do anything they like on the share, irrespective of file permissions. Default: __no admin users__ Example: __admin users = jason__ __allow hosts (S)__ Synonym for ''hosts allow''. __allow trusted domains (G)__ This option only takes effect when the ''security'' option is set to server or domain. If it is set to no, then attempts to connect to a resource from a domain or workgroup other than the one which smbdis running in will fail, even if that domain is trusted by the remote server doing the authentication. This is useful if you only want your Samba server to serve resources to users in the domain it is a member of. As an example, suppose that there are two domains DOMA and DOMB. DOMB is trusted by DOMA, which contains the Samba server. Under normal circumstances, a user with an account in DOMB can then access the resources of a UNIX account with the same account name on the Samba server even if they do not have an account in DOMA. This can make implementing a security boundary difficult. Default: __allow trusted domains = yes__ __announce as (G)__ This specifies what type of server __nmbd__ will announce itself as, to a network neighborhood browse list. By default this is set to Windows NT. The valid options are : __ Default: __announce as = NT Server__ Example: __announce as = Win95__ __announce version (G)__ This specifies the major and minor version numbers that nmbd will use when announcing itself as a server. The default is 4.2. Do not change this parameter unless you have a specific need to set a Samba server to be a downlevel server. Default: __announce version = 4.5__ Example: __announce version = 2.0__ __auto services (G)__ This is a synonym for the ''preload''. __available (S)__ This parameter lets you available = no'', then __ALL__ attempts to connect to the service will fail. Such failures are logged. Default: __available = yes__ __bind interfaces only (G)__ This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests. If affects file service smbd(8)and name service nmbd(8)in slightly different ways. For name service it causes __nmbd__ to bind to ports 137 and 138 on the interfaces listed in the interfaces parameter. __nmbd__ also binds to the __nmbd__ will service name requests on all of these sockets. If ''bind interfaces only'' is set then __nmbd__ will check the source address of any packets coming in on the broadcast sockets and discard any that don't match the broadcast addresses of the interfaces in the ''interfaces'' parameter list. As unicast packets are received on the other sockets it allows __nmbd__ to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the ''interfaces'' list. IP Source address spoofing does defeat this simple check, however so it must not be used seriously as a security feature for __nmbd__. For file service it causes smbd(8) to bind only to the interface list given in the interfaces parameter. This restricts the networks that __smbd__ will serve to packets coming in those interfaces. Note that you should not use this parameter for machines that are serving PPP or other intermittent or non-broadcast network interfaces as it will not cope with non-permanent interfaces. If ''bind interfaces only'' is set then unless the network address __127.0.0.1__ is added to the ''interfaces'' parameter list __smbpasswd(8)__ and __swat(8)__may not work as expected due to the reasons covered below. To change a users SMB password, the __smbpasswd__ by default connects to the __localhost - 127.0.0.1__ address as an SMB client to issue the password change request. If ''bind interfaces only'' is set then unless the network address __127.0.0.1__ is added to the ''interfaces'' parameter list then __smbpasswd__ will fail to connect in it's default mode. __smbpasswd__ can be forced to use the primary IP interface of the local host by using its ''-r remote machine'' parameter, with ''remote machine'' set to the IP name of the primary interface of the local host. The __swat__ status page tries to connect with __smbd__ and __nmbd__ at the address __127.0.0.1__ to determine if they are running. Not adding __127.0.0.1__ will cause __smbd__ and __nmbd__ to always show __swat__ from starting/stopping/restarting __smbd__ and __nmbd__. Default: __bind interfaces only = no__ __blocking locks (S)__ This parameter controls the behavior of smbd(8)when given a request by a client to obtain a byte range lock on a region of an open file, and the request has a time limit associated with it. If this parameter is set and the lock range requested cannot be immediately satisfied, Samba 2.2 will internally queue the lock request, and periodically attempt to obtain the lock until the timeout period expires. If this parameter is set to false, then Samba 2.2 will behave as previous versions of Samba would and will fail the lock request immediately if the lock range cannot be obtained. Default: __blocking locks = yes__ __browsable (S)__ See the ''browseable''. __browse list (G)__ This controls whether __smbd(8)__will serve a browse list to a client doing a __!NetServerEnum__ call. Normally set to true. You should never need to change this. Default: __browse list = yes__ __browseable (S)__ This controls whether this share is seen in the list of available shares in a net view and in the browse list. Default: __browseable = yes__ __case sensitive (S)__ See the discussion in the section NAME MANGLING. Default: __case sensitive = no__ __casesignames (S)__ Synonym for case sensitive. __change notify timeout (G)__ This SMB allows a client to tell a server to smbd(8)__daemon only performs such a scan on each requested directory once every ''change notify timeout'' seconds. Default: __change notify timeout = 60__ Example: __change notify timeout = 300__ Would change the scan time to every 5 minutes. __change share command (G)__ Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The ''change share command'' is used to define an external program or script which will modify an existing service definition in ''smb.conf''. In order to successfully execute the ''change share command'', __smbd__ requires that the administrator be connected using a root account (i.e. uid == 0). When executed, __smbd__ will automatically invoke the ''change share command'' with four parameters. ''configFile'' - the location of the global ''smb.conf'' file. ''shareName'' - the name of the new share. ''pathName'' - path to an **existing** directory on disk. ''comment'' - comment string to associate with the new share. This parameter is only used modify existing file shares definitions. To modify printer shares, use the See also ''add share command'', ''delete share command''. Default: __none__ Example: __change share command = /usr/local/bin/addshare__ __character set (G)__ This allows smbdto map incoming filenames from a DOS Code page (see the client code page parameter) to several built in UNIX character sets. The built in code page translations are: ISO8859-1 : Western European UNIX character set. The parameter ''client code page'' __MUST__ be set to code page 850 if the ''character set'' parameter is set to ISO8859-1 in order for the conversion to the UNIX character set to be done correctly. ISO8859-2 : Eastern European UNIX character set. The parameter ''client code page'' __MUST__ be set to code page 852 if the ''character set'' parameter is set to ISO8859-2 in order for the conversion to the UNIX character set to be done correctly. ISO8859-5 : Russian Cyrillic UNIX character set. The parameter ''client code page'' __MUST__ be set to code page 866 if the ''character set'' parameter is set to ISO8859-5 in order for the conversion to the UNIX character set to be done correctly. ISO8859-7 : Greek UNIX character set. The parameter ''client code page'' __MUST__ be set to code page 737 if the ''character set'' parameter is set to ISO8859-7 in order for the conversion to the UNIX character set to be done correctly. KOI8-R : Alternate mapping for Russian Cyrillic UNIX character set. The parameter ''client code page'' __MUST__ be set to code page 866 if the ''character set'' parameter is set to KOI8-R in order for the conversion to the UNIX character set to be done correctly. __BUG__. These MSDOS code page to UNIX character set mappings should be dynamic, like the loading of MS DOS code pages, not static. Normally this parameter is not set, meaning no filename translation is done. Default: __character set = __ Example: __character set = ISO8859-1__ __client code page (G)__ This parameter specifies the DOS code page that the clients accessing Samba are using. To determine what code page a Windows or DOS client is using, open a DOS command prompt and type the command __chcp__. This will output the code page. The default for USA MS-DOS, Windows 95, and Windows NT releases is code page 437. The default for western European releases of the above operating systems is code page 850. This parameter tells smbd(8) which of the ''codepage.XXX'' files to dynamically load on startup. These files, described more fully in the manual page __make_smbcodepage(1)__, tell __smbd__ how to map lower to upper case characters to provide the case insensitivity of filenames that Windows clients expect. Samba currently ships with the following code page files : Code Page 437 - MS-DOS Latin US Code Page 737 - Windows '95 Greek Code Page 850 - MS-DOS Latin 1 Code Page 852 - MS-DOS Latin 2 Code Page 861 - MS-DOS Icelandic Code Page 866 - MS-DOS Cyrillic Code Page 932 - MS-DOS Japanese SJIS Code Page 936 - MS-DOS Simplified Chinese Code Page 949 - MS-DOS Korean Hangul Code Page 950 - MS-DOS Traditional Chinese Thus this parameter may have any of the values 437, 737, 850, 852, 861, 932, 936, 949, or 950. If you don't find the codepage you need, read the comments in one of the other codepage files and the __make_smbcodepage(1)__ man page and write one. Please remember to donate it back to the Samba user community. This parameter co-operates with the ''valid chars'' parameter in determining what characters are valid in filenames and how capitalization is done. If you set both this parameter and the ''valid chars'' parameter the ''client code page'' parameter __MUST__ be set before the ''valid chars'' parameter in the ''smb.conf'' file. The ''valid chars'' string will then augment the character settings in the ''client code page'' parameter. If not set, ''client code page'' defaults to 850. See also : ''valid chars'', ''code page directory'' Default: __client code page = 850__ Example: __client code page = 936__ __code page directory (G)__ Define the location of the various client code page files. See also ''client code page'' Default: __code page directory = ${prefix}/lib/codepages__ Example: __code page directory = /usr/share/samba/codepages__ __coding system (G)__ This parameter is used to determine how incoming Shift-JIS Japanese characters are mapped from the incoming ''client code page'' used by the client, into file names in the UNIX filesystem. Only useful if ''client code page'' is set to 932 (Japanese Shift-JIS). The options are : SJIS - Shift-JIS. Does no conversion of the incoming filename. JIS8, J8BB, J8BH, J8@B, J8@J, J8@H - Convert from incoming Shift-JIS to eight bit JIS code with different shift-in, shift out codes. JIS7, J7BB, J7BH, J7@B, J7@J, J7@H - Convert from incoming Shift-JIS to seven bit JIS code with different shift-in, shift out codes. JUNET, JUBB, JUBH, JU@B, JU@J, JU@H - Convert from incoming Shift-JIS to JUNET code with different shift-in, shift out codes. EUC - Convert an incoming Shift-JIS character to EUC code. HEX - Convert an incoming Shift-JIS character to a 3 byte hex representation, i.e. :AB. CAP - Convert an incoming Shift-JIS character to the 3 byte hex representation used by the Columbia !AppleTalk Program (CAP), i.e. :AB. This is used for compatibility between Samba and CAP. Default: __coding system = __ __comment (S)__ This is a text field that is seen next to a share when a client does a queries the server, either via the network neighborhood or via __net view__ to list what shares are available. If you want to set the string that is displayed next to the machine name then see the ''server string'' parameter. Default: __No comment string__ Example: __comment = Fred's Files__ __config file (G)__ This allows you to override the config file to use, instead of the default (usually ''smb.conf''). There is a chicken and egg problem here as this option is set in the config file! For this reason, if the name of the config file has changed when the parameters are loaded then it will reload them from the new config file. This option takes the usual substitutions, which can be very useful. If the config file doesn't exist then it won't be loaded (allowing you to special case the config files of just a few clients). Example: __config file = /usr/local/samba/lib/smb.conf.%m__ __copy (S)__ This parameter allows you to This feature lets you set up a 'template' service and create similar services easily. Note that the service being copied must occur earlier in the configuration file than the service doing the copying. Default: __no value__ Example: __copy = otherservice__ __create mask (S)__ A synonym for this parameter is ''create mode'' . When a file is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit-wise 'AND'ed with this parameter. This parameter may be thought of as a bit-wise MASK for the UNIX modes of a file. Any bit __not__ set here will be removed from the modes set on a file when it is created. The default value of this parameter removes the 'group' and 'other' write and execute bits from the UNIX modes. Following this Samba will bit-wise 'OR' the UNIX mode created from this parameter with the value of the ''force create mode'' parameter which is set to 000 by default. This parameter does not affect directory modes. See the parameter ''directory mode'' for details. See also the ''force create mode'' parameter for forcing particular mode bits to be set on created files. See also the ''directory mode'' parameter for masking mode bits on created directories. See also the ''inherit permissions'' parameter. Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors. If the administrator wishes to enforce a mask on access control lists also, they need to set the ''security mask''. Default: __create mask = 0744__ Example: __create mask = 0775__ __create mode (S)__ This is a synonym for ''create mask''. __deadtime (G)__ The value of the parameter (a decimal integer) represents the number of minutes of inactivity before a connection is considered dead, and it is disconnected. The deadtime only takes effect if the number of open files is zero. This is useful to stop a server's resources being exhausted by a large number of inactive connections. Most clients have an auto-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users. Using this parameter with a timeout of a few minutes is recommended for most systems. A deadtime of zero indicates that no auto-disconnection should be performed. Default: __deadtime = 0__ Example: __deadtime = 15__ __debug hires timestamp (G)__ Sometimes the timestamps in the log messages are needed with a resolution of higher that seconds, this boolean parameter adds microsecond resolution to the timestamp message header when turned on. Note that the parameter ''debug timestamp'' must be on for this to have an effect. Default: __debug hires timestamp = no__ __debug pid (G)__ When using only one log file for more then one forked smbd-process there may be hard to follow which process outputs which message. This boolean parameter is adds the process-id to the timestamp message headers in the logfile when turned on. Note that the parameter ''debug timestamp'' must be on for this to have an effect. Default: __debug pid = no__ __debug timestamp (G)__ Samba 2.2 debug log messages are timestamped by default. If you are running at a high ''debug level'' these timestamps can be distracting. This boolean parameter allows timestamping to be turned off. Default: __debug timestamp = yes__ __debug uid (G)__ Samba is sometimes run as root and sometime run as the connected user, this boolean parameter inserts the current euid, egid, uid and gid to the timestamp message headers in the log file if turned on. Note that the parameter ''debug timestamp'' must be on for this to have an effect. Default: __debug uid = no__ __debuglevel (G)__ Synonym for ''log level''. __default (G)__ A synonym for ''default service''. __default case (S)__ See the section on NAME MANGLING. Also note the ''short preserve case'' parameter. Default: __default case = lower__ __default devmode (S)__ This parameter is only applicable to printable services. When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba server has a Device Mode which defines things such as paper size and orientation and duplex settings. The device mode can only correctly be generated by the printer driver itself (which can only be executed on a Win32 platform). Because smbd is unable to execute the driver code to generate the device mode, the default behavior is to set this field to NULL. Most problems with serving printer drivers to Windows NT/2k/XP clients can be traced to a problem with the generated device mode. Certain drivers will do things such as crashing the client's Explorer.exe with a NULL devmode. However, other printer drivers can cause the client's spooler service (spoolsv.exe) to die if the devmode was not created by the driver itself (i.e. smbd generates a default devmode). This parameter should be used with care and tested with the printer driver in question. It is better to leave the device mode to NULL and let the Windows client set the correct values. Because drivers do not do this all the time, setting __default devmode = yes__ will instruct smbd to generate a default one. For more information on Windows NT/2k printing and Device Modes, see the MSDN documentation Default: __default devmode = no__ __default service (G)__ This parameter specifies the name of a service which will be connected to if the service actually requested cannot be found. Note that the square brackets are __NOT__ given in the parameter value (see example below). There is no default value for this parameter. If this parameter is not given, attempting to connect to a nonexistent service results in an error. Typically the default service would be a ''guest ok'', ''read-only'' service. Also note that the apparent service name will be changed to equal that of the requested service, this is very useful as it allows you to use macros like ''%S'' to make a wildcard service. Note also that any Example: [[global] default service = pub [[pub] path = /%S __delete printer command (G)__ With the introduction of MS-RPC based printer support for Windows NT/2000 clients in Samba 2.2, it is now possible to delete printer at run time by issuing the !DeletePrinter() RPC call. For a Samba host this means that the printer must be physically deleted from underlying printing system. The ''deleteprinter command'' defines a script to be run which will perform the necessary operations for removing the printer from the print system and from ''smb.conf''. The ''delete printer command'' is automatically called with only one parameter: '' ''. Once the ''delete printer command'' has been executed, __smbd__ will reparse the ''smb.conf'' to associated printer no longer exists. If the sharename is still valid, then __smbd__ will return an ACCESS_DENIED error to the client. See also ''add printer command'', ''printing'', ''show add printer wizard'' Default: __none__ Example: __deleteprinter command = /usr/bin/removeprinter__ __delete readonly (S)__ This parameter allows readonly files to be deleted. This is not normal DOS semantics, but is allowed by UNIX. This option may be useful for running applications such as rcs, where UNIX file ownership prevents changing file permissions, and DOS semantics prevent deletion of a read only file. Default: __delete readonly = no__ __delete share command (G)__ Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The ''delete share command'' is used to define an external program or script which will remove an existing service definition from ''smb.conf''. In order to successfully execute the ''delete share command'', __smbd__ requires that the administrator be connected using a root account (i.e. uid == 0). When executed, __smbd__ will automatically invoke the ''delete share command'' with two parameters. ''configFile'' - the location of the global ''smb.conf'' file. ''shareName'' - the name of the existing service. This parameter is only used to remove file shares. To delete printer shares, see the ''delete printer command''. See also ''add share command'', ''change share command''. Default: __none__ Example: __delete share command = /usr/local/bin/delshare__ __delete user script (G)__ This is the full pathname to a script that will be run __AS ROOT__ by __smbd(8)__under special circumstances described below. Normally, a Samba server requires that UNIX users are created for all users accessing files on this server. For sites that use Windows NT account databases as their primary user database creating these users and keeping the user list in sync with the Windows NT PDC is an onerous task. This option allows __smbd__ to delete the required UNIX users __ON DEMAND__ when a user accesses the Samba server and the Windows NT user no longer exists. In order to use this option, __smbd__ must be set to ''security = domain'' and ''delete user script'' must be set to a full pathname for a script that will delete a UNIX user given one argument of ''%u'' , which expands into the UNIX user name to delete. __NOTE__ that this is different to the ''add user script'' which will work with the ''security = server'' option as well as ''security = domain''. The reason for this is only when Samba is a domain member does it get the information on an attempted user logon that a user no longer exists. In the ''security = server'' mode a missing user is treated the same as an invalid password logon attempt. Deleting the user in this circumstance would not be a good idea. When the Windows user attempts to access the Samba server, at __login__ (session setup in the SMB protocol) time, __smbd__ contacts the ''password server'' and attempts to authenticate the given user with the given password. If the authentication fails with the specific Domain error code meaning that the user no longer exists then __smbd__ attempts to find a UNIX user in the UNIX password database that matches the Windows user account. If this lookup succeeds, and ''delete user script'' is set then __smbd__ will all the specified script __AS ROOT__, expanding any ''%u'' argument to be the user name to delete. This script should delete the given UNIX username. In this way, UNIX users are dynamically deleted to match existing Windows NT accounts. See also security = domain, ''password server'' , ''add user script'' . Default: __delete user script = __ Example: __delete user script = /usr/local/samba/bin/del_user %u__ __delete veto files (S)__ This option is used when Samba is attempting to delete a directory that contains one or more vetoed directories (see the ''veto files'' option). If this option is set to false (the default) then if a vetoed directory contains any non-vetoed files or directories then the directory delete will fail. This is usually what you want. If this option is set to true, then Samba will attempt to recursively delete any files and directories within the vetoed directory. This can be useful for integration with file serving systems such as !NetAtalk which create meta-files within directories you might normally veto DOS/Windows users from seeing (e.g. ''.!AppleDouble'') Setting __delete veto files = yes__ allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so). See also the ''veto files'' parameter. Default: __delete veto files = no__ __deny hosts (S)__ Synonym for ''hosts deny''. __dfree command (G)__ The ''dfree command'' setting should only be used on systems where a problem occurs with the internal disk space calculations. This has been known to happen with Ultrix, but may occur with other operating systems. The symptom that was seen was an error of '' This setting allows the replacement of the internal routines to calculate the total disk space and amount available with an external routine. The example below gives a possible script that might fulfill this function. The external program will be passed a single parameter indicating a directory in the filesystem being queried. This will typically consist of the string ''./''. The script should return two integers in ASCII. The first should be the total disk space in blocks, and the second should be the number of available blocks. An optional third return value can give the block size in bytes. The default blocksize is 1024 bytes. Note: Your script should __NOT__ be setuid or setgid and should be owned by (and writeable only by) root! Default: __By default internal routines for determining the disk capacity and remaining space will be used.__ Example: __dfree command = /usr/local/samba/bin/dfree__ Where the script dfree (which must be made executable) could be: #!/bin/sh df $1 | tail -1 | awk '{print $2 or perhaps (on Sys V based systems): #!/bin/sh /usr/bin/df -k $1 | tail -1 | awk '{print $3 Note that you may have to replace the command names with full path names on some systems. __directory (S)__ Synonym for ''path'' . __directory mask (S)__ This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories. When a directory is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit-wise 'AND'ed with this parameter. This parameter may be thought of as a bit-wise MASK for the UNIX modes of a directory. Any bit __not__ set here will be removed from the modes set on a directory when it is created. The default value of this parameter removes the 'group' and 'other' write bits from the UNIX mode, allowing only the user who owns the directory to modify it. Following this Samba will bit-wise 'OR' the UNIX mode created from this parameter with the value of the ''force directory mode'' parameter. This parameter is set to 000 by default (i.e. no extra mode bits are added). Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors. If the administrator wishes to enforce a mask on access control lists also, they need to set the ''directory security mask''. See the ''force directory mode'' parameter to cause particular mode bits to always be set on created directories. See also the ''create mode'' parameter for masking mode bits on created files, and the ''directory security mask'' parameter. Also refer to the ''inherit permissions'' parameter. Default: __directory mask = 0755__ Example: __directory mask = 0775__ __directory mode (S)__ Synonym for ''directory mask'' __directory security mask (S)__ This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a directory using the native NT security dialog box. This parameter is applied as a mask (AND'ed with) to the changed permission bits, thus preventing any bits not in this mask from being modified. Essentially, zero bits in this mask may be treated as a set of bits the user is not allowed to change. If not set explicitly this parameter is set to 0777 meaning a user is allowed to modify all the user/group/world permissions on a directory. __Note__ that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone __ See also the ''force directory security mode'', ''security mask'', ''force security mode'' parameters. Default: __directory security mask = 0777__ Example: __directory security mask = 0700__ __disable spoolss (G)__ Enabling this parameter will disables Samba's support for the SPOOLSS set of MS-RPC's and will yield identical behavior as Samba 2.0.x. Windows NT/2000 clients will downgrade to using Lanman style printing commands. Windows 9x/ME will be uneffected by the parameter. However, this will also disable the ability to upload printer drivers to a Samba server via the Windows NT Add Printer Wizard or by using the NT printer properties dialog window. It will also disable the capability of Windows NT/2000 clients to download print drivers from the Samba host upon demand. __Be very careful about enabling this parameter.__ See also use client driver Default : __disable spoolss = no__ __dns proxy (G)__ Specifies that nmbd(8) when acting as a WINS server and finding that a NetBIOS name has not been registered, should treat the NetBIOS name word-for-word as a DNS name and do a lookup with the DNS server for that name on behalf of the name-querying client. Note that the maximum length for a NetBIOS name is 15 characters, so the DNS name (or DNS alias) can likewise only be 15 characters, maximum. __nmbd__ spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action. See also the parameter ''wins support''. Default: __dns proxy = yes__ __domain admin group (G)__ This parameter is intended as a temporary solution to enable users to be a member of the smb.conf'' notation. See also ''domain guest group'', ''domain logons'' Default: __no domain administrators__ Example: __domain admin group = root @wheel__ __domain guest group (G)__ This parameter is intended as a temporary solution to enable users to be a member of the smb.conf'' notation. See also ''domain admin group'', ''domain logons'' Default: __no domain guests__ Example: __domain guest group = nobody @guest__ __domain logons (G)__ If set to true, the Samba server will serve Windows 95/98 Domain logons for the ''workgroup'' it is in. Samba 2.2 also has limited capability to act as a domain controller for Windows NT 4 Domains. For more details on setting up this feature see the Samba-PDC-HOWTO included in the ''htmldocs/'' directory shipped with the source code. Default: __domain logons = no__ __domain master (G)__ Tell __nmbd(8)__to enable WAN-wide browse list collation. Setting this option causes __nmbd__ to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given ''workgroup''. Local master browsers in the same ''workgroup'' on broadcast-isolated subnets will give this __nmbd__ their local browse lists, and then ask __smbd(8)__ for a complete copy of the browse list for the whole wide area network. Browser clients will then contact their local master browser, and will receive the domain-wide browse list, instead of just the list for their broadcast-isolated subnet. Note that Windows NT Primary Domain Controllers expect to be able to claim this ''workgroup'' specific special NetBIOS name that identifies them as domain master browsers for that ''workgroup'' by default (i.e. there is no way to prevent a Windows NT PDC from attempting to do this). This means that if this parameter is set and __nmbd__ claims the special name for a ''workgroup'' before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail. If __domain logons = yes__ , then the default behavior is to enable the ''domain master'' parameter. If ''domain logons'' is not enabled (the default setting), then neither will ''domain master'' be enabled by default. Default: __domain master = auto__ __dont descend (S)__ There are certain directories on some systems (e.g., the ''/proc'' tree under Linux) that are either not of interest to clients or are infinitely deep (recursive). This parameter allows you to specify a comma-delimited list of directories that the server should always show as empty. Note that Samba can be very fussy about the exact format of the ./proc'' instead of just ''/proc''. Experimentation is the best policy :-) Default: __none (i.e., all directories are OK to descend)__ Example: __dont descend = /proc,/dev__ __dos filemode (S)__ The default behavior in Samba is to provide UNIX-like behavior where only the owner of a file/directory is able to change the permissions on it. However, this behavior is often confusing to DOS/Windows users. Enabling this parameter allows a user who has write access to the file (by whatever means) to modify the permissions on it. Note that a user belonging to the group owning the file will not be allowed to change permissions if the group is only granted read access. Ownership of the file/directory is not changed, only the permissions are modified. Default: __dos filemode = no__ __dos filetime resolution (S)__ Under the DOS and Windows FAT filesystem, the finest granularity on time resolution is two seconds. Setting this parameter for a share causes Samba to round the reported time down to the nearest two second boundary when a query call that requires one second resolution is made to __smbd(8)__ This option is mainly used as a compatibility option for Visual C++ when used against Samba shares. If oplocks are enabled on a share, Visual C++ uses two different time reading calls to check if a file has changed since it was last read. One of these calls uses a one-second granularity, the other uses a two second granularity. As the two second call rounds any odd second down, then if the file has a timestamp of an odd number of seconds then the two timestamps will not match and Visual C++ will keep reporting the file has changed. Setting this option causes the two timestamps to match, and Visual C++ is happy. Default: __dos filetime resolution = no__ __dos filetimes (S)__ Under DOS and Windows, if a user can write to a file they can change the timestamp on it. Under POSIX semantics, only the owner of the file or root may change the timestamp. By default, Samba runs with POSIX semantics and refuses to change the timestamp on a file if the user __smbd__ is acting on behalf of is not the file owner. Setting this option to true allows DOS semantics and smbdwill change the file timestamp as DOS requires. Default: __dos filetimes = no__ __encrypt passwords (G)__ This boolean controls whether encrypted passwords will be negotiated with the client. Note that Windows NT 4.0 SP3 and above and also Windows 98 will by default expect encrypted passwords unless a registry entry is changed. To use encrypted passwords in Samba see the file ENCRYPTION.txt in the Samba documentation directory ''docs/'' shipped with the source code. In order for encrypted passwords to work correctly __smbd(8)__must either have access to a local ''smbpasswd(5)'' program for information on how to set up and maintain this file), or set the security = [[server|domain] parameter which causes __smbd__ to authenticate against another server. Default: __encrypt passwords = no__ __enhanced browsing (G)__ This option enables a couple of enhancements to cross-subnet browse propagation that have been added in Samba but which are not standard in Microsoft implementations. The first enhancement to browse propagation consists of a regular wildcard query to a Samba WINS server for all Domain Master Browsers, followed by a browse synchronization with each of the returned DMBs. The second enhancement consists of a regular randomised browse synchronization with all currently known DMBs. You may wish to disable this option if you have a problem with empty workgroups not disappearing from browse lists. Due to the restrictions of the browse protocols these enhancements can cause a empty workgroup to stay around forever which can be annoying. In general you should leave this option enabled as it makes cross-subnet browse propagation much more reliable. Default: __enhanced browsing = yes__ __enumports command (G)__ The concept of a smbd__ does not use a port name for anything) other than the default __enumports command'' to point to a program which should generate a list of ports, one per line, to standard output. This listing will then be used in response to the level 1 and 2 !EnumPorts() RPC. Default: __no enumports command__ Example: __enumports command = /usr/bin/listports__ __exec (S)__ This is a synonym for ''preexec''. __fake directory create times (S)__ NTFS and Windows VFAT file systems keep a create time for all files and directories. This is not the same as the ctime - status change time - that Unix keeps, so Samba by default reports the earliest of the various times Unix does keep. Setting this parameter for a share causes Samba to always report midnight 1-1-1980 as the create time for directories. This option is mainly used as a compatibility option for Visual C++ when used against Samba shares. Visual C++ generated makefiles have the object directory as a dependency for each object file, and a make rule to create the directory. Also, when NMAKE compares timestamps it uses the creation time when examining a directory. Thus the object directory will be created if it does not exist, but once it does exist it will always have an earlier timestamp than the object files it contains. However, Unix time semantics mean that the create time reported by Samba will be updated whenever a file is created or or deleted in the directory. NMAKE finds all object files in the object directory. The timestamp of the last one built is then compared to the timestamp of the object directory. If the directory's timestamp if newer, then all object files will be rebuilt. Enabling this option ensures directories always predate their contents and an NMAKE build will proceed as expected. Default: __fake directory create times = no__ __fake oplocks (S)__ Oplocks are the way that SMB clients get permission from a server to locally cache file operations. If a server grants an oplock (opportunistic lock) then the client is free to assume that it is the only one accessing the file and it will aggressively cache file data. With some oplock types the client may even cache file open/close operations. This can give enormous performance benefits. When you set __fake oplocks = yes__, __smbd(8)__will always grant oplock requests no matter how many clients are using the file. It is generally much better to use the real ''oplocks'' support rather than this parameter. If you enable this option on all read-only shares or shares that you know will only be accessed from one client at a time such as physically read-only media like CDROMs, you will see a big performance improvement on many operations. If you enable this option on shares where multiple clients may be accessing the files read-write at the same time you can get data corruption. Use this option carefully! Default: __fake oplocks = no__ __follow symlinks (S)__ This parameter allows the Samba administrator to stop __smbd(8)__ from following symbolic links in a particular share. Setting this parameter to no prevents any file or directory that is a symbolic link from being followed (the user will get an error). This option is very useful to stop users from adding a symbolic link to ''/etc/passwd'' in their home directory for instance. However it will slow filename lookups down slightly. This option is enabled (i.e. __smbd__ will follow symbolic links) by default. Default: __follow symlinks = yes__ __force create mode (S)__ This parameter specifies a set of UNIX mode bit permissions that will __always__ be set on a file created by Samba. This is done by bitwise 'OR'ing these bits onto the mode bits of a file that is being created or having its permissions changed. The default for this parameter is (in octal) 000. The modes in this parameter are bitwise 'OR'ed onto the file mode after the mask set in the ''create mask'' parameter is applied. See also the parameter ''create mask'' for details on masking mode bits on files. See also the ''inherit permissions'' parameter. Default: __force create mode = 000__ Example: __force create mode = 0755__ would force all created files to have read and execute permissions set for 'group' and 'other' as well as the read/write/execute bits set for the 'user'. __force directory mode (S)__ This parameter specifies a set of UNIX mode bit permissions that will __always__ be set on a directory created by Samba. This is done by bitwise 'OR'ing these bits onto the mode bits of a directory that is being created. The default for this parameter is (in octal) 0000 which will not add any extra permission bits to a created directory. This operation is done after the mode mask in the parameter ''directory mask'' is applied. See also the parameter ''directory mask'' for details on masking mode bits on created directories. See also the ''inherit permissions'' parameter. Default: __force directory mode = 000__ Example: __force directory mode = 0755__ would force all created directories to have read and execute permissions set for 'group' and 'other' as well as the read/write/execute bits set for the 'user'. __force directory__ This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a directory using the native NT security dialog box. This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this mask that the user may have modified to be on. Essentially, one bits in this mask may be treated as a set of bits that, when modifying security on a directory, the user has always set to be 'on'. If not set explicitly this parameter is 000, which allows a user to modify all the user/group/world permissions on a directory without restrictions. __Note__ that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone __ See also the ''directory security mask'', ''security mask'', ''force security mode'' parameters. Default: __force directory security mode = 0__ Example: __force directory security mode = 700__ __force group (S)__ This specifies a UNIX group name that will be assigned as the default primary group for all users connecting to this service. This is useful for sharing files by ensuring that all access to files on service will use the named group for their permissions checking. Thus, by assigning permissions for this group to the files and directories within this service the Samba administrator can restrict or allow sharing of these files. In Samba 2.0.5 and above this parameter has extended functionality in the following way. If the group name listed here has a '+' character prepended to it then the current user accessing the share only has the primary group default assigned to this group if they are already assigned as a member of that group. This allows an administrator to decide that only users who are already in a particular group will create files with group ownership set to that group. This gives a finer granularity of ownership assignment. For example, the setting ''force group = +sys'' means that only users who are already in group sys will have their default primary group assigned to sys when accessing this Samba share. All other users will retain their ordinary primary group. If the ''force user'' parameter is also set the group specified in ''force group'' will override the primary group set in ''force user''. See also ''force user''. Default: __no forced group__ Example: __force group = agroup__ __force security mode (S)__ This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a file using the native NT security dialog box. This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this mask that the user may have modified to be on. Essentially, one bits in this mask may be treated as a set of bits that, when modifying security on a file, the user has always set to be 'on'. If not set explicitly this parameter is set to 0, and allows a user to modify all the user/group/world permissions on a file, with no restrictions. __Note__ that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone __ See also the ''force directory security mode'', ''directory security mask'', ''security mask'' parameters. Default: __force security mode = 0__ Example: __force security mode = 700__ __force user (S)__ This specifies a UNIX user name that will be assigned as the default user for all users connecting to this service. This is useful for sharing files. You should also use it carefully as using it incorrectly can cause security problems. This user name only gets used once a connection is established. Thus clients still need to connect as a valid user and supply a valid password. Once connected, all file operations will be performed as the In Samba 2.0.5 and above this parameter also causes the primary group of the forced user to be used as the primary group for all file activity. Prior to 2.0.5 the primary group was left as the primary group of the connecting user (this was a bug). See also ''force group'' Default: __no forced user__ Example: __force user = auser__ __fstype (S)__ This parameter allows the administrator to configure the string that specifies the type of filesystem a share is using that is reported by __smbd(8)__ when a client queries the filesystem type for a share. The default type is NTFS for compatibility with Windows NT but this can be changed to other strings such as Samba or FAT if required. Default: __fstype = NTFS__ Example: __fstype = Samba__ __getwd cache (G)__ This is a tuning option. When this is enabled a caching algorithm will be used to reduce the time taken for getwd() calls. This can have a significant impact on performance, especially when the ''wide links'' parameter is set to false. Default: __getwd cache = yes__ __group (S)__ Synonym for ''force group''. __guest account (S)__ This is a username which will be used for access to services which are specified as ''guest ok'' (see below). Whatever privileges this user has will be available to any client connecting to the guest service. Typically this user will exist in the password file, but will not have a valid login. The user account '' One some systems the default guest account su -__ command) and trying to print using the system print command such as __lpr(1)__ or __lp(1)__. Default: __specified at compile time, usually __ Example: __guest account = ftp__ __guest ok (S)__ If this parameter is yes for a service, then no password is required to connect to the service. Privileges will be those of the ''guest account''. See the section below on ''security'' for more information about this option. Default: __guest ok = no__ __guest only (S)__ If this parameter is yes for a service, then only guest connections to the service are permitted. This parameter will have no effect if ''guest ok'' is not set for the service. See the section below on ''security'' for more information about this option. Default: __guest only = no__ __hide dot files (S)__ This is a boolean parameter that controls whether files starting with a dot appear as hidden files. Default: __hide dot files = yes__ __hide files(S)__ This is a list of files or directories that are not visible but are accessible. The DOS 'hidden' attribute is applied to any files or directories that match. Each entry in the list must be separated by a '/', which allows spaces to be included in the entry. '*' and '?' can be used to specify multiple files or directories as in DOS wildcards. Each entry must be a Unix path, not a DOS path and must not include the Unix directory separator '/'. Note that the case sensitivity option is applicable in hiding files. Setting this parameter will affect the performance of Samba, as it will be forced to check all files and directories for a match as they are scanned. See also ''hide dot files'', ''veto files'' and ''case sensitive''. Default: __no file are hidden__ Example: __hide files = /.*/DesktopFolderDB/!TrashFor%m/resource.frk/__ The above example is based on files that the Macintosh SMB client (DAVE) available from Thursby __hide local users(G)__ This parameter toggles the hiding of local UNIX users (root, wheel, floppy, etc) from remote clients. Default: __hide local users = no__ __hide unreadable (S)__ This parameter prevents clients from seeing the existance of files that cannot be read. Defaults to off. Default: __hide unreadable = no__ __homedir map (G)__ If''nis homedir'' is true, and __smbd(8)__is also acting as a Win95/98 ''logon server'' then this parameter specifies the NIS (or YP) map from which the server for the user's home directory should be extracted. At present, only the Sun auto.home map format is understood. The form of the map is: __username server:/some/file/system__ and the program will extract the servername from before the first ':'. There should probably be a better parsing system that copes with different map formats and also Amd (another automounter) maps. __NOTE :__A working NIS client is required on the system for this option to work. See also ''nis homedir'' , ''domain logons'' . Default: __homedir map = __ Example: __homedir map = amd.homedir__ __host msdfs (G)__ This boolean parameter is only available if Samba has been configured and compiled with the __--with-msdfs__ option. If set to yes, Samba will act as a Dfs server, and allow Dfs-aware clients to browse Dfs trees hosted on the server. See also the ''msdfs root'' share level parameter. For more information on setting up a Dfs tree on Samba, refer to msdfs_setup.html. Default: __host msdfs = no__ __hosts allow (S)__ A synonym for this parameter is ''allow hosts''. This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service. If specified in the [[global] section then it will apply to all services, regardless of whether the individual service has a different setting. You can specify the hosts by name or IP number. For example, you could restrict access to only the hosts on a Class C subnet with something like __allow hosts = 150.203.5.__ . The full syntax of the list is described in the man page ''hosts_access(5)''. Note that this man page may not be present on your system, so a brief description will be given here also. Note that the localhost address 127.0.0.1 will always be allowed access unless specifically denied by a ''hosts deny'' option. You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups. The __EXCEPT__ keyword can also be used to limit a wildcard list. The following examples may provide some help: Example 1: allow all IPs in 150.203.*.*; except one __hosts allow = 150.203. EXCEPT 150.203.6.66__ Example 2: allow hosts that match the given network/netmask __hosts allow = 150.203.15.0/255.255.255.0__ Example 3: allow a couple of hosts __hosts allow = lapland, arvidsjaur__ Example 4: allow only hosts in NIS netgroup __hosts allow = @foonet__ __hosts deny = pirate__ Note that access still requires suitable user-level passwords. See __testparm(1)__ for a way of testing your host access to see if it does what you expect. Default: __none (i.e., all hosts permitted access)__ Example: __allow hosts = 150.203.5. myhost.mynet.edu.au__ __hosts deny (S)__ The opposite of ''hosts allow'' - hosts listed here are __NOT__ permitted access to services unless the specific services have their own lists to override this one. Where the lists conflict, the ''allow'' list takes precedence. Default: __none (i.e., no hosts specifically excluded)__ Example: __hosts deny = 150.203.4. badhost.mynet.edu.au__ __hosts equiv (G)__ If this global parameter is a non-null string, it specifies the name of a file to read for the names of hosts and users who will be allowed access without specifying a password. This is not be confused with ''hosts allow'' which is about hosts access to services and is more useful for guest services. ''hosts equiv'' may be useful for NT clients which will not supply passwords to Samba. __NOTE :__ The use of ''hosts equiv'' can be a major security hole. This is because you are trusting the PC to supply the correct username. It is very easy to get a PC to supply a false username. I recommend that the ''hosts equiv'' option be only used if you really know what you are doing, or perhaps on a home network where you trust your spouse and kids. And only if you __really__ trust them :-). Default: __no host equivalences__ Example: __hosts equiv = /etc/hosts.equiv__ __include (G)__ This allows you to include one config file inside another. The file is included literally, as though typed in place. It takes the standard substitutions, except ''%u'' , ''%P'' and ''%S''. Default: __no file included__ Example: __include = /usr/local/samba/lib/admin_smb.conf__ __inherit permissions (S)__ The permissions on new files and directories are normally governed by ''create mask'', ''directory mask'', ''force create mode'' and ''force directory mode'' but the boolean inherit permissions parameter overrides this. New directories inherit the mode of the parent directory, including bits such as setgid. New files inherit their read/write bits from the parent directory. Their execute bits continue to be determined by ''map archive'' , ''map hidden'' and ''map system'' as usual. Note that the setuid bit is __never__ set via inheritance (the code explicitly prohibits this). This can be particularly useful on large systems with many users, perhaps several thousand, to allow a single [[homes] share to be used flexibly by each user. See also ''create mask'' , ''directory mask'', ''force create mode'' and ''force directory mode'' . Default: __inherit permissions = no__ __interfaces (G)__ This option allows you to override the default network interfaces list that Samba will use for browsing, name registration and other NBT traffic. By default Samba will query the kernel for the list of all active interfaces and use any interfaces except 127.0.0.1 that are broadcast capable. The option takes a list of interface strings. Each string can be in any of the following forms: a network interface name (such as eth0). This may include shell-like wildcards so eth* will match any interface starting with the substring an IP address. In this case the netmask is determined from the list of interfaces obtained from the kernel an IP/mask pair. a broadcast/mask pair. The The For example, the following line: __interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0__ would configure three network interfaces corresponding to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. The netmasks of the latter two interfaces would be set to 255.255.255.0. See also ''bind interfaces only''. Default: __all active interfaces except 127.0.0.1 that are broadcast capable__ __invalid users (S)__ This is a list of users that should not be allowed to login to this service. This is really a __paranoid__ check to absolutely ensure an improper setting does not breach your security. A name starting with a '@' is interpreted as an NIS netgroup first (if your system supports NIS), and then as a UNIX group if the name was not found in the NIS netgroup database. A name starting with '+' is interpreted only by looking in the UNIX group database. A name starting with ' + means check the UNIX group database, followed by the NIS netgroup database, and the value '''' means check the NIS netgroup database, followed by the UNIX group database (the same as the '@' prefix). The current servicename is substituted for ''%S''. This is useful in the [[homes] section. See also ''valid users'' . Default: __no invalid users__ Example: __invalid users = root fred admin @wheel__ __keepalive (G)__ The value of the parameter (an integer) represents the number of seconds between ''keepalive'' packets. If this parameter is zero, no keepalive packets will be sent. Keepalive packets, if sent, allow the server to tell whether a client is still present and responding. Keepalives should, in general, not be needed if the socket being used has the SO_KEEPALIVE attribute set on it (see ''socket options''). Basically you should only use this option if you strike difficulties. Default: __keepalive = 300__ Example: __keepalive = 600__ __kernel oplocks (G)__ For UNIXes that support kernel based ''oplocks'' (currently only IRIX and the Linux 2.4 kernel), this parameter allows the use of them to be turned on or off. Kernel oplocks support allows Samba ''oplocks'' to be broken whenever a local UNIX process or NFS operation accesses a file that __smbd(8)__ has oplocked. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a __very__ cool feature :-). This parameter defaults to on, but is translated to a no-op on systems that no not have the necessary kernel support. You should never need to touch this parameter. See also the ''oplocks'' and ''level2 oplocks'' parameters. Default: __kernel oplocks = yes__ __lanman auth (G)__ This parameter determines whether or not smbdwill attempt to authenticate users using the LANMAN password hash. If disabled, only clients which support NT password hashes (e.g. Windows NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS network client) will be able to connect to the Samba host. Default : __lanman auth = yes__ __large readwrite (G)__ This parameter determines whether or not smbd supports the new 64k streaming read and write varient SMB requests introduced with Windows 2000. Note that due to Windows 2000 client redirector bugs this requires Samba to be running on a 64-bit capable operating system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with Windows 2000 clients. Defaults to off. Not as tested as some other Samba code paths. Default : __large readwrite = no__ __ldap admin dn (G)__ This parameter is only available if Samba has been configure to include the __--with-ldapsam__ option at compile time. This option should be considered experimental and under active development. The ''ldap admin dn'' defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account information. The ''ldap admin dn'' is used in conjunction with the admin dn password stored in the ''private/secrets.tdb'' file. See the __smbpasswd(8)__man page for more information on how to accmplish this. Default : __none__ __ldap filter (G)__ This parameter is only available if Samba has been configure to include the __--with-ldapsam__ option at compile time. This option should be considered experimental and under active development. This parameter specifies the RFC 2254 compliant LDAP search filter. The default is to match the login name with the uid attribute for all entries matching the sambaAccount objectclass. Note that this filter should only return one entry. Default : __ldap filter = (__ __ldap port (G)__ This parameter is only available if Samba has been configure to include the __--with-ldapsam__ option at compile time. This option should be considered experimental and under active development. This option is used to control the tcp port number used to contact the ''ldap server''. The default is to use the stand LDAPS port 636. See Also: ldap ssl Default : __ldap port = 636__ __ldap server (G)__ This parameter is only available if Samba has been configure to include the __--with-ldapsam__ option at compile time. This option should be considered experimental and under active development. This parameter should contains the FQDN of the ldap directory server which should be queried to locate user account information. Default : __ldap server = localhost__ __ldap ssl (G)__ This parameter is only available if Samba has been configure to include the __--with-ldapsam__ option at compile time. This option should be considered experimental and under active development. This option is used to define whether or not Samba should use SSL when connecting to the ''ldap server''. This is __NOT__ related to Samba SSL support which is enabled by specifying the __--with-ssl__ option to the ''configure'' script (see ''ssl''). The ''ldap ssl'' can be set to one of three values: (a) on - Always use SSL when contacting the ''ldap server'', (b) off - Never use SSL when querying the directory, or (c) start_tls - Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server. Default : __ldap ssl = on__ __ldap suffix (G)__ This parameter is only available if Samba has been configure to include the __--with-ldapsam__ option at compile time. This option should be considered experimental and under active development. Default : __none__ __level2 oplocks (S)__ This parameter controls whether Samba supports level2 (read-only) oplocks on a share. Level2, or read-only oplocks allow Windows NT clients that have an oplock on a file to downgrade from a read-write oplock to a read-only oplock once a second client opens the file (instead of releasing all oplocks on a second open, as in traditional, exclusive oplocks). This allows all openers of the file that support level2 oplocks to cache the file for read-ahead only (ie. they may not cache writes or lock requests) and increases performance for many accesses of files that are not commonly written (such as application .EXE files). Once one of the clients which have a read-only oplock writes to the file all clients are notified (no reply is needed or waited for) and told to break their oplocks to It is recommended that this parameter be turned on to speed access to shared executables. For more discussions on level2 oplocks see the CIFS spec. Currently, if ''kernel oplocks'' are supported then level2 oplocks are not granted (even if this parameter is set to yes). Note also, the ''oplocks'' parameter must be set to true on this share in order for this parameter to have any effect. See also the ''oplocks'' and ''kernel oplocks'' parameters. Default: __level2 oplocks = yes__ __lm announce (G)__ This parameter determines if __nmbd(8)__will produce Lanman announce broadcasts that are needed by OS/2 clients in order for them to see the Samba server in their browse list. This parameter can have three values, true, false, or auto. The default is auto. If set to false Samba will never produce these broadcasts. If set to true Samba will produce Lanman announce broadcasts at a frequency set by the parameter ''lm interval''. If set to auto Samba will not send Lanman announce broadcasts by default but will listen for them. If it hears such a broadcast on the wire it will then start sending them at a frequency set by the parameter ''lm interval''. See also ''lm interval'' . Default: __lm announce = auto__ Example: __lm announce = yes__ __lm interval (G)__ If Samba is set to produce Lanman announce broadcasts needed by OS/2 clients (see the ''lm announce'' parameter) then this parameter defines the frequency in seconds with which they will be made. If this is set to zero then no Lanman announcements will be made despite the setting of the ''lm announce'' parameter. See also ''lm announce''. Default: __lm interval = 60__ Example: __lm interval = 120__ __load printers (G)__ A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default. See the printers section for more details. Default: __load printers = yes__ __local master (G)__ This option allows __nmbd(8)__to try and become a local master browser on a subnet. If set to false then __nmbd__ will not attempt to become a local master browser on a subnet and will also lose in all browsing elections. By default this value is set to true. Setting this value to true doesn't mean that Samba will __become__ the local master browser on a subnet, just that __nmbd__ will __participate__ in elections for local master browser. Setting this value to false will cause __nmbd never__ to become a local master browser. Default: __local master = yes__ __lock dir (G)__ Synonym for ''lock directory''. __lock directory (G)__ This option specifies the directory where lock files will be placed. The lock files are used to implement the ''max connections'' option. Default: __lock directory = ${prefix}/var/locks__ Example: __lock directory = /var/run/samba/locks__ __locking (S)__ This controls whether or not locking will be performed by the server in response to lock requests from the client. If __locking = no__, all lock and unlock requests will appear to succeed and all lock queries will report that the file in question is available for locking. If __locking = yes__, real locking will be performed by the server. This option __may__ be useful for read-only filesystems which __may__ not need locking (such as CDROM drives), although setting this parameter of no is not really recommended even in this case. Be careful about disabling locking either globally or in a specific service, as lack of locking may result in data corruption. You should never need to set this parameter. Default: __locking = yes__ __log file (G)__ This option allows you to override the name of the Samba log file (also known as the debug file). This option takes the standard substitutions, allowing you to have separate log files for each user or machine. Example: __log file = /usr/local/samba/var/log.%m__ __log level (G)__ The value of the parameter (an integer) allows the debug level (logging level) to be specified in the ''smb.conf'' file. This is to give greater flexibility in the configuration of the system. The default will be the log level specified on the command line or level zero if none was specified. Example: __log level = 3__ __logon drive (G)__ This parameter specifies the local path to which the home directory will be connected (see ''logon home'') and is only used by NT Workstations. Note that this option is only useful if Samba is set up as a logon server. Default: __logon drive = z:__ Example: __logon drive = h:__ __logon home (G)__ This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC. It allows you to do C:NET USE H: /HOME__ from a command prompt, for example. This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. This parameter can be used with Win9X workstations to ensure that roaming profiles are stored in a subdirectory of the user's home directory. This is done in the following way: __logon home = \%N%Uprofile__ This tells Samba to return the above string, with substitutions made when a client requests the info, generally in a !NetUserGetInfo request. Win9X clients truncate the info to \servershare when a user does __net use /home__ but use the whole string when dealing with profiles. Note that in prior versions of Samba, the ''logon path'' was returned rather than ''logon home''. This broke __net use /home__ but allowed profiles outside the home directory. The current implementation is correct, and can be used for profiles if you use the above trick. This option is only useful if Samba is set up as a logon server. Default: __logon home = __ Example: __logon home = __ __logon path (G)__ This parameter specifies the home directory where roaming profiles (NTuser.dat etc files for Windows NT) are stored. Contrary to previous versions of these manual pages, it has nothing to do with Win 9X roaming profiles. To find out how to handle roaming profiles for Win 9X system, see the ''logon home'' parameter. This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. It also specifies the directory from which the desktop'', ''start menu'', ''network neighborhood'', ''programs'' and other folders, and their contents, are loaded and displayed on your Windows NT client. The share and the path must be readable by the user for the preferences and directories to be loaded onto the Windows NT client. The share must be writeable when the user logs in for the first time, in order that the Windows NT client can create the NTuser.dat and other directories. Thereafter, the directories and any of the contents can, if required, be made read-only. It is not advisable that the NTuser.dat file be made read-only - rename it to NTuser.man to achieve the desired effect (a __MAN__datory profile). Windows clients can sometimes maintain a connection to the [[homes] share, even though there is no user logged in. Therefore, it is vital that the logon path does not include a reference to the homes share (i.e. setting this parameter to %N%Uprofile_path will cause problems). This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. Note that this option is only useful if Samba is set up as a logon server. Default: __logon path = \%N%Uprofile__ Example: __logon path = \PROFILESERVERPROFILE%U__ __logon script (G)__ This parameter specifies the batch file (.bat) or NT command file (.cmd) to be downloaded and run on a machine when a user successfully logs in. The file must contain the DOS style CR/LF line endings. Using a DOS-style editor to create the file is recommended. The script must be a relative path to the [[netlogon] service. If the [[netlogon] service specifies a ''path'' of ''/usr/local/samba/netlogon'' , and __logon script = STARTUP.BAT__, then the file that will be downloaded is: ''/usr/local/samba/netlogon/STARTUP.BAT'' The contents of the batch file are entirely your choice. A suggested command would be to add __NET TIME \SERVER /SET /YES__, to force every machine to synchronize clocks with the same time server. Another use would be to add __NET USE U: \SERVERUTILS__ for commonly used utilities, or __NET USE Q: \SERVERISO9001_QA__ for example. Note that it is particularly important not to allow write access to the [[netlogon] share, or to grant users write permission on the batch files in a secure environment, as this would allow the batch files to be arbitrarily modified and security to be breached. This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. This option is only useful if Samba is set up as a logon server. Default: __no logon script defined__ Example: __logon script = scripts%U.bat__ __lppause command (S)__ This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job. This command should be a program or script which takes a printer name and job number to pause the print job. One way of implementing this is by using job priorities, where jobs having a too low priority won't be sent to the printer. If a ''%p'' is given then the printer name is put in its place. A ''%j'' is replaced with the job number (an integer). On HPUX (see ''printing=hpux'' ), if the ''-p%p'' option is added to the lpq command, the job will show up with the correct status, i.e. if the job priority is lower than the set fence priority it will have the PAUSED status, whereas if the priority is equal or higher it will have the SPOOLED or PRINTING status. Note that it is good practice to include the absolute path in the lppause command as the PATH may not be available to the server. See also the ''printing'' parameter. Default: Currently no default value is given to this string, unless the value of the ''printing'' parameter is SYSV, in which case the default is : __lp -i %p-%j -H hold__ or if the value of the ''printing'' parameter is SOFTQ, then the default is: __qstat -s -j%j -h__ Example for HPUX: __lppause command = /usr/bin/lpalt %p-%j -p0__ __lpq cache time (G)__ This controls how long lpq info will be cached for to prevent the __lpq__ command being called too often. A separate cache is kept for each variation of the __lpq__ command used by the system, so if you use different __lpq__ commands for different users then they won't share cache information. The cache files are stored in ''/tmp/lpq.xxxx'' where xxxx is a hash of the __lpq__ command in use. The default is 10 seconds, meaning that the cached results of a previous identical __lpq__ command will be used if the cached data is less than 10 seconds old. A large value may be advisable if your __lpq__ command is very slow. A value of 0 will disable caching completely. See also the ''printing'' parameter. Default: __lpq cache time = 10__ Example: __lpq cache time = 30__ __lpq command (S)__ This parameter specifies the command to be executed on the server host in order to obtain __lpq__ -style printer status information. This command should be a program or script which takes a printer name as its only parameter and outputs printer status information. Currently eight styles of printer status information are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ. This covers most UNIX systems. You control which type is expected using the ''printing ='' option. Some clients (notably Windows for Workgroups) may not correctly send the connection number for the printer they are requesting status information about. To get around this, the server reports on the first printer service connected to by the client. This only happens if the connection number sent is invalid. If a ''%p'' is given then the printer name is put in its place. Otherwise it is placed at the end of the command. Note that it is good practice to include the absolute path in the ''lpq command'' as the __$PATH__ may not be available to the server. See also the ''printing'' parameter. Default: __depends on the setting of__ ''printing'' Example: __lpq command = /usr/bin/lpq -P%p__ __lpresume command (S)__ This parameter specifies the command to be executed on the server host in order to restart or continue printing or spooling a specific print job. This command should be a program or script which takes a printer name and job number to resume the print job. See also the ''lppause command'' parameter. If a ''%p'' is given then the printer name is put in its place. A ''%j'' is replaced with the job number (an integer). Note that it is good practice to include the absolute path in the ''lpresume command'' as the PATH may not be available to the server. See also the ''printing'' parameter. Default: Currently no default value is given to this string, unless the value of the ''printing'' parameter is SYSV, in which case the default is : __lp -i %p-%j -H resume__ or if the value of the ''printing'' parameter is SOFTQ, then the default is: __qstat -s -j%j -r__ Example for HPUX: __lpresume command = /usr/bin/lpalt %p-%j -p2__ __lprm command (S)__ This parameter specifies the command to be executed on the server host in order to delete a print job. This command should be a program or script which takes a printer name and job number, and deletes the print job. If a ''%p'' is given then the printer name is put in its place. A ''%j'' is replaced with the job number (an integer). Note that it is good practice to include the absolute path in the ''lprm command'' as the PATH may not be available to the server. See also the ''printing'' parameter. Default: __depends on the setting of__ ''printing'' Example 1: __lprm command = /usr/bin/lprm -P%p %j__ Example 2: __lprm command = /usr/bin/cancel %p-%j__ __machine password timeout (G)__ If a Samba server is a member of a Windows NT Domain (see the security = domain) parameter) then periodically a running smbd(8)process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called ''private/secrets.tdb'' . This parameter specifies how often this password will be changed, in seconds. The default is one week (expressed in seconds), the same as a Windows NT Domain member server. See also __smbpasswd(8)__ , and the security = domain) parameter. Default: __machine password timeout = 604800__ __magic output (S)__ This parameter specifies the name of a file which will contain output created by a magic script (see the ''magic script'' parameter below). Warning: If two clients use the same ''magic script'' in the same directory the output file content is undefined. Default: __magic output = __ Example: __magic output = myfile.txt__ __magic script (S)__ This parameter specifies the name of a file which, if opened, will be executed by the server when the file is closed. This allows a UNIX script to be sent to the Samba host and executed on behalf of the connected user. Scripts executed in this way will be deleted upon completion assuming that the user has the appropriate level of privilege and the file permissions allow the deletion. If the script generates output, output will be sent to the file specified by the ''magic output'' parameter (see above). Note that some shells are unable to interpret scripts containing CR/LF instead of CR as the end-of-line marker. Magic scripts must be executable __as is__ on the host, which for some hosts and some shells will require filtering at the DOS end. Magic scripts are __EXPERIMENTAL__ and should __NOT__ be relied upon. Default: __None. Magic scripts disabled.__ Example: __magic script = user.csh__ __mangle case (S)__ See the section on NAME MANGLING Default: __mangle case = no__ __mangled map (S)__ This is for those who want to directly map UNIX file names which cannot be represented on Windows/DOS. The mangling of names is not always what is needed. In particular you may have documents with file extensions that differ between DOS and UNIX. For example, under UNIX it is common to use ''.html'' for HTML files, whereas under Windows/DOS ''.htm'' is more commonly used. So to map ''html'' to ''htm'' you would use: __mangled map = (*.html *.htm)__ One very useful case is to remove the annoying '';1'' off the ends of filenames on some CDROMs (only visible under some UNIXes). To do this use a map of (*;1 *;). Default: __no mangled map__ Example: __mangled map = (*;1 *;)__ __mangled names (S)__ This controls whether non-DOS names under UNIX should be mapped to DOS-compatible names ( See the section on NAME MANGLING for details on how to control the mangling process. If mangling is used then the mangling algorithm is as follows: The first (up to) five alphanumeric characters before the rightmost dot of the filename are preserved, forced to upper case, and appear as the first (up to) five characters of the mangled name. A tilde Note that the character to use may be specified using the ''mangling char'' option, if you don't like '~'. The first three alphanumeric characters of the final extension are preserved, forced to upper case and appear as the extension of the mangled name. The final extension is defined as that part of the original filename after the rightmost dot. If there are no dots in the filename, the mangled name will have no extension (except in the case of Files whose UNIX name begins with a dot will be presented as DOS hidden files. The mangled name will be created as for other filenames, but with the leading dot removed and The two-digit hash value consists of upper case alphanumeric characters. This algorithm can cause name collisions only if files in a directory share the same first five alphanumeric characters. The probability of such a clash is 1/1300. The name mangling (if enabled) allows a file to be copied between UNIX directories from Windows/DOS while retaining the long UNIX filename. UNIX files can be renamed to a new extension from Windows/DOS and will retain the same basename. Mangled names do not change between sessions. Default: __mangled names = yes__ __mangled stack (G)__ This parameter controls the number of mangled names that should be cached in the Samba server smbd(8). This stack is a list of recently mangled base names (extensions are only maintained if they are longer than 3 characters or contains upper case characters). The larger this value, the more likely it is that mangled names can be successfully converted to correct long UNIX names. However, large stack sizes will slow most directory accesses. Smaller stacks save memory in the server (each stack element costs 256 bytes). It is not possible to absolutely guarantee correct long filenames, so be prepared for some surprises! Default: __mangled stack = 50__ Example: __mangled stack = 100__ __mangling char (S)__ This controls what character is used as the __magic__ character in name mangling. The default is a '~' but this may interfere with some software. Use this option to set it to whatever you prefer. Default: __mangling char = ~__ Example: __mangling char = ^__ __map archive (S)__ This controls whether the DOS archive attribute should be mapped to the UNIX owner execute bit. The DOS archive bit is set when a file has been modified since its last backup. One motivation for this option it to keep Samba/your PC from making any file it touches from becoming executable under UNIX. This can be quite annoying for shared source code, documents, etc... Note that this requires the ''create mask'' parameter to be set such that owner execute bit is not masked out (i.e. it must include 100). See the parameter ''create mask'' for details. Default: __map archive = yes__ __map hidden (S)__ This controls whether DOS style hidden files should be mapped to the UNIX world execute bit. Note that this requires the ''create mask'' to be set such that the world execute bit is not masked out (i.e. it must include 001). See the parameter ''create mask'' for details. Default: __map hidden = no__ __map system (S)__ This controls whether DOS style system files should be mapped to the UNIX group execute bit. Note that this requires the ''create mask'' to be set such that the group execute bit is not masked out (i.e. it must include 010). See the parameter ''create mask'' for details. Default: __map system = no__ __map to guest (G)__ This parameter is only useful in security modes other than ''security = share'' - i.e. user, server, and domain. This parameter can take three different values, which tell smbd(8)what to do with user login requests that don't match a valid UNIX user in some way. The three settings are : Never - Means user login requests with an invalid password are rejected. This is the default. Bad User - Means user logins with an invalid password are rejected, unless the username does not exist, in which case it is treated as a guest login and mapped into the ''guest account''. Bad Password - Means user logins with an invalid password are treated as a guest login and mapped into the guest account. Note that this can cause problems as it means that any user incorrectly typing their password will be silently logged on as hate__ you if you set the ''map to guest'' parameter this way :-). Note that this parameter is needed to set up security'' modes other than share. This is because in these modes the name of the resource being requested is __not__ sent to the server until after the server has successfully authenticated the client so the server cannot make authentication decisions at the correct time (connection to the share) for __ For people familiar with the older Samba releases, this parameter maps to the old compile-time setting of the GUEST_SESSSETUP value in local.h. Default: __map to guest = Never__ Example: __map to guest = Bad User__ __max connections (S)__ This option allows the number of simultaneous connections to a service to be limited. If ''max connections'' is greater than 0 then connections will be refused if this number of connections to the service are already open. A value of zero mean an unlimited number of connections may be made. Record lock files are used to implement this feature. The lock files will be stored in the directory specified by the ''lock directory'' option. Default: __max connections = 0__ Example: __max connections = 10__ __max disk size (G)__ This option allows you to put an upper limit on the apparent size of disks. If you set this option to 100 then all shares will appear to be not larger than 100 MB in size. Note that this option does not limit the amount of data you can put on the disk. In the above case you could still store much more than 100 MB on the disk, but if a client ever asks for the amount of free disk space or the total disk size then the result will be bounded by the amount specified in ''max disk size''. This option is primarily useful to work around bugs in some pieces of software that can't handle very large disks, particularly disks over 1GB in size. A ''max disk size'' of 0 means no limit. Default: __max disk size = 0__ Example: __max disk size = 1000__ __max log size (G)__ This option (an integer in kilobytes) specifies the max size the log file should grow to. Samba periodically checks the size and if it is exceeded it will rename the file, adding a ''.old'' extension. A size of 0 means no limit. Default: __max log size = 5000__ Example: __max log size = 1000__ __max mux (G)__ This option controls the maximum number of outstanding simultaneous SMB operations that Samba tells the client it will allow. You should never need to set this parameter. Default: __max mux = 50__ __max open files (G)__ This parameter limits the maximum number of open files that one smbd(8)file serving process may have open for a client at any one time. The default for this parameter is set very high (10,000) as Samba uses only one bit per unopened file. The limit of the number of open files is usually set by the UNIX per-process file descriptor limit rather than this parameter so you should never need to touch this parameter. Default: __max open files = 10000__ __max print jobs (S)__ This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment. If this number is exceeded, __smbd(8)__will remote __total print jobs''. Default: __max print jobs = 1000__ Example: __max print jobs = 5000__ __max protocol (G)__ The value of the parameter (a string) is the highest protocol level that will be supported by the server. Possible values are : CORE: Earliest version. No concept of user names. COREPLUS: Slight improvements on CORE for efficiency. LANMAN1: First __modern__ version of the protocol. Long filename support. LANMAN2: Updates to Lanman1 protocol. NT1: Current up to date version of the protocol. Used by Windows NT. Known as CIFS. Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol. See also ''min protocol'' Default: __max protocol = NT1__ Example: __max protocol = LANMAN1__ __max smbd processes (G)__ This parameter limits the maximum number of __smbd(8)__ processes concurrently running on a system and is intended as a stopgap to prevent degrading service to clients in the event that the server has insufficient resources to handle more than this number of connections. Remember that under normal operating conditions, each user will have an smbdassociated with him or her to handle connections to all shares from a given host. Default: __max smbd processes = 0__ ## no limit Example: __max smbd processes = 1000__ __max ttl (G)__ This option tells nmbd(8) what the default 'time to live' of NetBIOS names should be (in seconds) when __nmbd__ is requesting a name using either a broadcast packet or from a WINS server. You should never need to change this parameter. The default is 3 days. Default: __max ttl = 259200__ __max wins ttl (G)__ This option tells nmbd(8) when acting as a WINS server ( ''wins support = yes'') what the maximum 'time to live' of NetBIOS names that __nmbd__ will grant will be (in seconds). You should never need to change this parameter. The default is 6 days (518400 seconds). See also the ''min wins ttl'' parameter. Default: __max wins ttl = 518400__ __max xmit (G)__ This option controls the maximum packet size that will be negotiated by Samba. The default is 65535, which is the maximum. In some cases you may find you get better performance with a smaller value. A value below 2048 is likely to cause problems. Default: __max xmit = 65535__ Example: __max xmit = 8192__ __message command (G)__ This specifies what command to run when the server receives a !WinPopup style message. This would normally be a command that would deliver the message somehow. How this is to be done is up to your imagination. An example is: __message command = csh -c 'xedit %s;rm %s' __ This delivers the message using __xedit__, then removes it afterwards. __NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN IMMEDIATELY__. That's why I have the ' __ All messages are delivered as the global guest user. The command takes the standard substitutions, although ''%u'' won't work (''%U'' may be better in this case). Apart from the standard substitutions, some additional ones apply. In particular: ''%s'' = the filename containing the message. ''%t'' = the destination that the message was sent to (probably the server name). ''%f'' = who the message is from. You could make this command send mail, or whatever else takes your fancy. Please let us know of any really interesting ideas you have. Here's a way of sending the messages as mail to root: __message command = /usr/bin/mail -s 'message from %f on %m' root __ If you don't have a message command then the message won't be delivered and Samba will tell the sender there was an error. Unfortunately !WfWg totally ignores the error code and carries on regardless, saying that the message was delivered. If you want to silently delete it then try: __message command = rm %s__ Default: __no message command__ Example: __message command = csh -c 'xedit %s; rm %s' __ __min passwd length (G)__ Synonym for ''min password length''. __min password length (G)__ This option sets the minimum length in characters of a plaintext password that __smbd__ will accept when performing UNIX password changing. See also ''unix password sync'', ''passwd program'' and ''passwd chat debug'' . Default: __min password length = 5__ __min print space (S)__ This sets the minimum amount of free disk space that must be available before a user will be able to spool a print job. It is specified in kilobytes. The default is 0, which means a user can always spool a print job. See also the ''printing'' parameter. Default: __min print space = 0__ Example: __min print space = 2000__ __min protocol (G)__ The value of the parameter (a string) is the lowest SMB protocol dialect than Samba will support. Please refer to the ''max protocol'' parameter for a list of valid protocol names and a brief description of each. You may also wish to refer to the C source code in ''source/smbd/negprot.c'' for a listing of known protocol dialects supported by clients. If you are viewing this parameter as a security measure, you should also refer to the ''lanman auth'' parameter. Otherwise, you should never need to change this parameter. Default : __min protocol = CORE__ Example : __min protocol = NT1__ # disable DOS clients __min wins ttl (G)__ This option tells nmbd(8) when acting as a WINS server ( ''wins support = yes'') what the minimum 'time to live' of NetBIOS names that __nmbd__ will grant will be (in seconds). You should never need to change this parameter. The default is 6 hours (21600 seconds). Default: __min wins ttl = 21600__ __msdfs root (S)__ This boolean parameter is only available if Samba is configured and compiled with the __--with-msdfs__ option. If set to yes, Samba treats the share as a Dfs root and allows clients to browse the distributed file system tree rooted at the share directory. Dfs links are specified in the share directory by symbolic links of the form ''msdfs:serverAshareA,serverBshareB'' and so on. For more information on setting up a Dfs tree on Samba, refer to msdfs_setup.html See also ''host msdfs'' Default: __msdfs root = no__ __name resolve order (G)__ This option is used by the programs in the Samba suite to determine what naming services to use and in what order to resolve host names to IP addresses. The option takes a space separated string of name resolution options. The options are : lmhosts : Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has no name type attached to the NetBIOS name (see the lmhosts(5)for details) then any name type matches for lookup. host : Do a standard host name to IP address resolution, using the system ''/etc/hosts'' , NIS, or DNS lookups. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the ''/etc/nsswitch.conf'' file. Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored. wins : Query a name with the IP address listed in the ''wins server'' parameter. If no WINS server has been specified this method will be ignored. bcast : Do a broadcast on each of the known local interfaces listed in the ''interfaces'' parameter. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet. Default: __name resolve order = lmhosts host wins bcast__ Example: __name resolve order = lmhosts bcast host__ This will cause the local lmhosts file to be examined first, followed by a broadcast attempt, followed by a normal system hostname lookup. __netbios aliases (G)__ This is a list of NetBIOS names that nmbd(8)will advertise as additional names by which the Samba server is known. This allows one machine to appear in browse lists under multiple names. If a machine is acting as a browse server or logon server none of these names will be advertised as either browse server or logon servers, only the primary name of the machine will be advertised with these capabilities. See also ''netbios name''. Default: __empty string (no additional names)__ Example: __netbios aliases = TEST TEST1 TEST2__ __netbios name (G)__ This sets the NetBIOS name by which a Samba server is known. By default it is the same as the first component of the host's DNS name. If a machine is a browse server or logon server this name (or the first component of the hosts DNS name) will be the name that these services are advertised under. See also ''netbios aliases''. Default: __machine DNS name__ Example: __netbios name = MYNAME__ __netbios scope (G)__ This sets the NetBIOS scope that Samba will operate under. This should not be set unless every machine on your LAN also sets this value. __nis homedir (G)__ Get the home share server from a NIS map. For UNIX systems that use an automounter, the user's home directory will often be mounted on a workstation on demand from a remote server. When the Samba logon server is not the actual home directory server, but is mounting the home directories via NFS then two network hops would be required to access the users home directory if the logon server told the client to use itself as the SMB server for home directories (one over SMB and one over NFS). This can be very slow. This option allows Samba to return the home share as being on a different server to the logon server and as long as a Samba daemon is running on the home directory server, it will be mounted on the Samba client directly from the directory server. When Samba is returning the home share to the client, it will consult the NIS map specified in ''homedir map'' and return the server listed there. Note that for this option to work there must be a working NIS system and the Samba server with this option must also be a logon server. Default: __nis homedir = no__ __nt acl support (S)__ This boolean parameter controls whether smbd(8)will attempt to map UNIX permissions into Windows NT access control lists. This parameter was formally a global parameter in releases prior to 2.2.2. Default: __nt acl support = yes__ __nt pipe support (G)__ This boolean parameter controls whether smbd(8)will allow Windows NT clients to connect to the NT SMB specific IPC$ pipes. This is a developer debugging option and can be left alone. Default: __nt pipe support = yes__ __nt smb support (G)__ This boolean parameter controls whether smbd(8)will negotiate NT specific SMB support with Windows NT clients. Although this is a developer debugging option and should be left alone, benchmarking has discovered that Windows NT clients give faster performance with this option set to no. This is still being investigated. If this option is set to no then Samba offers exactly the same SMB calls that versions prior to Samba 2.0 offered. This information may be of use if any users are having problems with NT SMB support. You should not need to ever disable this parameter. Default: __nt smb support = yes__ __null passwords (G)__ Allow or disallow client access to accounts that have null passwords. See also smbpasswd (5). Default: __null passwords = no__ __obey pam restrictions (G)__ When Samba 2.2 is configured to enable PAM support (i.e. --with-pam), this parameter will control whether or not Samba should obey PAM's account and session management directives. The default behavior is to use PAM for clear text authentication only and to ignore any account or session management. Note that Samba always ignores PAM for authentication in the case of ''encrypt passwords = yes'' . The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB password encryption. Default: __obey pam restrictions = no__ __only user (S)__ This is a boolean option that controls whether connections with usernames not in the ''user'' list will be allowed. By default this option is disabled so that a client can supply a username to be used by the server. Enabling this parameter will force the server to only user the login names from the ''user'' list and is only really useful in shave level security. Note that this also means Samba won't try to deduce usernames from the service name. This can be annoying for the [[homes] section. To get around this you could use __user = %S__ which means your ''user'' list will be just the service name, which for home directories is the name of the user. See also the ''user'' parameter. Default: __only user = no__ __only guest (S)__ A synonym for ''guest only''. __oplock break wait time (G)__ This is a tuning parameter added due to bugs in both Windows 9x and WinNT. If Samba responds to a client too quickly when that client issues an SMB that can cause an oplock break request, then the network client can fail and not respond to the break request. This tuning parameter (which is set in milliseconds) is the amount of time Samba will wait before sending an oplock break request to such (broken) clients. __DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE__. Default: __oplock break wait time = 0__ __oplock contention limit (S)__ This is a __very__ advanced smbd(8)tuning option to improve the efficiency of the granting of oplocks under multiple client contention for the same file. In brief it specifies a number, which causes smbdnot to grant an oplock even when requested if the approximate number of clients contending for an oplock on the same file goes over this limit. This causes __smbd__ to behave in a similar way to Windows NT. __DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE__. Default: __oplock contention limit = 2__ __oplocks (S)__ This boolean option tells __smbd__ whether to issue oplocks (opportunistic locks) to file open requests on this share. The oplock code can dramatically (approx. 30% or more) improve the speed of access to files on Samba servers. It allows the clients to aggressively cache files locally and you may want to disable this option for unreliable network environments (it is turned on by default in Windows NT Servers). For more information see the file ''Speed.txt'' in the Samba ''docs/'' directory. Oplocks may be selectively turned off on certain files with a share. See the ''veto oplock files'' parameter. On some systems oplocks are recognized by the underlying operating system. This allows data synchronization between all access to oplocked files, whether it be via Samba or NFS or a local UNIX process. See the ''kernel oplocks'' parameter for details. See also the ''kernel oplocks'' and ''level2 oplocks'' parameters. Default: __oplocks = yes__ __os level (G)__ This integer value controls what level Samba advertises itself as for browse elections. The value of this parameter determines whether nmbd(8) has a chance of becoming a local master browser for the ''WORKGROUP'' in the local broadcast area. __Note :__By default, Samba will win a local master browsing election over all Microsoft operating systems except a Windows NT 4.0/2000 Domain Controller. This means that a misconfigured Samba host can effectively isolate a subnet for browsing purposes. See ''BROWSING.txt'' in the Samba ''docs/'' directory for details. Default: __os level = 20__ Example: __os level = 65__ __os2 driver map (G)__ The parameter is used to define the absolute path to a file containing a mapping of Windows NT printer driver names to OS/2 printer driver names. The format is: For example, a valid entry using the HP !LaserJet 5 printer driver would appear as __HP !LaserJet 5L = LASERJET.HP !LaserJet 5L__. The need for the file is due to the printer driver namespace problem described in the Samba Printing HOWTO. For more details on OS/2 clients, please refer to the OS2-Client-HOWTO containing in the Samba documentation. Default: __os2 driver map = __ __pam password change (G)__ With the addition of better PAM support in Samba 2.2, this parameter, it is possible to use PAM's password change control flag for Samba. If enabled, then PAM will be used for password changes when requested by an SMB client instead of the program listed in ''passwd program''. It should be possible to enable this without changing your ''passwd chat'' parameter for most setups. Default: __pam password change = no__ __panic action (G)__ This is a Samba developer option that allows a system command to be called when either smbd(8) crashes. This is usually used to draw attention to the fact that a problem occurred. Default: __panic action = __ Example: __panic action = __ __passwd chat (G)__ This string controls the ____ conversation that takes places between smbdand the local password changing program to change the user's password. The string describes a sequence of response-receive pairs that smbd(8)uses to determine what to send to the ''passwd program'' and what to expect back. If the expected output is not received then the password is not changed. This chat sequence is often quite site specific, depending on what local methods are used for password control (such as NIS etc). Note that this parameter only is only used if the ''unix password sync'' parameter is set to yes. This sequence is then called __AS ROOT__ when the SMB password in the smbpasswd file is being changed, without access to the old password cleartext. This means that root must be able to reset the user's password without knowing the text of the previous password. In the presence of NIS/YP, this means that the passwd program must be executed on the NIS master. The string can contain the macro ''%n'' which is substituted for the new password. The chat sequence can also contain the standard macros n, r, t and s to give line-feed, carriage-return, tab and space. The chat sequence string can also contain a '*' which matches any sequence of characters. Double quotes can be used to collect strings with spaces in them into a single string. If the send string in any part of the chat sequence is a full stop If the ''pam password change'' parameter is set to true, the chat pairs may be matched in any order, and success is determined by the PAM result, not any particular output. The n macro is ignored for PAM conversions. See also ''unix password sync'', ''passwd program'' , ''passwd chat debug'' and ''pam password change''. Default: __passwd chat = *new*password* %nn *new*password* %nn *changed*__ Example: __passwd chat = __ __passwd chat debug (G)__ This boolean specifies if the passwd chat script parameter is run in __debug__ mode. In this mode the strings passed to and received from the passwd chat are printed in the smbd(8)log with a ''debug level'' of 100. This is a dangerous option as it will allow plaintext passwords to be seen in the __smbd__ log. It is available to help Samba admins debug their ''passwd chat'' scripts when calling the ''passwd program'' and should be turned off after this has been done. This option has no effect if the ''pam password change'' paramter is set. This parameter is off by default. See also ''passwd chat'' , ''pam password change'' , ''passwd program'' . Default: __passwd chat debug = no__ __passwd program (G)__ The name of a program that can be used to set UNIX user passwords. Any occurrences of ''%u'' will be replaced with the user name. The user name is checked for existence before calling the password changing program. Also note that many passwd programs insist in __reasonable__ passwords, such as a minimum length, or the inclusion of mixed case chars and digits. This can pose a problem as some clients (such as Windows for Workgroups) uppercase the password before sending it. __Note__ that if the ''unix password sync'' parameter is set to true then this program is called __AS ROOT__ before the SMB password in the smbpasswd(5) file is changed. If this UNIX password change fails, then __smbd__ will fail to change the SMB password also (this is by design). If the ''unix password sync'' parameter is set this parameter __MUST USE ABSOLUTE PATHS__ for __ALL__ programs called, and must be examined for security implications. Note that by default ''unix password sync'' is set to false. See also ''unix password sync''. Default: __passwd program = /bin/passwd__ Example: __passwd program = /sbin/npasswd %u__ __password level (G)__ Some client/server combinations have difficulty with mixed-case passwords. One offending client is Windows for Workgroups, which for some reason forces passwords to upper case when using the LANMAN1 protocol, but leaves them alone when using COREPLUS! Another problem child is the Windows 95/98 family of operating systems. These clients upper case clear text passwords even when NT LM 0.12 selected by the protocol negotiation request/response. This parameter defines the maximum number of characters that may be upper case in passwords. For example, say the password given was password level'' is set to 1, the following combinations would be tried if '' If ''password level'' was set to 2, the following combinations would also be tried: And so on. The higher value this parameter is set to the more likely it is that a mixed case password will be matched against a single case password. However, you should be aware that use of this parameter reduces security and increases the time taken to process a new connection. A value of zero will cause only two attempts to be made - the password as is and the password in all-lower case. Default: __password level = 0__ Example: __password level = 4__ __password server (G)__ By specifying the name of another SMB server (such as a WinNT box) with this option, and using __security = domain__ or __security = server__ you can get Samba to do all its username/password validation via a remote server. This option sets the name of the password server to use. It must be a NetBIOS name, so if the machine's NetBIOS name is different from its Internet name then you may have to add its NetBIOS name to the lmhosts file which is stored in the same directory as the ''smb.conf'' file. The name of the password server is looked up using the parameter ''name resolve order'' and so may resolved by any method and order described in that parameter. The password server much be a machine capable of using the __NOTE:__ Using a password server means your UNIX box (running Samba) is only as secure as your password server. __DO NOT CHOOSE A PASSWORD SERVER THAT YOU DON'T COMPLETELY TRUST__. Never point a Samba server at itself for password serving. This will cause a loop and could lock up your Samba server! The name of the password server takes the standard substitutions, but probably the only useful one is ''%m'' , which means the Samba server will use the incoming client as the password server. If you use this then you better trust your clients, and you had better restrict them with hosts allow! If the ''security'' parameter is set to domain, then the list of machines in this option must be a list of Primary or Backup Domain controllers for the Domain or the character '*', as the Samba server is effectively in that domain, and will use cryptographically authenticated RPC calls to authenticate the user logging on. The advantage of using __security = domain__ is that if you list several hosts in the ''password server'' option then __smbd__ will try each in turn till it finds one that responds. This is useful in case your primary server goes down. If the ''password server'' option is set to the character '*', then Samba will attempt to auto-locate the Primary or Backup Domain controllers to authenticate against by doing a query for the name WORKGROUP '' If the ''security'' parameter is set to server, then there are different restrictions that __security = domain__ doesn't suffer from: You may list several password servers in the ''password server'' parameter, however if an __smbd__ makes a connection to a password server, and then the password server fails, no more users will be able to be authenticated from this __smbd__. This is a restriction of the SMB/CIFS protocol when in __security = server__ mode and cannot be fixed in Samba. If you are using a Windows NT server as your password server then you will have to ensure that your users are able to login from the Samba server, as when in __security = server__ mode the network logon will appear to come from there rather than from the users workstation. See also the ''security'' parameter. Default: __password server = __ Example: __password server = NT-PDC, NT-BDC1, NT-BDC2__ Example: __password server = *__ __path (S)__ This parameter specifies a directory to which the user of the service is to be given access. In the case of printable services, this is where print data will spool prior to being submitted to the host for printing. For a printable service offering guest access, the service should be readonly and the path should be world-writeable and have the sticky bit set. This is not mandatory of course, but you probably won't get the results you expect if you do otherwise. Any occurrences of ''%u'' in the path will be replaced with the UNIX username that the client is using on this connection. Any occurrences of ''%m'' will be replaced by the NetBIOS name of the machine they are connecting from. These replacements are very useful for setting up pseudo home directories for users. Note that this path will be based on ''root dir'' if one was specified. Default: __none__ Example: __path = /home/fred__ __posix locking (S)__ The __smbd(8)__ daemon maintains an database of file locks obtained by SMB clients. The default behavior is to map this internal database to POSIX locks. This means that file locks obtained by SMB clients are consistent with those seen by POSIX compliant applications accessing the files via a non-SMB method (e.g. NFS or local file access). You should never need to disable this parameter. Default: __posix locking = yes__ __postexec (S)__ This option specifies a command to be run whenever the service is disconnected. It takes the usual substitutions. The command may be run as the root on some systems. An interesting example may be to unmount server resources: __postexec = /etc/umount /cdrom__ See also ''preexec'' . Default: __none (no command executed)__ Example: __postexec = echo __ __postscript (S)__ This parameter forces a printer to interpret the print files as !PostScript. This is done by adding a %! to the start of print output. This is most useful when you have lots of PCs that persist in putting a control-D at the start of print jobs, which then confuses your printer. Default: __postscript = no__ __preexec (S)__ This option specifies a command to be run whenever the service is connected to. It takes the usual substitutions. An interesting example is to send the users a welcome message every time they log in. Maybe a message of the day? Here is an example: __preexec = csh -c 'echo __ Of course, this could get annoying after a while :-) See also ''preexec close'' and ''postexec'' . Default: __none (no command executed)__ Example: __preexec = echo __ __preexec close (S)__ This boolean option controls whether a non-zero return code from ''preexec'' should close the service being connected to. Default: __preexec close = no__ __preferred master (G)__ This boolean parameter controls if nmbd(8)is a preferred master browser for its workgroup. If this is set to true, on startup, __nmbd__ will force an election, and it will have a slight advantage in winning the election. It is recommended that this parameter is used in conjunction with ''domain master'' __= yes__, so that __nmbd__ can guarantee becoming a domain master. Use this option with caution, because if there are several hosts (whether Samba servers, Windows 95 or NT) that are preferred master browsers on the same subnet, they will each periodically and continuously attempt to become the local master browser. This will result in unnecessary broadcast traffic and reduced browsing capabilities. See also ''os level'' . Default: __preferred master = auto__ __prefered master (G)__ Synonym for ''preferred master'' for people who cannot spell :-). __preload__ This is a list of services that you want to be automatically added to the browse lists. This is most useful for homes and printers services that would otherwise not be visible. Note that if you just want all printers in your printcap file loaded then the ''load printers'' option is easier. Default: __no preloaded services__ Example: __preload = fred lp colorlp__ __preserve case (S)__ This controls if new filenames are created with the case that the client passes, or if they are forced to be the ''default case'' . Default: __preserve case = yes__ See the section on NAME MANGLING for a fuller discussion. __print command (S)__ After a print job has finished spooling to a service, this command will be used via a __system()__ call to process the spool file. Typically the command specified will submit the spool file to the host's printing subsystem, but there is no requirement that this be the case. The server will not remove the spool file, so whatever command you specify should remove the spool file when it has been processed, otherwise you will need to manually remove old spool files. The print command is simply a text string. It will be used verbatim, with two exceptions: All occurrences of ''%s'' and ''%f'' will be replaced by the appropriate spool file name, and all occurrences of ''%p'' will be replaced by the appropriate printer name. The spool file name is generated automatically by the server. The ''%J'' macro can be used to access the job name as transmitted by the client. The print command __MUST__ contain at least one occurrence of ''%s'' or ''%f'' - the ''%p'' is optional. At the time a job is submitted, if no printer name is supplied the ''%p'' will be silently removed from the printer command. If specified in the [[global] section, the print command given will be used for any printable service that does not have its own print command specified. If there is neither a specified print command for a printable service nor a global print command, spool files will be created but not processed and (most importantly) not removed. Note that printing may fail on some UNIXes from the nobody account. If this happens then create an alternative guest account that can print and set the ''guest account'' in the [[global] section. You can form quite complex print commands by realizing that they are just passed to a shell. For example the following will log a print job, print the file, then remove it. Note that ';' is the usual separator for command in shell scripts. __print command = echo Printing %s __ You may have to vary this command considerably depending on how you normally print files on your system. The default for the parameter varies depending on the setting of the ''printing'' parameter. Default: For __printing = BSD, AIX, QNX, LPRNG or PLP :__ __print command = lpr -r -P%p %s__ For __printing = SYSV or HPUX :__ __print command = lp -c -d%p %s; rm %s__ For __printing = SOFTQ :__ __print command = lp -d%p -s %s; rm %s__ Example: __print command = /usr/local/samba/bin/myprintscript %p %s__ __print ok (S)__ Synonym for ''printable''. __printable (S)__ If this parameter is yes, then clients may open, write to and submit spool files on the directory specified for the service. Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data. The ''writeable'' parameter controls only non-printing access to the resource. Default: __printable = no__ __printcap (G)__ Synonym for ''printcap name''. __printcap name (G)__ This parameter may be used to override the compiled-in default printcap name used by the server (usually ''/etc/printcap''). See the discussion of the [[printers] section above for reasons why you might want to do this. On System V systems that use __lpstat__ to list available printers you can use __printcap name = lpstat__ to automatically obtain lists of available printers. This is the default for systems that define SYSV at configure time in Samba (this includes most System V based systems). If ''printcap name'' is set to __lpstat__ on these systems then Samba will launch __lpstat -v__ and attempt to parse the output to obtain a printer list. A minimal printcap file would look something like this: print1|My Printer 1 print2|My Printer 2 print3|My Printer 3 print4|My Printer 4 print5|My Printer 5 where the '|' separates aliases of a printer. The fact that the second alias has a space in it gives a hint to Samba that it's a comment. __NOTE__: Under AIX the default printcap name is ''/etc/qconfig''. Samba will assume the file is in AIX ''qconfig'' format if the string ''qconfig'' appears in the printcap filename. Default: __printcap name = /etc/printcap__ Example: __printcap name = /etc/myprintcap__ __printer admin (S)__ This is a list of users that can do anything to printers via the remote administration interfaces offered by MS-RPC (usually using a NT workstation). Note that the root user always has admin rights. Default: __printer admin = __ Example: __printer admin = admin, @staff__ __printer driver (S)__ __Note :__This is a deprecated parameter and will be removed in the next major release following version 2.2. Please see the instructions in the Samba 2.2. Printing HOWTOfor more information on the new method of loading printer drivers onto a Samba server. This option allows you to control the string that clients receive when they ask the server for the printer driver associated with a printer. If you are using Windows95 or Windows NT then you can use this to automate the setup of printers on your system. You need to set this parameter to the exact string (case sensitive) that describes the appropriate printer driver for your system. If you don't know the exact string to use then you should first try with no ''printer driver'' option set and the client will give you a list of printer drivers. The appropriate strings are shown in a scroll box after you have chosen the printer manufacturer. See also ''printer driver file''. Example: __printer driver = HP !LaserJet 4L__ __printer driver file (G)__ __Note :__This is a deprecated parameter and will be removed in the next major release following version 2.2. Please see the instructions in the Samba 2.2. Printing HOWTOfor more information on the new method of loading printer drivers onto a Samba server. This parameter tells Samba where the printer driver definition file, used when serving drivers to Windows 95 clients, is to be found. If this is not set, the default is : ''SAMBA_INSTALL_DIRECTORY /lib/printers.def'' This file is created from Windows 95 ''msprint.inf'' files found on the Windows 95 client system. For more details on setting up serving of printer drivers to Windows 95 clients, see the outdated documentation file in the ''docs/'' directory, ''PRINTER_DRIVER.txt''. See also ''printer driver location''. Default: __None (set in compile).__ Example: __printer driver file = /usr/local/samba/printers/drivers.def__ __printer driver location (S)__ __Note :__This is a deprecated parameter and will be removed in the next major release following version 2.2. Please see the instructions in the Samba 2.2. Printing HOWTOfor more information on the new method of loading printer drivers onto a Samba server. This parameter tells clients of a particular printer share where to find the printer driver files for the automatic installation of drivers for Windows 95 machines. If Samba is set up to serve printer drivers to Windows 95 machines, this should be set to __\MACHINEPRINTER$__ Where MACHINE is the NetBIOS name of your Samba server, and PRINTER$ is a share you set up for serving printer driver files. For more details on setting this up see the outdated documentation file in the ''docs/'' directory, ''PRINTER_DRIVER.txt''. See also ''printer driver file''. Default: __none__ Example: __printer driver location = \MACHINEPRINTER$__ __printer name (S)__ This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent. If specified in the [[global] section, the printer name given will be used for any printable service that does not have its own printer name specified. Default: __none (but may be lp on many systems)__ Example: __printer name = laserwriter__ __printer (S)__ Synonym for ''printer name''. __printing (S)__ This parameters controls how printer status information is interpreted on your system. It also affects the default values for the ''print command'', ''lpq command'', ''lppause command'' , ''lpresume command'', and ''lprm command'' if specified in the [[global] section. Currently nine printing styles are supported. They are BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, SOFTQ, and CUPS. To see what the defaults are for the other print commands when using the various options use the testparm(1)program. This option can be set on a per printer basis See also the discussion in the [[printers] section. __protocol (G)__ Synonym for ''max protocol''. __public (S)__ Synonym for ''guest ok''. __queuepause command (S)__ This parameter specifies the command to be executed on the server host in order to pause the printer queue. This command should be a program or script which takes a printer name as its only parameter and stops the printer queue, such that no longer jobs are submitted to the printer. This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT. If a ''%p'' is given then the printer name is put in its place. Otherwise it is placed at the end of the command. Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server. Default: __depends on the setting of__ ''printing'' Example: __queuepause command = disable %p__ __queueresume command (S)__ This parameter specifies the command to be executed on the server host in order to resume the printer queue. It is the command to undo the behavior that is caused by the previous parameter ( ''queuepause command''). This command should be a program or script which takes a printer name as its only parameter and resumes the printer queue, such that queued jobs are resubmitted to the printer. This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT. If a ''%p'' is given then the printer name is put in its place. Otherwise it is placed at the end of the command. Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server. Default: __depends on the setting of__ ''printing'' Example: __queuepause command = enable %p__ __read bmpx (G)__ This boolean parameter controls whether smbd(8)will support the Default: __read bmpx = no__ __read list (S)__ This is a list of users that are given read-only access to a service. If the connecting user is in this list then they will not be given write access, no matter what the ''writeable'' option is set to. The list can include group names using the syntax described in the ''invalid users'' parameter. See also the ''write list'' parameter and the ''invalid users'' parameter. Default: __read list = __ Example: __read list = mary, @students__ __read only (S)__ Note that this is an inverted synonym for ''writeable''. __read raw (G)__ This parameter controls whether or not the server will support the raw read SMB requests when transferring data to clients. If enabled, raw reads allow reads of 65535 bytes in one packet. This typically provides a major performance benefit. However, some clients either negotiate the allowable block size incorrectly or are incapable of supporting larger block sizes, and for these clients you may need to disable raw reads. In general this parameter should be viewed as a system tuning tool and left severely alone. See also ''write raw''. Default: __read raw = yes__ __read size (G)__ The option ''read size'' affects the overlap of disk reads/writes with network reads/writes. If the amount of data being transferred in several of the SMB commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger than this value then the server begins writing the data before it has received the whole packet from the network, or in the case of SMBreadbraw, it begins writing to the network before all the data has been read from disk. This overlapping works best when the speeds of disk and network access are similar, having very little effect when the speed of one is much greater than the other. The default value is 16384, but very little experimentation has been done yet to determine the optimal value, and it is likely that the best value will vary greatly between systems anyway. A value over 65536 is pointless and will cause you to allocate memory unnecessarily. Default: __read size = 16384__ Example: __read size = 8192__ __remote announce (G)__ This option allows you to setup nmbd(8)to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name. This is useful if you want your Samba server to appear in a remote workgroup for which the normal browse propagation rules don't work. The remote workgroup can be anywhere that you can send IP packets to. For example: __remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF__ the above line would cause __nmbd__ to announce itself to the two given IP addresses using the given workgroup names. If you leave out the workgroup name then the one given in the ''workgroup'' parameter is used instead. The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable. See the documentation file ''BROWSING.txt'' in the ''docs/'' directory. Default: __remote announce = __ __remote browse sync (G)__ This option allows you to setup nmbd(8)to periodically request synchronization of browse lists with the master browser of a Samba server that is on a remote segment. This option will allow you to gain browse lists for multiple workgroups across routed networks. This is done in a manner that does not work with any non-Samba servers. This is useful if you want your Samba server and all local clients to appear in a remote workgroup for which the normal browse propagation rules don't work. The remote workgroup can be anywhere that you can send IP packets to. For example: __remote browse sync = 192.168.2.255 192.168.4.255__ the above line would cause __nmbd__ to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server. The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable. If a machine IP address is given Samba makes NO attempt to validate that the remote machine is available, is listening, nor that it is in fact the browse master on its segment. Default: __remote browse sync = __ __restrict anonymous (G)__ This is a boolean parameter. If it is true, then anonymous access to the server will be restricted, namely in the case where the server is expecting the client to send a username, but it doesn't. Setting it to true will force these anonymous connections to be denied, and the client will be required to always supply a username and password when connecting. Use of this parameter is only recommended for homogeneous NT client environments. This parameter makes the use of macro expansions that rely on the username (%U, %G, etc) consistent. NT 4.0 likes to use anonymous connections when refreshing the share list, and this is a way to work around that. When restrict anonymous is true, all anonymous connections are denied no matter what they are for. This can effect the ability of a machine to access the Samba Primary Domain Controller to revalidate its machine account after someone else has logged on the client interactively. The NT client will display a message saying that the machine's account in the domain doesn't exist or the password is bad. The best way to deal with this is to reboot NT client machines between interactive logons, using Default: __restrict anonymous = no__ __root (G)__ Synonym for ''root directory''. __root dir (G)__ Synonym for ''root directory''. __root directory (G)__ The server will __chroot()__ (i.e. Change its root directory) to this directory on startup. This is not strictly necessary for secure operation. Even without it the server will deny access to files not in one of the service entries. It may also check for, and deny access to, soft links to other parts of the filesystem, or attempts to use __wide links'' parameter). Adding a ''root directory'' entry other than ''root directory'' option, __including__ some files needed for complete operation of the server. To maintain full operability of the server you will need to mirror some system files into the ''root directory'' tree. In particular you will need to mirror ''/etc/passwd'' (or a subset of it), and any binaries or configuration files needed for printing (if required). The set of files that must be mirrored is operating system dependent. Default: __root directory = /__ Example: __root directory = /homes/smb__ __root postexec (S)__ This is the same as the ''postexec'' parameter except that the command is run as root. This is useful for unmounting filesystems (such as CDROMs) after a connection is closed. See also ''postexec''. Default: __root postexec = __ __root preexec (S)__ This is the same as the ''preexec'' parameter except that the command is run as root. This is useful for mounting filesystems (such as CDROMs) when a connection is opened. See also ''preexec'' and ''preexec close''. Default: __root preexec = __ __root preexec close (S)__ This is the same as the ''preexec close'' parameter except that the command is run as root. See also ''preexec'' and ''preexec close''. Default: __root preexec close = no__ __security (G)__ This option affects how clients respond to Samba and is one of the most important settings in the ''smb.conf'' file. The option sets the The default is __security = user__, as this is the most common setting needed when talking to Windows 98 and Windows NT. The alternatives are __security = share__, __security = server__ or __security = domain__ . In versions of Samba prior to 2.0.0, the default was __security = share__ mainly because that was the only option at one stage. There is a bug in !WfWg that has relevance to this setting. When in user or server level security a !WfWg client will totally ignore the password you type in the If your PCs use usernames that are the same as their usernames on the UNIX machine then you will want to use __security = user__. If you mostly use usernames that don't exist on the UNIX box then use __security = share__. You should also use __security = share__ if you want to mainly setup shares without a password (guest shares). This is commonly used for a shared printer server. It is more difficult to setup guest shares with __security = user__, see the ''map to guest'' parameter for details. It is possible to use __smbd__ in a __hybrid mode__ where it is offers both user and share level security under different ''NetBIOS aliases''. The different settings will now be explained. __SECURITY = SHARE__ When clients connect to a share level security server they need not log onto the server with a valid username and password before attempting to connect to a shared resource (although modern clients such as Windows 95/98 and Windows NT will send a logon request with a username but no password when talking to a __security = share__ server). Instead, the clients send authentication information (passwords) on a per-share basis, at the time they attempt to connect to that share. Note that __smbd ALWAYS__ uses a valid UNIX user to act on behalf of the client, even in __security = share__ level security. As clients are not required to send a username to the server in share level security, __smbd__ uses several techniques to determine the correct UNIX user to use on behalf of the client. A list of possible UNIX usernames to match with the given client password is constructed using the following methods : If the ''guest only'' parameter is set, then all the other stages are missed and only the ''guest account'' username is checked. Is a username is sent with the share connection request, then this username (after mapping - see ''username map''), is added as a potential username. If the client did a previous __logon__ request (the !SessionSetup SMB call) then the username sent in this SMB will be added as a potential username. The name of the service the client requested is added as a potential username. The NetBIOS name of the client is added to the list as a potential username. Any users on the ''user'' list are added as potential usernames. If the ''guest only'' parameter is not set, then this list is then tried with the supplied password. The first user for whom the password matches will be used as the UNIX user. If the ''guest only'' parameter is set, or no username can be determined then if the share is marked as available to the ''guest account'', then this guest user will be used, otherwise access is denied. Note that it can be __very__ confusing in share-level security as to which UNIX username will eventually be used in granting access. See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. __SECURITY = USER__ This is the default security setting in Samba 2.2. With user-level security a client must first username map'' parameter). Encrypted passwords (see the ''encrypted passwords'' parameter) can also be used in this security mode. Parameters such as ''user'' and ''guest only'' if set are then applied and may change the UNIX user to use on this connection, but only after the user has been successfully authenticated. __Note__ that the name of the resource being requested is __not__ sent to the server until after the server has successfully authenticated the client. This is why guest shares don't work in user level security without allowing the server to automatically map unknown users into the ''guest account''. See the ''map to guest'' parameter for details on doing this. See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. __SECURITY = SERVER__ In this mode Samba will try to validate the username/password by passing it to another SMB server, such as an NT box. If this fails it will revert to __security = user__, but note that if encrypted passwords have been negotiated then Samba cannot revert back to checking the UNIX password file, it must have a valid ''smbpasswd'' file to check users against. See the documentation file in the ''docs/'' directory ''ENCRYPTION.txt'' for details on how to set this up. __Note__ that from the client's point of view __security = server__ is the same as __security = user__. It only affects how the server deals with the authentication, it does not in any way affect what the client sees. __Note__ that the name of the resource being requested is __not__ sent to the server until after the server has successfully authenticated the client. This is why guest shares don't work in user level security without allowing the server to automatically map unknown users into the ''guest account''. See the ''map to guest'' parameter for details on doing this. See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. See also the ''password server'' parameter and the ''encrypted passwords'' parameter. __SECURITY = DOMAIN__ This mode will only work correctly if smbpasswd(8)has been used to add this machine into a Windows NT Domain. It expects the ''encrypted passwords'' parameter to be set to true. In this mode Samba will try to validate the username/password by passing it to a Windows NT Primary or Backup Domain Controller, in exactly the same way that a Windows NT Server would do. __Note__ that a valid UNIX user must still exist as well as the account on the Domain Controller to allow Samba to have a valid UNIX account to map file access to. __Note__ that from the client's point of view __security = domain__ is the same as __security = user__ . It only affects how the server deals with the authentication, it does not in any way affect what the client sees. __Note__ that the name of the resource being requested is __not__ sent to the server until after the server has successfully authenticated the client. This is why guest shares don't work in user level security without allowing the server to automatically map unknown users into the ''guest account''. See the ''map to guest'' parameter for details on doing this. __BUG:__ There is currently a bug in the implementation of __security = domain__ with respect to multi-byte character set usernames. The communication with a Domain Controller must be done in UNICODE and Samba currently does not widen multi-byte user names to UNICODE correctly, thus a multi-byte username will not be recognized correctly at the Domain Controller. This issue will be addressed in a future release. See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. See also the ''password server'' parameter and the ''encrypted passwords'' parameter. Default: __security = USER__ Example: __security = DOMAIN__ __security mask (S)__ This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a file using the native NT security dialog box. This parameter is applied as a mask (AND'ed with) to the changed permission bits, thus preventing any bits not in this mask from being modified. Essentially, zero bits in this mask may be treated as a set of bits the user is not allowed to change. If not set explicitly this parameter is 0777, allowing a user to modify all the user/group/world permissions on a file. __Note__ that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone __ See also the ''force directory security mode'', ''directory security mask'', ''force security mode'' parameters. Default: __security mask = 0777__ Example: __security mask = 0770__ __server string (G)__ This controls what string will show up in the printer comment box in print manager and next to the IPC connection in __net view__. It can be any string that you wish to show to your users. It also sets what will appear in browse lists next to the machine name. A ''%v'' will be replaced with the Samba version number. A ''%h'' will be replaced with the hostname. Default: __server string = Samba %v__ Example: __server string = University of GNUs Samba Server__ __set directory (S)__ If __set directory = no__, then users of the service may not use the setdir command to change directory. The __setdir__ command is only implemented in the Digital Pathworks client. See the Pathworks documentation for details. Default: __set directory = no__ __short preserve case (S)__ This boolean parameter controls if new files which conform to 8.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the ''default case'' . This option can be use with __preserve case = yes__ to permit long filenames to retain their case, while short names are lowered. See the section on NAME MANGLING. Default: __short preserve case = yes__ __show add printer wizard (G)__ With the introduction of MS-RPC based printing support for Windows NT/2000 client in Samba 2.2, a Under normal circumstances, the Windows NT/2000 client will open a handle on the printer server with !OpenPrinterEx() asking for Administrator privileges. If the user does not have administrative access on the print server (i.e is not root or a member of the ''printer admin'' group), the !OpenPrinterEx() call fails and the client makes another open call with a request for a lower privilege level. This should succeed, however the APW icon will not be displayed. Disabling the ''show add printer wizard'' parameter will always cause the !OpenPrinterEx() on the server to fail. Thus the APW icon will never be displayed. __Note :__This does not prevent the same user from having administrative privilege on an individual printer. See also ''addprinter command'', ''deleteprinter command'', ''printer admin'' Default :__show add printer wizard = yes__ __shutdown script (G)__ __This parameter only exists in the HEAD cvs branch__ This a full path name to a script called by __smbd(8)__that should start a shutdown procedure. This command will be run as the user connected to the server. %m %t %r %f parameters are expanded ''%m'' will be substituted with the shutdown message sent to the server. ''%t'' will be substituted with the number of seconds to wait before effectively starting the shutdown procedure. ''%r'' will be substituted with the switch __-r__. It means reboot after shutdown for NT. ''%f'' will be substituted with the switch __-f__. It means force the shutdown even if applications do not respond for NT. Default: __None__. Example: __abort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f__ Shutdown script example: #!/bin/bash $time=0 let Shutdown does not return so we need to launch it in background. See also ''abort shutdown script''. __smb passwd file (G)__ This option sets the path to the encrypted smbpasswd file. By default the path to the smbpasswd file is compiled into Samba. Default: __smb passwd file = ${prefix}/private/smbpasswd__ Example: __smb passwd file = /etc/samba/smbpasswd__ __socket address (G)__ This option allows you to control what address Samba will listen for connections on. This is used to support multiple virtual interfaces on the one server, each with a different configuration. By default Samba will accept connections on any address. Example: __socket address = 192.168.2.20__ __socket options (G)__ This option allows you to set socket options to be used when talking with the client. Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned. This option will typically be used to tune your Samba server for optimal performance for your local network. There is no way that Samba can know what the optimal parameters are for your net, so you must experiment and choose them yourself. We strongly suggest you read the appropriate documentation for your operating system first (perhaps __man setsockopt__ will help). You may find that on some systems Samba will say Any of the supported socket options may be combined in any way you like, as long as your OS allows it. This is the list of socket options currently settable using this option: SO_KEEPALIVE SO_REUSEADDR SO_BROADCAST TCP_NODELAY IPTOS_LOWDELAY IPTOS_THROUGHPUT SO_SNDBUF * SO_RCVBUF * SO_SNDLOWAT * SO_RCVLOWAT * Those marked with a __'*'__ take an integer argument. The others can optionally take a 1 or 0 argument to enable or disable the option, by default they will be enabled if you don't specify 1 or 0. To specify an argument use the syntax SOME_OPTION = VALUE for example __SO_SNDBUF = 8192__. Note that you must not have any spaces before or after the = sign. If you are on a local network then a sensible option might be __socket options = IPTOS_LOWDELAY__ If you have a local network then you could try: __socket options = IPTOS_LOWDELAY TCP_NODELAY__ If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT. Note that several of the options may cause your Samba server to fail completely. Use these options with caution! Default: __socket options = TCP_NODELAY__ Example: __socket options = IPTOS_LOWDELAY__ __source environment (G)__ This parameter causes Samba to set environment variables as per the content of the file named. If the value of this parameter starts with a The contents of the file or the output of the pipe should be formatted as the output of the standard Unix __env(1)__ command. This is of the form : Example environment entry: __SAMBA_NETBIOS_NAME = myhostname__ Default: __No default value__ Examples: __source environment = |/etc/smb.conf.sh__ Example: __source environment = /usr/local/smb_env_vars__ __ssl (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. This variable enables or disables the entire SSL mode. If it is set to no, the SSL-enabled Samba behaves exactly like the non-SSL Samba. If set to yes, it depends on the variables ''ssl hosts'' and ''ssl hosts resign'' whether an SSL connection will be required. Default: __ssl = no__ __ssl CA certDir (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. This variable defines where to look up the Certification Authorities. The given directory should contain one file for each CA that Samba will trust. The file name must be the hash value over the Default: __ssl CA certDir = /usr/local/ssl/certs__ __ssl CA certFile (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. This variable is a second way to define the trusted CAs. The certificates of the trusted CAs are collected in one big file and this variable points to the file. You will probably only use one of the two ways to define your CAs. The first choice is preferable if you have many CAs or want to be flexible, the second is preferable if you only have one CA and want to keep things simple (you won't need to create the hashed file names). You don't need this variable if you don't verify client certificates. Default: __ssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem__ __ssl ciphers (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. This variable defines the ciphers that should be offered during SSL negotiation. You should not set this variable unless you know what you are doing. __ssl client cert (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. The certificate in this file is used by __smbclient(1)__if it exists. It's needed if the server requires a client certificate. Default: __ssl client cert = /usr/local/ssl/certs/smbclient.pem__ __ssl client key (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. This is the private key for __smbclient(1)__. It's only needed if the client should have a certificate. Default: __ssl client key = /usr/local/ssl/private/smbclient.pem__ __ssl compatibility (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. This variable defines whether OpenSSL should be configured for bug compatibility with other SSL implementations. This is probably not desirable because currently no clients with SSL implementations other than OpenSSL exist. Default: __ssl compatibility = no__ __ssl egd socket (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. This option is used to define the location of the communiation socket of an EGD or PRNGD daemon, from which entropy can be retrieved. This option can be used instead of or together with the ''ssl entropy file'' directive. 255 bytes of entropy will be retrieved from the daemon. Default: __none__ __ssl entropy bytes (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. This parameter is used to define the number of bytes which should be read from the ''ssl entropy file'' If a -1 is specified, the entire file will be read. Default: __ssl entropy bytes = 255__ __ssl entropy file (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. This parameter is used to specify a file from which processes will read /dev/urandom'' device file, the processes will retrieve its entropy from the kernel. On systems without kernel entropy support, a file can be supplied that will be read on startup and that will be used to seed the PRNG. Default: __none__ __ssl hosts (G)__ See ''ssl hosts resign''. __ssl hosts resign (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. These two variables define whether Samba will go into SSL mode or not. If none of them is defined, Samba will allow only SSL connections. If the ''ssl hosts'' variable lists hosts (by IP-address, IP-address range, net group or name), only these hosts will be forced into SSL mode. If the ''ssl hosts resign'' variable lists hosts, only these hosts will __NOT__ be forced into SSL mode. The syntax for these two variables is the same as for the ''hosts allow'' and ''hosts deny'' pair of variables, only that the subject of the decision is different: It's not the access right but whether SSL is used or not. The example below requires SSL connections from all hosts outside the local net (which is 192.168.*.*). Default: __ssl hosts = __ __ssl hosts resign = __ Example: __ssl hosts resign = 192.168.__ __ssl require clientcert (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. If this variable is set to yes, the server will not tolerate connections from clients that don't have a valid certificate. The directory/file given in ''ssl CA certDir'' and ''ssl CA certFile'' will be used to look up the CAs that issued the client's certificate. If the certificate can't be verified positively, the connection will be terminated. If this variable is set to no, clients don't need certificates. Contrary to web applications you really __should__ require client certificates. In the web environment the client's data is sensitive (credit card numbers) and the server must prove to be trustworthy. In a file server environment the server's data will be sensitive and the clients must prove to be trustworthy. Default: __ssl require clientcert = no__ __ssl require servercert (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. If this variable is set to yes, the __smbclient(1)__ will request a certificate from the server. Same as ''ssl require clientcert'' for the server. Default: __ssl require servercert = no__ __ssl server cert (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. This is the file containing the server's certificate. The server __must__ have a certificate. The file may also contain the server's private key. See later for how certificates and private keys are created. Default: __ssl server cert = __ __ssl server key (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. This file contains the private key of the server. If this variable is not defined, the key is looked up in the certificate file (it may be appended to the certificate). The server __must__ have a private key and the certificate __must__ match this private key. Default: __ssl server key = __ __ssl version (G)__ This variable is part of SSL-enabled Samba. This is only available if the SSL libraries have been compiled on your system and the configure option __--with-ssl__ was given at configure time. This enumeration variable defines the versions of the SSL protocol that will be used. ssl2or3 allows dynamic negotiation of SSL v2 or v3, ssl2 results in SSL v2, ssl3 results in SSL v3 and tls1 results in TLS v1. TLS (Transport Layer Security) is the new standard for SSL. Default: __ssl version = __ __stat cache (G)__ This parameter determines if smbd(8)will use a cache in order to speed up case insensitive name mappings. You should never need to change this parameter. Default: __stat cache = yes__ __stat cache size (G)__ This parameter determines the number of entries in the ''stat cache''. You should never need to change this parameter. Default: __stat cache size = 50__ __status (G)__ This enables or disables logging of connections to a status file that smbstatus(1) can read. With this disabled __smbstatus__ won't be able to tell you what connections are active. You should never need to change this parameter. Default: __status = yes__ __strict allocate (S)__ This is a boolean that controls the handling of disk space allocation in the server. When this is set to yes the server will change from UNIX behaviour of not committing real disk storage blocks when a file is extended to the Windows behaviour of actually forcing the disk system to allocate real storage blocks when a file is created or extended to be a given size. In UNIX terminology this means that Samba will stop creating sparse files. This can be slow on some systems. When strict allocate is no the server does sparse disk block allocation when a file is extended. Setting this to yes can help Samba return out of quota messages on systems that are restricting the disk quota of users. Default: __strict allocate = no__ __strict locking (S)__ This is a boolean that controls the handling of file locking in the server. When this is set to yes the server will check every read and write access for file locks, and deny access if locks exist. This can be slow on some systems. When strict locking is no the server does file lock checks only when the client explicitly asks for them. Well-behaved clients always ask for lock checks when it is important, so in the vast majority of cases __strict locking = no__ is preferable. Default: __strict locking = no__ __strict sync (S)__ Many Windows applications (including the Windows 98 explorer shell) seem to confuse flushing buffer contents to disk with doing a sync to disk. Under UNIX, a sync call forces the process to be suspended until the kernel has ensured that all outstanding data in kernel disk buffers has been safely stored onto stable storage. This is very slow and should only be done rarely. Setting this parameter to no (the default) means that smbdignores the Windows applications requests for a sync call. There is only a possibility of losing data if the operating system itself that Samba is running on crashes, so there is little danger in this default setting. In addition, this fixes many performance problems that people have reported with the new Windows98 explorer shell file copies. See also the ''sync always'' parameter. Default: __strict sync = no__ __strip dot (G)__ This is a boolean that controls whether to strip trailing dots off UNIX filenames. This helps with some CDROMs that have filenames ending in a single dot. Default: __strip dot = no__ __sync always (S)__ This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns. If this is false then the server will be guided by the client's request in each write call (clients can set a bit indicating that a particular write should be synchronous). If this is true then every write will be followed by a __fsync()__ call to ensure the data is written to disk. Note that the ''strict sync'' parameter must be set to yes in order for this parameter to have any affect. See also the ''strict sync'' parameter. Default: __sync always = no__ __syslog (G)__ This parameter maps how Samba debug messages are logged onto the system syslog logging levels. Samba debug level zero maps onto syslog LOG_ERR, debug level one maps onto LOG_WARNING, debug level two maps onto LOG_NOTICE, debug level three maps onto LOG_INFO. All higher levels are mapped to LOG_DEBUG. This parameter sets the threshold for sending messages to syslog. Only messages with debug level less than this value will be sent to syslog. Default: __syslog = 1__ __syslog only (G)__ If this parameter is set then Samba debug messages are logged into the system syslog only, and not to the debug log files. Default: __syslog only = no__ __template homedir (G)__ When filling out the user information for a Windows NT user, the winbindd(8)daemon uses this parameter to fill in the home directory for that user. If the string ''%D'' is present it is substituted with the user's Windows NT domain name. If the string ''%U'' is present it is substituted with the user's Windows NT user name. Default: __template homedir = /home/%D/%U__ __template shell (G)__ When filling out the user information for a Windows NT user, the winbindd(8)daemon uses this parameter to fill in the login shell for that user. Default: __template shell = /bin/false__ __time offset (G)__ This parameter is a setting in minutes to add to the normal GMT to local time conversion. This is useful if you are serving a lot of PCs that have incorrect daylight saving time handling. Default: __time offset = 0__ Example: __time offset = 60__ __time server (G)__ This parameter determines if nmbd(8)advertises itself as a time server to Windows clients. Default: __time server = no__ __timestamp logs (G)__ Synonym for ''debug timestamp''. __total print jobs (G)__ This parameter accepts an integer value which defines a limit on the maximum number of print jobs that will be accepted system wide at any given time. If a print job is submitted by a client which will exceed this number, then smbdwill return an error indicating that no space is available on the server. The default value of 0 means that no such limit exists. This parameter can be used to prevent a server from exceeding its capacity and is designed as a printing throttle. See also ''max print jobs''. Default: __total print jobs = 0__ Example: __total print jobs = 5000__ __unix extensions(G)__ This boolean parameter controls whether Samba implments the CIFS UNIX extensions, as defined by HP. These extensions enable CIFS to server UNIX clients to UNIX servers better, and allow such things as symbolic links, hard links etc. These extensions require a similarly enabled client, and are of no current use to Windows clients. Default: __unix extensions = no__ __unix password sync (G)__ This boolean parameter controls whether Samba attempts to synchronize the UNIX password with the SMB password when the encrypted SMB password in the smbpasswd file is changed. If this is set to true the program specified in the ''passwd program''parameter is called __AS ROOT__ - to allow the new UNIX password to be set without access to the old UNIX password (as the SMB password change code has no access to the old password cleartext, only the new). See also ''passwd program'', ''passwd chat''. Default: __unix password sync = no__ __update encrypted (G)__ This boolean parameter allows a user logging on with a plaintext password to have their encrypted (hashed) password in the smbpasswd file to be updated automatically as they log on. This option allows a site to migrate from plaintext password authentication (users authenticate with plaintext password over the wire, and are checked against a UNIX account database) to encrypted password authentication (the SMB challenge/response authentication mechanism) without forcing all users to re-enter their passwords via smbpasswd at the time the change is made. This is a convenience option to allow the change over to encrypted passwords to be made over a longer period. Once all users have encrypted representations of their passwords in the smbpasswd file this parameter should be set to no. In order for this parameter to work correctly the ''encrypt passwords'' parameter must be set to no when this parameter is set to yes. Note that even when this parameter is set a user authenticating to __smbd__ must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd) passwords. Default: __update encrypted = no__ __use client driver (S)__ This parameter applies only to Windows NT/2000 clients. It has no affect on Windows 95/98/ME clients. When serving a printer to Windows NT/2000 clients without first installing a valid printer driver on the Samba host, the client will be required to install a local printer driver. From this point on, the client will treat the print as a local printer and not a network printer connection. This is much the same behavior that will occur when __disable spoolss = yes__. The differentiating factor is that under normal circumstances, the NT/2000 client will attempt to open the network printer using MS-RPC. The problem is that because the client considers the printer to be local, it will attempt to issue the !OpenPrinterEx() call requesting access rights associated with the logged on user. If the user possesses local administator rights but not root privilegde on the Samba host (often the case), the !OpenPrinterEx() call will fail. The result is that the client will now display an If this parameter is enabled for a printer, then any attempt to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped to PRINTER_ACCESS_USE instead. Thus allowing the !OpenPrinterEx() call to succeed. __This parameter MUST not be able enabled on a print share which has valid print driver installed on the Samba server.__ See also disable spoolss Default: __use client driver = no__ __use mmap (G)__ This global parameter determines if the tdb internals of Samba can depend on mmap working correctly on the running system. Samba requires a coherent mmap/read-write system memory cache. Currently only HPUX does not have such a coherent cache, and so this parameter is set to false by default on HPUX. On all other systems this parameter should be left alone. This parameter is provided to help the Samba developers track down problems with the tdb internal code. Default: __use mmap = yes__ __use rhosts (G)__ If this global parameter is true, it specifies that the UNIX user's ''.rhosts'' file in their home directory will be read to find the names of hosts and users who will be allowed access without specifying a password. __NOTE:__ The use of ''use rhosts'' can be a major security hole. This is because you are trusting the PC to supply the correct username. It is very easy to get a PC to supply a false username. I recommend that the ''use rhosts'' option be only used if you really know what you are doing. Default: __use rhosts = no__ __user (S)__ Synonym for ''username''. __users (S)__ Synonym for ''username''. __username (S)__ Multiple users may be specified in a comma-delimited list, in which case the supplied password will be tested against each username in turn (left to right). The ''username'' line is needed only when the PC is unable to supply its own username. This is the case for the COREPLUS protocol or where your users have different !WfWg usernames to UNIX usernames. In both these cases you may also be better using the \servershare%user syntax instead. The ''username'' line is not a great solution in many cases as it means Samba will try to validate the supplied password against each of the usernames in the ''username'' line in turn. This is slow and a bad idea for lots of users in case of duplicate passwords. You may get timeouts or security breaches using this parameter unwisely. Samba relies on the underlying UNIX security. This parameter does not restrict who can login, it just offers hints to the Samba server as to what usernames might correspond to the supplied password. Users can login as whoever they please and they will be able to do no more damage than if they started a telnet session. The daemon runs as the user that they log in as, so they cannot do anything that user cannot do. To restrict a service to a particular set of users you can use the ''valid users'' parameter. If any of the usernames begin with a '@' then the name will be looked up first in the NIS netgroups list (if Samba is compiled with netgroup support), followed by a lookup in the UNIX groups database and will expand to a list of all users in the group of that name. If any of the usernames begin with a '+' then the name will be looked up only in the UNIX groups database and will expand to a list of all users in the group of that name. If any of the usernames begin with a ' Note that searching though a groups database can take quite some time, and some clients may time out during the search. See the section NOTE ABOUT USERNAME/PASSWORD VALIDATION for more information on how this parameter determines access to the services. Default: __The guest account if a guest service, else __ Examples:__username = fred, mary, jack, jane, @users, @pcgroup__ __username level (G)__ This option helps Samba to try and 'guess' at the real UNIX username, as many DOS clients send an all-uppercase username. By default Samba tries all lowercase, followed by the username with the first letter capitalized, and fails if the username is not found on the UNIX machine. If this parameter is set to non-zero the behavior changes. This parameter is a number that specifies the number of uppercase combinations to try while trying to determine the UNIX user name. The higher the number the more combinations will be tried, but the slower the discovery of usernames will be. Use this parameter when you have strange usernames on your UNIX machine, such as !AstrangeUser . Default: __username level = 0__ Example: __username level = 5__ __username map (G)__ This option allows you to specify a file containing a mapping of usernames from the clients to the server. This can be used for several purposes. The most common is to map usernames that users use on DOS or Windows machines to those that the UNIX box uses. The other is to map multiple users to a single username so that they can more easily share files. The map file is parsed line by line. Each line should contain a single UNIX username on the left then a '=' followed by a list of usernames on the right. The list of usernames on the right may contain names of the form @group in which case they will match any UNIX username in that group. The special client name '*' is a wildcard and matches any name. Each line of the map file may be up to 1023 characters long. The file is processed on each line by taking the supplied username and comparing it with each username on the right hand side of the '=' signs. If the supplied name matches any of the names on the right hand side then it is replaced with the name on the left. Processing then continues with the next line. If any line begins with a '#' or a ';' then it is ignored If any line begins with an '!' then the processing will stop after that line if a mapping was done by the line. Otherwise mapping continues with every line being processed. Using '!' is most useful when you have a wildcard mapping line later in the file. For example to map from the name admin or administrator to the UNIX name root you would use: __root = admin administrator__ Or to map anyone in the UNIX group system to the UNIX name sys you would use: __sys = @system__ You can have as many mappings as you like in a username map file. If your system supports the NIS NETGROUP option then the netgroup database is checked before the ''/etc/group'' database for matching groups. You can map Windows usernames that have spaces in them by using double quotes around the name. For example: __tridge = __ would map the windows username The following example would map mary and fred to the unix user sys, and map the rest to guest. Note the use of the '!' to tell Samba to stop processing if it gets a match on that line. !sys = mary fred guest = * Note that the remapping is applied to all occurrences of usernames. Thus if you connect to \serverfred and fred is remapped to mary then you will actually be connecting to \servermary and will need to supply a password suitable for mary not fred. The only exception to this is the username passed to the ''password server'' (if you have one). The password server will receive whatever username the client supplies without modification. Also note that no reverse mapping is done. The main effect this has is with printing. Users who have been mapped may have trouble deleting print jobs as !PrintManager under !WfWg will think they don't own the print job. Default: __no username map__ Example: __username map = /usr/local/samba/lib/users.map__ __utmp (G)__ This boolean parameter is only available if Samba has been configured and compiled with the option __--with-utmp__. If set to true then Samba will attempt to add utmp or utmpx records (depending on the UNIX system) whenever a connection is made to a Samba server. Sites may use this to record the user connecting to a Samba share. See also the ''utmp directory'' parameter. Default: __utmp = no__ __utmp directory(G)__ This parameter is only available if Samba has been configured and compiled with the option __--with-utmp__. It specifies a directory pathname that is used to store the utmp or utmpx files (depending on the UNIX system) that record user connections to a Samba server. See also the ''utmp'' parameter. By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually ''/var/run/utmp'' on Linux). Default: __no utmp directory__ __valid chars (G)__ The option allows you to specify additional characters that should be considered valid by the server in filenames. This is particularly useful for national character sets, such as adding u-umlaut or a-ring. The option takes a list of characters in either integer or character form with spaces between them. If you give two characters with a colon between them then it will be taken as an lowercase:uppercase pair. If you have an editor capable of entering the characters into the config file then it is probably easiest to use this method. Otherwise you can specify the characters in octal, decimal or hexadecimal form using the usual C notation. For example to add the single character 'Z' to the charset (which is a pointless thing to do as it's already there) you could do one of the following valid chars = Z valid chars = z:Z valid chars = 0132:0172 The last two examples above actually add two characters, and alter the uppercase and lowercase mappings appropriately. Note that you __MUST__ specify this parameter after the ''client code page'' parameter if you have both set. If ''client code page'' is set after the ''valid chars'' parameter the ''valid chars'' settings will be overwritten. See also the ''client code page'' parameter. Default: __Samba defaults to using a reasonable set of valid characters for English systems__ Example: __valid chars = 0345:0305 0366:0326 0344:0304__ The above example allows filenames to have the Swedish characters in them. __NOTE:__ It is actually quite difficult to correctly produce a ''valid chars'' line for a particular system. To automate the process tino@augsburg.net ''validchars__ which will automatically produce a complete ''valid chars'' line for a given client system. Look in the ''examples/validchars/'' subdirectory of your Samba source code distribution for this package. __valid users (S)__ This is a list of users that should be allowed to login to this service. Names starting with '@', '+' and ' invalid users'' parameter. If this is empty (the default) then any user can login. If a username is in both this list and the ''invalid users'' list then access is denied for that user. The current servicename is substituted for ''%S'' . This is useful in the [[homes] section. See also ''invalid users'' Default: __No valid users list (anyone can login)__ Example: __valid users = greg, @pcusers__ __veto files(S)__ This is a list of files and directories that are neither visible nor accessible. Each entry in the list must be separated by a '/', which allows spaces to be included in the entry. '*' and '?' can be used to specify multiple files or directories as in DOS wildcards. Each entry must be a unix path, not a DOS path and must __not__ include the unix directory separator '/'. Note that the ''case sensitive'' option is applicable in vetoing files. One feature of the veto files parameter that it is important to be aware of is Samba's behaviour when trying to delete a directory. If a directory that is to be deleted contains nothing but veto files this deletion will __fail__ unless you also set the ''delete veto files'' parameter to ''yes''. Setting this parameter will affect the performance of Samba, as it will be forced to check all files and directories for a match as they are scanned. See also ''hide files'' and ''case sensitive''. Default: __No files or directories are vetoed.__ Examples: ; Veto any files containing the word Security, ; any ending in .tmp, and any directory containing the ; word root. veto files = /*Security*/*.tmp/*root*/ ; Veto the Apple specific files that a !NetAtalk server ; creates. veto files = /.!AppleDouble/.bin/.!AppleDesktop/Network Trash Folder/ __veto oplock files (S)__ This parameter is only valid when the ''oplocks'' parameter is turned on for a share. It allows the Samba administrator to selectively turn off the granting of oplocks on selected files that match a wildcarded list, similar to the wildcarded list used in the ''veto files'' parameter. Default: __No files are vetoed for oplock grants__ You might want to do this on files that you know will be heavily contended for by clients. A good example of this is in the !NetBench SMB benchmark program, which causes heavy client contention for files ending in ''.SEM''. To cause Samba not to grant oplocks on these files you would use the line (either in the [[global] section or in the section for the particular !NetBench share : Example: __veto oplock files = /*.SEM/__ __vfs object (S)__ This parameter specifies a shared object file that is used for Samba VFS I/O operations. By default, normal disk I/O operations are used but these can be overloaded with a VFS object. The Samba VFS layer is new to Samba 2.2 and must be enabled at compile time with --with-vfs. Default : __no value__ __vfs options (S)__ This parameter allows parameters to be passed to the vfs layer at initialization time. The Samba VFS layer is new to Samba 2.2 and must be enabled at compile time with --with-vfs. See also ''vfs object''. Default : __no value__ __volume (S)__ This allows you to override the volume label returned for a share. Useful for CDROMs with installation programs that insist on a particular volume label. Default: __the name of the share__ __wide links (S)__ This parameter controls whether or not links in the UNIX file system may be followed by the server. Links that point to areas within the directory tree exported by the server are always allowed; this parameter controls access only to areas that are outside the directory tree being exported. Note that setting this parameter can have a negative effect on your server performance due to the extra system calls that Samba has to do in order to perform the link checks. Default: __wide links = yes__ __winbind cache time__ This parameter specifies the number of seconds the winbindd(8)daemon will cache user and group information before querying a Windows NT server again. Default: __winbind cache type = 15__ __winbind enum__ On large installations using winbindd(8)it may be necessary to suppress the enumeration of users through the __setpwent()__, __getpwent()__ and __endpwent()__ group of system calls. If the ''winbind enum users'' parameter is false, calls to the __getpwent__ system call will not return any data. __Warning:__ Turning off user enumeration may cause some programs to behave oddly. For example, the finger program relies on having access to the full user list when searching for matching usernames. Default: __winbind enum users = yes__ __winbind enum__ On large installations using winbindd(8)it may be necessary to suppress the enumeration of groups through the __setgrent()__, __getgrent()__ and __endgrent()__ group of system calls. If the ''winbind enum groups'' parameter is false, calls to the __getgrent()__ system call will not return any data. __Warning:__ Turning off group enumeration may cause some programs to behave oddly. Default: __winbind enum groups = yes__ __winbind gid__ The winbind gid parameter specifies the range of group ids that are allocated by the winbindd(8)daemon. This range of group ids should have no existing local or NIS groups within it as strange conflicts can occur otherwise. Default: __winbind gid = __ Example: __winbind gid = 10000-20000__ __winbind separator__ This parameter allows an admin to define the character used when listing a username of the form of ''DOMAIN'' \''user''. This parameter is only applicable when using the ''pam_winbind.so'' and ''nss_winbind.so'' modules for UNIX services. Example: __winbind separator = \__ Example: __winbind separator = +__ __winbind uid__ The winbind gid parameter specifies the range of group ids that are allocated by the winbindd(8)daemon. This range of ids should have no existing local or NIS users within it as strange conflicts can occur otherwise. Default: __winbind uid = __ Example: __winbind uid = 10000-20000__ __wins hook (G)__ When Samba is running as a WINS server this allows you to call an external program for all changes to the WINS database. The primary use for this option is to allow the dynamic update of external name resolution databases such as dynamic DNS. The wins hook parameter specifies the name of a script or executable that will be called as follows: __wins_hook operation name nametype ttl IP_list__ The first argument is the operation and is one of The second argument is the NetBIOS name. If the name is not a legal name then the wins hook is not called. Legal names contain only letters, digits, hyphens, underscores and periods. The third argument is the NetBIOS name type as a 2 digit hexadecimal number. The fourth argument is the TTL (time to live) for the name in seconds. The fifth and subsequent arguments are the IP addresses currently registered for that name. If this list is empty then the name should be deleted. An example script that calls the BIND dynamic DNS update program __nsupdate__ is provided in the examples directory of the Samba source code. __wins proxy (G)__ This is a boolean that controls if nmbd(8)will respond to broadcast name queries on behalf of other hosts. You may need to set this to yes for some older clients. Default: __wins proxy = no__ __wins server (G)__ This specifies the IP address (or DNS name: IP address for preference) of the WINS server that nmbd(8)should register with. If you have a WINS server on your network then you should set this to the WINS server's IP. You should point this at your WINS server if you have a multi-subnetted network. __NOTE__. You need to set up Samba to point to a WINS server if you have multiple subnets and wish cross-subnet browsing to work correctly. See the documentation file ''BROWSING.txt'' in the docs/ directory of your Samba source distribution. Default: __not enabled__ Example: __wins server = 192.9.200.1__ __wins support (G)__ This boolean controls if the nmbd(8)process in Samba will act as a WINS server. You should not set this to true unless you have a multi-subnetted network and you wish a particular __nmbd__ to be your WINS server. Note that you should __NEVER__ set this to true on more than one machine in your network. Default: __wins support = no__ __workgroup (G)__ This controls what workgroup your server will appear to be in when queried by clients. Note that this parameter also controls the Domain name used with the __security = domain__ setting. Default: __set at compile time to WORKGROUP__ Example: __workgroup = MYGROUP__ __writable (S)__ Synonym for ''writeable'' for people who can't spell :-). __write cache size (S)__ If this integer parameter is set to non-zero value, Samba will create an in-memory cache for each oplocked file (it does __not__ do this for non-oplocked files). All writes that the client does not request to be flushed directly to disk will be stored in this cache if possible. The cache is flushed onto disk when a write comes in whose offset would not fit into the cache or when the file is closed by the client. Reads for the file are also served from this cache if the data is stored within it. This cache allows Samba to batch client writes into a more efficient write size for RAID disks (i.e. writes may be tuned to be the RAID stripe size) and can improve performance on systems where the disk subsystem is a bottleneck but there is free memory for userspace programs. The integer parameter specifies the size of this cache (per oplocked file) in bytes. Default: __write cache size = 0__ Example: __write cache size = 262144__ for a 256k cache size per file. __write list (S)__ This is a list of users that are given read-write access to a service. If the connecting user is in this list then they will be given write access, no matter what the ''writeable'' option is set to. The list can include group names using the @group syntax. Note that if a user is in both the read list and the write list then they will be given write access. See also the ''read list'' option. Default: __write list = __ Example: __write list = admin, root, @staff__ __write ok (S)__ Synonym for ''writeable''. __write raw (G)__ This parameter controls whether or not the server will support raw write SMB's when transferring data from clients. You should never need to change this parameter. Default: __write raw = yes__ __writeable (S)__ An inverted synonym is ''read only''. If this parameter is no, then users of a service may not create or modify files in the service's directory. Note that a printable service (__printable = yes__) will __ALWAYS__ allow writing to the directory (user privileges permitting), but only via spooling operations. Default: __writeable = no__ !!WARNINGS Although the configuration file permits service names to contain spaces, your client software may not. Spaces will be ignored in comparisons anyway, so it shouldn't be a problem - but be aware of the possibility. On a similar note, many clients - especially DOS clients - limit service names to eight characters. smbd(8) has no such limitation, but attempts to connect from such clients will fail if they truncate the service names. For this reason you should probably keep your service names down to eight characters in length. Use of the [[homes] and [[printers] special sections make life for an administrator easy, but the various combinations of default attributes can be tricky. Take extreme care when designing these sections. In particular, ensure that the permissions on spool directories are correct. !!VERSION This man page is correct for version 2.2 of the Samba suite. !!SEE ALSO samba(7), __smbpasswd(8)__, __swat(8)__, __smbd(8)__, __nmbd(8)__, __smbclient(1)__, __nmblookup(1)__, __testparm(1)__, __testprns(1)__ !!AUTHOR The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at ftp://ftp.icce.rug.nl/pub/unix/ ----
14 pages link to
smb.conf(5)
:
nmbd(8)
smbclient(1)
smbd(8)
Man5s
rpcclient(1)
lmhosts(5)
make_smbcodepage(1)
make_unicodemap(1)
nmblookup(1)
smbpasswd(5)
smbpasswd(8)
smbstatus(1)
smbtar(1)
testparm(1)
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
