 |
Index for
Section 5 |
|
 |
Alphabetical
listing for S |
|
 |
Bottom of
page |
|
SMB.CONF(5)
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 .PP 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 "share"). The section name is the
name of the shared resource and the parameters within the section define
the shares attributes.
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 "user =" option in the share definition. For modern
clients such as Windows 95/98/ME/NT/2000, this should not be necessary.
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":
[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:
o+ The share name is changed from homes to the located username.
o+ 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 "homes", except
that the share name is not changed to that of the requesting user. This
method of using the [homes] section works well if different users share a
client PC.
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:
o+ The share name is set to the located printer name
o+ If no printer name was given, the printer name is set to the located
printer name
o+ 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 "printcap name = lpstat" to
automatically obtain a list of printers. See the "printcap name" option for
more details.
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 "path = /tmp/%u" would be interpreted
as "path = /tmp/john" if the user connected with the username john.
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 "dual
personality".
%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 "%N:%p".
%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 "UNKNOWN". If
it gets it wrong then sending a level 3 log to samba@samba.org
<URL:mailto:samba@samba.org> should allow it to be fixed.
%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 "name mangling" so that DOS and Windows clients can use
files that don't conform to the 8.3 format. It can also be set to adjust
the case of 8.3 format filenames.
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 "default"
case are mangled. For example, if this is yes then a name like "Mail"
would be mangled. Default 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 "default" case. Default 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 "default" case. This option can be use with
"preserve case = yes" to permit long filenames to retain their case,
while short names are lowercased. Default 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 "guest only = yes" then steps 1 to 5 are skipped.
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 \\server\service%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 "user = " field is given in the 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 "user =" field then the connection is made as the
username in the "user =" line. If one of the username in the "user ="
list begins with a '@' then that name expands to a list of names in
the group of the same name.
6. If the service is a guest service then a connection is made as the
username given in the "guest account =" for the service, irrespective
of the supplied password.
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.
o+ abort shutdown script
o+ add printer command
o+ add share command
o+ add user script
o+ add machine script
o+ allow trusted domains
o+ announce as
o+ announce version
o+ auto services
o+ bind interfaces only
o+ browse list
o+ change notify timeout
o+ change share command
o+ character set
o+ client code page
o+ code page directory
o+ coding system
o+ config file
o+ deadtime
o+ debug hires timestamp
o+ debug pid
o+ debug timestamp
o+ debug uid
o+ debuglevel
o+ default
o+ default service
o+ delete printer command
o+ delete share command
o+ delete user script
o+ dfree command
o+ disable spoolss
o+ dns proxy
o+ domain admin group
o+ domain guest group
o+ domain logons
o+ domain master
o+ encrypt passwords
o+ enhanced browsing
o+ enumports command
o+ getwd cache
o+ hide local users
o+ hide unreadable
o+ homedir map
o+ host msdfs
o+ hosts equiv
o+ interfaces
o+ keepalive
o+ kernel oplocks
o+ lanman auth
o+ large readwrite
o+ ldap admin dn
o+ ldap filter
o+ ldap port
o+ ldap server
o+ ldap ssl
o+ ldap suffix
o+ lm announce
o+ lm interval
o+ load printers
o+ local master
o+ lock dir
o+ lock directory
o+ log file
o+ log level
o+ logon drive
o+ logon home
o+ logon path
o+ logon script
o+ lpq cache time
o+ machine password timeout
o+ mangled stack
o+ map to guest
o+ max disk size
o+ max log size
o+ max mux
o+ max open files
o+ max protocol
o+ max smbd processes
o+ max ttl
o+ max wins ttl
o+ max xmit
o+ message command
o+ min passwd length
o+ min password length
o+ min protocol
o+ min wins ttl
o+ name resolve order
o+ netbios aliases
o+ netbios name
o+ netbios scope
o+ nis homedir
o+ nt pipe support
o+ nt smb support
o+ null passwords
o+ obey pam restrictions
o+ oplock break wait time
o+ os level
o+ os2 driver map
o+ pam password change
o+ panic action
o+ passwd chat
o+ passwd chat debug
o+ passwd program
o+ password level
o+ password server
o+ prefered master
o+ preferred master
o+ preload
o+ printcap
o+ printcap name
o+ printer driver file
o+ protocol
o+ read bmpx
o+ read raw
o+ read size
o+ remote announce
o+ remote browse sync
o+ restrict anonymous
o+ root
o+ root dir
o+ root directory
o+ security
o+ server string
o+ show add printer wizard
o+ shutdown script
o+ smb passwd file
o+ socket address
o+ socket options
o+ source environment
o+ ssl
o+ ssl CA certDir
o+ ssl CA certFile
o+ ssl ciphers
o+ ssl client cert
o+ ssl client key
o+ ssl compatibility
o+ ssl egd socket
o+ ssl entropy bytes
o+ ssl entropy file
o+ ssl hosts
o+ ssl hosts resign
o+ ssl require clientcert
o+ ssl require servercert
o+ ssl server cert
o+ ssl server key
o+ ssl version
o+ stat cache
o+ stat cache size
o+ strip dot
o+ syslog
o+ syslog only
o+ template homedir
o+ template shell
o+ time offset
o+ time server
o+ timestamp logs
o+ total print jobs
o+ unix extensions
o+ unix password sync
o+ update encrypted
o+ use mmap
o+ use rhosts
o+ username level
o+ username map
o+ utmp
o+ utmp directory
o+ valid chars
o+ winbind cache time
o+ winbind enum users
o+ winbind enum groups
o+ winbind gid
o+ winbind separator
o+ winbind uid
o+ wins hook
o+ wins proxy
o+ wins server
o+ wins support
o+ workgroup
o+ 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.
o+ admin users
o+ allow hosts
o+ available
o+ blocking locks
o+ browsable
o+ browseable
o+ case sensitive
o+ casesignames
o+ comment
o+ copy
o+ create mask
o+ create mode
o+ default case
o+ default devmode
o+ delete readonly
o+ delete veto files
o+ deny hosts
o+ directory
o+ directory mask
o+ directory mode
o+ directory security mask
o+ dont descend
o+ dos filemode
o+ dos filetime resolution
o+ dos filetimes
o+ exec
o+ fake directory create times
o+ fake oplocks
o+ follow symlinks
o+ force create mode
o+ force directory mode
o+ force directory security mode
o+ force group
o+ force security mode
o+ force user
o+ fstype
o+ group
o+ guest account
o+ guest ok
o+ guest only
o+ hide dot files
o+ hide files
o+ hosts allow
o+ hosts deny
o+ include
o+ inherit permissions
o+ invalid users
o+ level2 oplocks
o+ locking
o+ lppause command
o+ lpq command
o+ lpresume command
o+ lprm command
o+ magic output
o+ magic script
o+ mangle case
o+ mangled map
o+ mangled names
o+ mangling char
o+ map archive
o+ map hidden
o+ map system
o+ max connections
o+ max print jobs
o+ min print space
o+ msdfs root
o+ nt acl support
o+ only guest
o+ only user
o+ oplock contention limit
o+ oplocks
o+ path
o+ posix locking
o+ postexec
o+ postscript
o+ preexec
o+ preexec close
o+ preserve case
o+ print command
o+ print ok
o+ printable
o+ printer
o+ printer admin
o+ printer driver
o+ printer driver location
o+ printer name
o+ printing
o+ public
o+ queuepause command
o+ queueresume command
o+ read list
o+ read only
o+ root postexec
o+ root preexec
o+ root preexec close
o+ security mask
o+ set directory
o+ short preserve case
o+ status
o+ strict allocate
o+ strict locking
o+ strict sync
o+ sync always
o+ use client driver
o+ user
o+ username
o+ users
o+ valid users
o+ veto files
o+ veto oplock files
o+ vfs object
o+ vfs options
o+ volume
o+ wide links
o+ writable
o+ write cache size
o+ write list
o+ write ok
o+ 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 "Printers..." folder displayed a share
listing. The APW allows for printers to be add remotely to a Samba or
Windows NT/2000 print server.
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:
o+ printer name
o+ share name
o+ port name
o+ driver name
o+ location
o+ 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 "Windows 9x driver location"
parameter is included for backwards compatibility only. The remaining
fields in the structure are generated from answers to the APW questions.
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 .PP
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.
o+ configFile - the location of the global smb.conf file.
o+ shareName - the name of the new share.
o+ pathName - path to an **existing** directory on disk.
o+ 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 = <empty string> Example: add machine
script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s
/bin/false %u .TP 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 = <empty string> 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 : "NT Server" (which can also be written as
"NT"), "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
Windows NT Workstation, Windows 95 and Windows for Workgroups
respectively. Do not change this parameter unless you have a specific
need to stop Samba appearing as an NT server as this may prevent Samba
servers from participating as browser servers correctly.
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 "turn off" a service. If 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
"all addresses" interface (0.0.0.0) on ports 137 and 138 for the
purposes of reading broadcast messages. If this option is not set then
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 "not running" even
if they really are. This can prevent 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 "watch" a particular
directory for any changes and only reply to the SMB request when a
change has occurred. Such constant scanning of a directory is
expensive under UNIX, hence an 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.
o+ configFile - the location of the global smb.conf file.
o+ shareName - the name of the new share.
o+ pathName - path to an **existing** directory on disk.
o+ 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 "Printers..." folder as seen when browsing
the Samba host.
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:
o+ 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.
o+ 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.
o+ 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.
o+ 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.
o+ 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 = <empty string>
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 :
o+ Code Page 437 - MS-DOS Latin US
o+ Code Page 737 - Windows '95 Greek
o+ Code Page 850 - MS-DOS Latin 1
o+ Code Page 852 - MS-DOS Latin 2
o+ Code Page 861 - MS-DOS Icelandic
o+ Code Page 866 - MS-DOS Cyrillic
o+ Code Page 932 - MS-DOS Japanese SJIS
o+ Code Page 936 - MS-DOS Simplified Chinese
o+ Code Page 949 - MS-DOS Korean Hangul
o+ 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 .TP 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 :
o+ SJIS - Shift-JIS. Does no conversion of the incoming filename.
o+ 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.
o+ 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.
o+ JUNET, JUBB, JUBH, JU@B, JU@J, JU@H - Convert from incoming Shift-
JIS to JUNET code with different shift-in, shift out codes.
o+ EUC - Convert an incoming Shift-JIS character to EUC code.
o+ HEX - Convert an incoming Shift-JIS character to a 3 byte hex
representation, i.e. :AB.
o+ 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 = <empty value>
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 .TP copy (S)
This parameter allows you to "clone" service entries. The specified
service is simply duplicated under the current service's name. Any
parameters specified in the current section will override those in the
section being copied.
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 <URL:http://msdn.microsoft.com/>.
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 "_" characters in the name of the service used in
the default service will get mapped to a "/". This allows for
interesting things.
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: "printer name".
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 .TP 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.
o+ configFile - the location of the global smb.conf file.
o+ 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 = <empty string> 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 "Abort Retry
Ignore" at the end of each directory listing.
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" "$4}'
or perhaps (on Sys V based systems):
#!/bin/sh
/usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
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 "appliance" systems. Administrators of most normal systems
will probably want to leave it as the default of 0777.
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 "Domain Admins" group when a Samba host is acting
as a PDC. A complete solution will be provided by a system for mapping
Windows NT/2000 groups onto UNIX groups. Please note that this
parameter has a somewhat confusing name. It accepts a list of
usernames and of group names in standard 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 "Domain Guests" group when a Samba host is acting
as a PDC. A complete solution will be provided by a system for mapping
Windows NT/2000 groups onto UNIX groups. Please note that this
parameter has a somewhat confusing name. It accepts a list of
usernames and of group names in standard 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 "dont
descend" entries. For example you may need ./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 "port" is fairly foreign to UNIX hosts. Under Windows
NT/2000 print servers, a port is associated with a port monitor and
generally takes the form of a local port (i.e. LPT1:, COM1:, FILE:) or
a remote port (i.e. LPD Port Monitor, etc...). By default, Samba has
only one port defined--"Samba Printer Port". Under Windows NT/2000,
all printers must have a valid port name. If you wish to have a list
of ports displayed (smbd does not use a port name for anything) other
than the default "Samba Printer Port", you can define 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 .TP 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 "appliance" systems. Administrators of most normal systems
will probably want to leave it set as 0000.
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 "appliance" systems. Administrators of most normal systems
will probably want to leave this set to 0000.
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
"forced user", no matter what username the client connected as. This
can be very useful.
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 "ftp" is often a good choice for this
parameter. If a username is specified in a given service, the
specified username overrides this one.
One some systems the default guest account "nobody" may not be able to
print. Use another account in this case. You should test this by
trying to log in as your guest user (perhaps by using the su -
command) and trying to print using the system print command such as
lpr(1) or lp(1).
Default: specified at compile time, usually "nobody"
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 <URL:http://www.thursby.com> creates for
internal use, and also still hides all files beginning with a dot.
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)
Ifnis 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 = <empty string>
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 "foonet", but deny access
from one particular host
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 .TP 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 .TP 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 .TP 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:
o+ a network interface name (such as eth0). This may include shell-like
wildcards so eth* will match any interface starting with the
substring "eth"
o+ an IP address. In this case the netmask is determined from the list
of interfaces obtained from the kernel
o+ an IP/mask pair.
o+ a broadcast/mask pair.
The "mask" parameters can either be a bit length (such as 24 for a C class
network) or a full netmask in dotted decimal form.
The "IP" parameters above can either be a full dotted decimal IP address or
a hostname which will be looked up via the OS's normal hostname resolution
mechanisms.
For example, the following line:
interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0 .PP
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 '&' is interpreted only by
looking in the NIS netgroup database (this requires NIS to be working
on your system). The characters '+' and '&' may be used at the start
of the name in either order so the value +&group means check the UNIX
group database, followed by the NIS netgroup database, and the value
&+group 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 .TP 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 p