9e22093cfa30c19e24bc9bd7c73da17517d0593a
[samba.git] / docs / yodldocs / smbd.8.yo
1 mailto(samba-bugs@samba.anu.edu.au) 
2
3 manpage(smbd)(8)(23 Oct 1998)(Samba)(SAMBA)
4
5 label(NAME)
6 manpagename(smbd)(server to provide SMB/CIFS services to clients)
7
8 label(SYNOPSIS)
9 manpagesynopsis()
10
11 bf(smbd) [-D] [-a] [-o] [-d debuglevel] [-l log file] [-p port number]
12 [-O socket options] [-s configuration file] [-i scope] [-P] [-h]
13
14 label(DESCRIPTION)
15 manpagedescription()
16
17 This program is part of the bf(Samba) suite.
18
19 bf(smbd) is the server daemon that provides filesharing services to
20 Windows clients. The server provides filespace and printer services to
21 clients using the SMB (or CIFS) protocol. This is compatible with the
22 LanManager protocol, and can service LanManager clients.  These
23 include MSCLIENT 3.0 for DOS, Windows for Workgroups, Windows 95,
24 Windows NT, OS/2, DAVE for Macintosh, and smbfs for Linux.
25
26 An extensive description of the services that the server can provide
27 is given in the man page for the configuration file controlling the
28 attributes of those services (see bf(smb.conf (5))).  This man page
29 will not describe the services, but will concentrate on the
30 administrative aspects of running the server.
31
32 Please note that there are significant security implications to
33 running this server, and the bf(smb.conf (5)) manpage should be
34 regarded as mandatory reading before proceeding with installation.
35
36 A session is created whenever a client requests one. Each client gets
37 a copy of the server for each session. This copy then services all
38 connections made by the client during that session. When all
39 connections from its client are are closed, the copy of the server for
40 that client terminates.
41
42 The configuration file, and any files that it includes, are
43 automatically reloaded every minute, if they change.  You can force a
44 reload by sending a SIGHUP to the server.  Reloading the configuration
45 file will not affect connections to any service that is already
46 established.  Either the user will have to disconnect from the
47 service, or smbd killed and restarted.
48
49 label(OPTIONS)
50 manpageoptions()
51
52 startdit()
53
54 dit(bf(-D)) If specified, this parameter causes the server to operate as a
55 daemon. That is, it detaches itself and runs in the background,
56 fielding requests on the appropriate port. Operating the server as a
57 daemon is the recommended way of running smbd for servers that provide
58 more than casual use file and print services.
59
60 By default, the server will NOT operate as a daemon. 
61
62 dit(bf(-a)) If this parameter is specified, each new connection will
63 append log messages to the log file.  This is the default.
64
65 dit(bf(-o)) If this parameter is specified, the log files will be
66 overwritten when opened.  By default, the log files will be appended
67 to.
68
69 dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10.
70
71 The default value if this parameter is not specified is zero.
72
73 The higher this value, the more detail will be logged to the log files
74 about the activities of the server. At level 0, only critical errors
75 and serious warnings will be logged. Level 1 is a reasonable level for
76 day to day running - it generates a small amount of information about
77 operations carried out.
78
79 Levels above 1 will generate considerable amounts of log data, and
80 should only be used when investigating a problem. Levels above 3 are
81 designed for use only by developers and generate HUGE amounts of log
82 data, most of which is extremely cryptic.
83
84 dit(bf(-l log file)) If specified, em(logfile) specifies a log
85 filename into which informational and debug messages from the running
86 server will be logged. The log file generated is never removed by the
87 server although its size may be controlled by the url(bf(max log
88 size))(smb.conf.5.html#maxlogsize) option in the url(bf(smb.conf
89 (5)))(smb.conf.5.html) file.  The default log file name is specified
90 at compile time.
91
92 dit(bf(-O socket options)) See the url(bf(socket
93 options))(smb.conf.5.html#socketoptions) parameter in the
94 url(bf(smb.conf (5)))(smb.conf.5.html) file for details.
95
96 dit(bf(-p port number)) port number is a positive integer value.  The
97 default value if this parameter is not specified is 139.
98
99 This number is the port number that will be used when making
100 connections to the server from client software. The standard
101 (well-known) port number for the SMB over TCP is 139, hence the
102 default. If you wish to run the server as an ordinary user rather than
103 as root, most systems will require you to use a port number greater
104 than 1024 - ask your system administrator for help if you are in this
105 situation.
106
107 In order for the server to be useful by most clients, should you
108 configure it on a port other than 139, you will require port
109 redirection services on port 139, details of which are outlined in
110 rfc1002.txt section 4.3.5.
111
112 This parameter is not normally specified except in the above
113 situation.
114
115 dit(bf(-s configuration file)) The default configuration file name is
116 determined at compile time.
117
118 The file specified contains the configuration details required by the
119 server.  The information in this file includes server-specific
120 information such as what printcap file to use, as well as descriptions
121 of all the services that the server is to provide. See bf(smb.conf
122 (5)) for more information.
123
124 dit(bf(-i scope)) This specifies a NetBIOS scope that the server will use
125 to communicate with when generating NetBIOS names. For details on the
126 use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes
127 are em(very) rarely used, only set this parameter if you are the
128 system administrator in charge of all the NetBIOS systems you
129 communicate with.
130
131 dit(bf(-h)) Prints the help information (usage) for smbd.
132
133 dit(bf(-P)) Passive option. Causes smbd not to send any network traffic
134 out. Used for debugging by the developers only.
135
136 endit()
137
138 label(FILES)
139 manpagefiles()
140
141 bf(/etc/inetd.conf)
142
143 If the server is to be run by the inetd meta-daemon, this file must
144 contain suitable startup information for the meta-daemon. See the
145 section em(INSTALLATION) below.
146
147 bf(/etc/rc)
148
149 (or whatever initialisation script your system uses).
150
151 If running the server as a daemon at startup, this file will need to
152 contain an appropriate startup sequence for the server. See the
153 section em(INSTALLATION) below.
154
155 bf(/etc/services)
156
157 If running the server via the meta-daemon inetd, this file must
158 contain a mapping of service name (eg., netbios-ssn) to service port
159 (eg., 139) and protocol type (eg., tcp). See the section
160 em(INSTALLATION) below.
161
162 bf(/usr/local/samba/lib/smb.conf)
163
164 This is the default location of the em(smb.conf) server configuration
165 file. Other common places that systems install this file are
166 em(/usr/samba/lib/smb.conf) and em(/etc/smb.conf).
167
168 This file describes all the services the server is to make available
169 to clients. See bf(smb.conf (5)) for more information.
170
171 label(LIMITATIONS)
172 manpagesection(LIMITATIONS)
173
174 On some systems bf(smbd) cannot change uid back to root after a
175 setuid() call.  Such systems are called "trapdoor" uid systems. If you
176 have such a system, you will be unable to connect from a client (such
177 as a PC) as two different users at once. Attempts to connect the
178 second user will result in "access denied" or similar.
179
180 label(ENVIRONMENTVARIABLES)
181 manpagesection(ENVIRONMENT VARIABLES)
182
183 bf(PRINTER)
184
185 If no printer name is specified to printable services, most systems
186 will use the value of this variable (or "lp" if this variable is not
187 defined) as the name of the printer to use. This is not specific to
188 the server, however.
189
190 label(INSTALLATION)
191 manpagesection(INSTALLATION)
192
193  The location of the server and its support files is a matter for
194 individual system administrators. The following are thus suggestions
195 only.
196
197 It is recommended that the server software be installed under the
198 /usr/local/samba hierarchy, in a directory readable by all, writeable
199 only by root. The server program itself should be executable by all,
200 as users may wish to run the server themselves (in which case it will
201 of course run with their privileges).  The server should NOT be
202 setuid. On some systems it may be worthwhile to make smbd setgid to an
203 empty group. This is because some systems may have a security hole
204 where daemon processes that become a user can be attached to with a
205 debugger. Making the smbd file setgid to an empty group may prevent
206 this hole from being exploited. This security hole and the suggested
207 fix has only been confirmed on old versions (pre-kernel 2.0) of Linux
208 at the time this was written. It is possible that this hole only
209 exists in Linux, as testing on other systems has thus far shown them
210 to be immune.
211
212 The server log files should be put in a directory readable and
213 writable only by root, as the log files may contain sensitive
214 information.
215
216 The configuration file should be placed in a directory readable and
217 writable only by root, as the configuration file controls security for
218 the services offered by the server. The configuration file can be made
219 readable by all if desired, but this is not necessary for correct
220 operation of the server and is not recommended. A sample configuration
221 file "smb.conf.sample" is supplied with the source to the server -
222 this may be renamed to "smb.conf" and modified to suit your needs.
223
224 The remaining notes will assume the following:
225
226 startit()
227
228 it() bf(smbd) (the server program) installed in /usr/local/samba/bin
229
230 it() bf(smb.conf) (the configuration file) installed in /usr/local/samba/lib
231
232 it() log files stored in /var/adm/smblogs
233
234 endit()
235
236 The server may be run either as a daemon by users or at startup, or it
237 may be run from a meta-daemon such as inetd upon request. If run as a
238 daemon, the server will always be ready, so starting sessions will be
239 faster. If run from a meta-daemon some memory will be saved and
240 utilities such as the tcpd TCP-wrapper may be used for extra security.
241 For serious use as file server it is recommended that bf(smbd) be run
242 as a daemon.
243
244 When you've decided, continue with either em(RUNNING THE SERVER AS A
245 DAEMON) or em(RUNNING THE SERVER ON REQUEST).
246
247 label(RUNNINGTHESERVERASADAEMON)
248 manpagesection(RUNNING THE SERVER AS A DAEMON)
249
250 To run the server as a daemon from the command line, simply put the
251 bf(-D) option on the command line. There is no need to place an
252 ampersand at the end of the command line - the bf(-D) option causes
253 the server to detach itself from the tty anyway.
254
255 Any user can run the server as a daemon (execute permissions
256 permitting, of course). This is useful for testing purposes, and may
257 even be useful as a temporary substitute for something like ftp. When
258 run this way, however, the server will only have the privileges of the
259 user who ran it.
260
261 To ensure that the server is run as a daemon whenever the machine is
262 started, and to ensure that it runs as root so that it can serve
263 multiple clients, you will need to modify the system startup
264 files. Wherever appropriate (for example, in /etc/rc), insert the
265 following line, substituting port number, log file location,
266 configuration file location and debug level as desired:
267
268 tt(/usr/local/samba/bin/smbd -D -l /var/adm/smblogs/log -s /usr/local/samba/lib/smb.conf)
269
270 (The above should appear in your initialisation script as a single line. 
271 Depending on your terminal characteristics, it may not appear that way in
272 this man page. If the above appears as more than one line, please treat any 
273 newlines or indentation as a single space or TAB character.)
274
275 If the options used at compile time are appropriate for your system,
276 all parameters except the desired debug level and bf(-D) may be
277 omitted. See the section em(OPTIONS) above.
278
279 label(RUNNINGTHESERVERONREQUEST)
280 manpagesection(RUNNING THE SERVER ON REQUEST)
281
282  If your system uses a meta-daemon such as inetd, you can arrange to
283 have the smbd server started whenever a process attempts to connect to
284 it. This requires several changes to the startup files on the host
285 machine. If you are experimenting as an ordinary user rather than as
286 root, you will need the assistance of your system administrator to
287 modify the system files.
288
289 You will probably want to set up the NetBIOS name server bf(nmbd) at
290 the same time as bf(smbd). To do this refer to the man page for
291 bf(nmbd (8)).
292
293 First, ensure that a port is configured in the file /etc/services. The
294 well-known port 139 should be used if possible, though any port may be
295 used.
296
297 Ensure that a line similar to the following is in /etc/services:
298
299 tt(netbios-ssn  139/tcp)
300
301 Note for NIS/YP users - you may need to rebuild the NIS service maps
302 rather than alter your local /etc/services file.
303
304 Next, put a suitable line in the file /etc/inetd.conf (in the unlikely
305 event that you are using a meta-daemon other than inetd, you are on
306 your own). Note that the first item in this line matches the service
307 name in /etc/services.  Substitute appropriate values for your system
308 in this line (see bf(inetd (8))):
309
310 tt(netbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd -d1 -l/var/adm/smblogs/log -s/usr/local/samba/lib/smb.conf)
311
312 (The above should appear in /etc/inetd.conf as a single
313 line. Depending on your terminal characteristics, it may not appear
314 that way in this man page.  If the above appears as more than one
315 line, please treat any newlines or indentation as a single space or
316 TAB character.)
317
318 Note that there is no need to specify a port number here, even if you
319 are using a non-standard port number.
320
321 Lastly, edit the configuration file to provide suitable services. To
322 start with, the following two services should be all you need:
323
324 tt(
325 [homes]
326   writable = yes
327
328 [printers]
329  writable = no
330  printable = yes
331  path = /tmp
332  public = yes
333 )
334
335 This will allow you to connect to your home directory and print to any
336 printer supported by the host (user privileges permitting).
337
338 label(TESTINGTHEINSTALLATION)
339 manpagesection(TESTING THE INSTALLATION)
340
341 If running the server as a daemon, execute it before proceeding. If
342 using a meta-daemon, either restart the system or kill and restart the
343 meta-daemon. Some versions of inetd will reread their configuration
344 tables if they receive a HUP signal.
345
346 If your machine's name is "fred" and your name is "mary", you should
347 now be able to connect to the service tt(\\fred\mary).
348
349 To properly test and experiment with the server, we recommend using
350 the smbclient program (see bf(smbclient (1))) and also going through
351 the steps outlined in the file em(DIAGNOSIS.txt) in the em(docs/)
352 directory of your Samba installation.
353
354 label(VERSION)
355 manpagesection(VERSION)
356
357 This man page is correct for version 2.0 of the Samba suite.
358
359 label(DIAGNOSTICS)
360 manpagesection(DIAGNOSTICS)
361
362 Most diagnostics issued by the server are logged in a specified log
363 file. The log file name is specified at compile time, but may be
364 overridden on the command line.
365
366 The number and nature of diagnostics available depends on the debug
367 level used by the server. If you have problems, set the debug level to
368 3 and peruse the log files.
369
370 Most messages are reasonably self-explanatory. Unfortunately, at time
371 of creation of this man page there are too many diagnostics available
372 in the source code to warrant describing each and every diagnostic. At
373 this stage your best bet is still to grep the source code and inspect
374 the conditions that gave rise to the diagnostics you are seeing.
375
376 label(SIGNALS)
377 manpagesection(SIGNALS)
378
379 Sending the smbd a SIGHUP will cause it to re-load its smb.conf
380 configuration file within a short period of time.
381
382 To shut down a users smbd process it is recommended that SIGKILL (-9)
383 em(NOT) be used, except as a last resort, as this may leave the shared
384 memory area in an inconsistant state. The safe way to terminate an
385 smbd is to send it a SIGTERM (-15) signal and wait for it to die on
386 its own.
387
388 In version 1.9.18 and above the debug log level of smbd may be raised
389 by sending it a SIGUSR1 tt((kill -USR1 <smbd-pid>)) and lowered by
390 sending it a SIGUSR2 tt((kill -USR2 <smbd-pid>)). This is to allow
391 transient problems to be diagnosed, whilst still running at a normally
392 low log level.
393
394 Note that as the signal handlers send a debug write, they are not
395 re-entrant in smbd. This you should wait until smbd is in a state of
396 waiting for an incoming smb before issuing them. It is possible to
397 make the signal handlers safe by un-blocking the signals before the
398 select call and re-blocking them after, however this would affect
399 performance.
400
401 label(SEEALSO)
402 manpageseealso()
403
404 bf(hosts_access (5)), bf(inetd (8)), url(bf(nmbd (8)))(nmbd.8.html),
405 url(bf(smb.conf (5)))(smb.conf.html), url(bf(smbclient
406 (1)))(smbclient.1.html), url(bf(testparm (1)))(testparm.1.html),
407 url(bf(testprns (1)))(testprns.1.html), and the Internet RFC's
408 bf(rfc1001.txt), bf(rfc1002.txt). In addition the CIFS (formerly SMB)
409 specification is available as a link from the Web page :
410 url(http://samba.anu.edu.au/cifs/)(http://samba.anu.edu.au/cifs/).
411
412 label(AUTHOR)
413 manpageauthor()
414
415 The original Samba software and related utilities were created by
416 Andrew Tridgell (samba-bugs@samba.anu.edu.au). Samba is now developed
417 by the Samba Team as an Open Source project similar to the way the
418 Linux kernel is developed.
419
420 The original Samba man pages were written by Karl Auer. The man page
421 sources were converted to YODL format (another excellent piece of Open
422 Source software) and updated for the Samba2.0 release by Jeremy
423 Allison, email(samba-bugs@samba.anu.edu.au).
424
425 See url(bf(samba (7)))(samba.7.html) to find out how to get a full list of contributors
426 and details on how to submit bug reports, comments etc.