Documented -b for brief option.
[samba.git] / docs / INSTALL.txt
1 HOW TO INSTALL AND TEST SAMBA
2 =============================
3
4
5 STEP 0. Read the man pages. They contain lots of useful info that will
6 help to get you started. If you don't know how to read man pages then
7 try something like:
8
9         nroff -man smbd.8 | more
10
11 Unfortunately, having said this, the man pages are sadly out of date and
12 really need more effort to maintain them. Other sources of information 
13 are pointed to by the Samba web site, http://samba.canberra.edu.au/pub/samba.
14
15 STEP 1. Building the binaries
16
17 To do this, first edit the file source/Makefile. You will find that
18 the Makefile has an entry for most unixes and you need to uncomment
19 the one that matches your operating system.
20
21 You should also edit the section at the top of the Makefile which
22 determines where things will be installed. You need to get this right
23 before compilation as Samba needs to find some things at runtime
24 (smbrun in particular). There are also settings for where you want
25 your log files etc. Make sure you get these right, and that the
26 directories exist.
27
28 Then type "make". This will create the binaries.
29
30 Once it's successfully compiled you can use "make install" to install
31 the binaries and manual pages. You can separately install the binaries
32 and/or man pages using "make installbin" and "make installman".
33
34 Note that if you are upgrading for a previous version of Samba you
35 might like to know that the old versions of the binaries will be
36 renamed with a ".old" extension. You can go back to the previous
37 version with "make revert" if you find this version a disaster!
38
39 STEP 2. The all important step
40
41 At this stage you must fetch yourself a coffee or other drink you find
42 stimulating. Getting the rest of the install right can sometimes be
43 tricky, so you will probably need it.
44
45 If you have installed samba before then you can skip this step.
46
47 STEP 3. Create the smb configuration file. 
48
49 There are sample configuration files in the examples subdirectory in
50 the distribution. I suggest you read them carefully so you can see how
51 the options go together in practice. See the man page for all the
52 options.
53
54 The simplest useful configuration file would be something like this:
55
56    workgroup = MYGROUP
57
58    [homes]
59       guest ok = no
60       read only = no
61
62 which would allow connections by anyone with an account on the server,
63 using either their login name or "homes" as the service name. (Note
64 that I also set the workgroup that Samba is part of. See BROWSING.txt
65 for defails)
66
67 Note that "make install" will not install a smb.conf file. You need to
68 create it yourself. You will also need to create the path you specify
69 in the Makefile for the logs etc, such as /usr/local/samba.
70
71 Make sure you put the smb.conf file in the same place you specified in
72 the Makefile.
73
74 STEP 4. Test your config file with testparm
75
76 It's important that you test the validity of your smb.conf file using
77 the testparm program. If testparm runs OK then it will list the loaded
78 services. If not it will give an error message.
79
80 Make sure it runs OK and that the services look resonable before
81 proceeding. 
82
83 STEP 5. Starting the smbd and nmbd. 
84
85 You must choose to start smbd and nmbd either as daemons or from
86 inetd. Don't try to do both!  Either you can put them in inetd.conf
87 and have them started on demand by inetd, or you can start them as
88 daemons either from the command line or in /etc/rc.local. See the man
89 pages for details on the command line options.
90
91 The main advantage of starting smbd and nmbd as a daemon is that they
92 will respond slightly more quickly to an initial connection
93 request. This is, however, unlilkely to be a problem.
94
95 Step 5a. Starting from inetd.conf
96
97 NOTE; The following will be different if you use NIS or NIS+ to
98 distributed services maps.
99
100 Look at your /etc/services. What is defined at port 139/tcp. If
101 nothing is defined then add a line like this:
102
103 netbios-ssn     139/tcp
104
105 similarly for 137/udp you should have an entry like:
106
107 netbios-ns      137/udp
108
109 Next edit your /etc/inetd.conf and add two lines something like this:
110
111 netbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd smbd 
112 netbios-ns dgram udp wait root /usr/local/samba/bin/nmbd nmbd 
113
114 The exact syntax of /etc/inetd.conf varies between unixes. Look at the
115 other entries in inetd.conf for a guide.
116
117 NOTE: Some unixes already have entries like netbios_ns (note the
118 underscore) in /etc/services. You must either edit /etc/services or
119 /etc/inetd.conf to make them consistant.
120
121 NOTE: On many systems you may need to use the "interfaces" option in
122 smb.conf to specify the IP address and netmask of your interfaces. Run
123 ifconfig as root if you don't know what the broadcast is for your
124 net. nmbd tries to determine it at run time, but fails on some
125 unixes. See the section on "testing nmbd" for a method of finding if
126 you need to do this.
127
128 !!!WARNING!!! Many unixes only accept around 5 parameters on the
129 command line in inetd. This means you shouldn't use spaces between the
130 options and arguments, or you should use a script, and start the
131 script from inetd.
132
133 Restart inetd, perhaps just send it a HUP. If you have installed an
134 earlier version of nmbd then you may need to kill nmbd as well.
135
136 Step 5b. Alternative: starting it as a daemon
137
138 To start the server as a daemon you should create a script something
139 like this one, perhaps calling it "startsmb"
140
141 #!/bin/sh
142 /usr/local/samba/bin/smbd -D 
143 /usr/local/samba/bin/nmbd -D 
144
145 then make it executable with "chmod +x startsmb"
146
147 You can then run startsmb by hand or execute it from /etc/rc.local
148
149 To kill it send a kill signal to the processes nmbd and smbd.
150
151 NOTE: If you use the SVR4 style init system then you may like to look
152 at the examples/svr4-startup script to make Samba fit into that system.
153
154
155 STEP 7. Try listing the shares available on your server
156
157 smbclient -L yourhostname 
158
159 Your should get back a list of shares available on your server. If you
160 don't then something is incorrectly setup. Note that this method can
161 also be used to see what shares are available on other LanManager
162 clients (such as WfWg).
163
164 If you choose user level security then you may find that Samba requests
165 a password before it will list the shares. See the smbclient docs for
166 details. (you can force it to list the shares without a password by
167 adding the option -U% to the command line. This will not work with
168 non-Samba servers)
169
170 STEP 8. try connecting with the unix client. eg:
171
172 smbclient '\\yourhostname\aservice'
173
174 Typically the "yourhostname" would be the name of the host where you
175 installed smbd. The "aservice" is any service you have defined in the
176 smb.conf file. Try your user name if you just have a [homes] section
177 in smb.conf.
178
179 For example if your unix host is bambi and your login name is fred you
180 would type:
181
182 smbclient '\\bambi\fred'
183
184 NOTE: The number of slashes to use depends on the type of shell you
185 use. You may need '\\\\bambi\\fred' with some shells.
186
187 STEP 9. Try connecting from a dos/WfWg/Win95/NT/os-2 client. Try
188 mounting disks. eg:
189
190 net use d: \\servername\service
191
192 Try printing. eg:
193
194 net use lpt1: \\servername\spoolservice
195 print filename
196
197 Celebrate, or send me a bug report!
198
199 WHAT IF IT DOESN'T WORK?
200 ========================
201
202 If nothing works and you start to think "who wrote this pile of trash"
203 then I suggest you do step 2 again (and again) till you calm down.
204
205 Then you might read the file DIAGNOSIS.txt and the FAQ. If you are
206 still stuck then try the mailing list or newsgroup (look in the README
207 for details). Samba has been successfully installed at thousands of
208 sites worldwide, so maybe someone else has hit your problem and has
209 overcome it. You could also use the WWW site to scan back issues of
210 the samba-digest.
211
212 When you fix the problem PLEASE send me some updates to the
213 documentation (or source code) so that the next person will find it
214 easier. 
215
216 DIAGNOSING PROBLEMS
217 ===================
218
219 If you have instalation problems then go to DIAGNOSIS.txt to try to
220 find the problem.
221
222 SCOPE IDs
223 =========
224
225 By default Samba uses a blank scope ID. This means all your windows
226 boxes must also have a blank scope ID. If you really want to use a
227 non-blank scope ID then you will need to use the -i <scope> option to
228 nmbd, smbd, and smbclient. All your PCs will need to have the same
229 setting for this to work. I do not recommend scope IDs.
230
231
232 CHOOSING THE PROTOCOL LEVEL
233 ===========================
234
235 The SMB protocol has many dialects. Currently Samba supports 5, called
236 CORE, COREPLUS, LANMAN1, LANMAN2 and NT1.
237
238 You can choose what maximum protocol to support in the smb.conf
239 file. The default is NT1 and that is the best for the vast majority of
240 sites.
241
242 In older versions of Samba you may have found it necessary to use
243 COREPLUS. The limitations that led to this have mostly been fixed. It
244 is now less likely that you will want to use less than LANMAN1. The
245 only remaining advantage of COREPLUS is that for some obscure reason
246 WfWg preserves the case of passwords in this protocol, whereas under
247 LANMAN1, LANMAN2 or NT1 it uppercases all passwords before sending them,
248 forcing you to use the "password level=" option in some cases.
249
250 The main advantage of LANMAN2 and NT1 is support for long filenames with some
251 clients (eg: smbclient, Windows NT or Win95). 
252
253 See the smb.conf manual page for more details.
254
255 Note: To support print queue reporting you may find that you have to
256 use TCP/IP as the default protocol under WfWg. For some reason if you
257 leave Netbeui as the default it may break the print queue reporting on
258 some systems. It is presumably a WfWg bug.
259
260
261 PRINTING FROM UNIX TO A CLIENT PC
262 =================================
263
264 To use a printer that is available via a smb-based server from a unix
265 host you will need to compile the smbclient program. You then need to
266 install the script "smbprint". Read the instruction in smbprint for
267 more details.
268
269 There is also a SYSV style script that does much the same thing called
270 smbprint.sysv. It contains instructions.
271
272
273 LOCKING
274 =======
275
276 One area which sometimes causes trouble is locking.
277
278 There are two types of locking which need to be performed by a SMB
279 server. The first is "record locking" which allows a client to lock a
280 range of bytes in a open file. The second is the "deny modes" that are
281 specified when a file is open.
282
283 Samba supports "record locking" using the fcntl() unix system
284 call. This is often implemented using rpc calls to a rpc.lockd process
285 running on the system that owns the filesystem. Unfortunately many
286 rpc.lockd implementations are very buggy, particularly when made to
287 talk to versions from other vendors. It is not uncommon for the
288 rpc.lockd to crash.
289
290 There is also a problem translating the 32 bit lock requests generated
291 by PC clients to 31 bit requests supported by most
292 unixes. Unfortunately many PC applications (typically OLE2
293 applications) use byte ranges with the top bit set as semaphore
294 sets. Samba attempts translation to support these types of
295 applications, and the translation has proved to be quite successful.
296
297 Strictly a SMB server should check for locks before every read and
298 write call on a file. Unfortunately with the way fcntl() works this
299 can be slow and may overstress the rpc.lockd. It is also almost always
300 unnecessary as clients are supposed to independently make locking
301 calls before reads and writes anyway if locking is important to
302 them. By default Samba only makes locking calls when explicitly asked
303 to by a client, but if you set "strict locking = yes" then it will
304 make lock checking calls on every read and write. 
305
306 You can also disable by range locking completely using "locking =
307 no". This is useful for those shares that don't support locking or
308 don't need it (such as cdroms). In this case Samba fakes the return
309 codes of locking calls to tell clients that everything is OK.
310
311 The second class of locking is the "deny modes". These are set by an
312 application when it opens a file to determine what types of access
313 should be allowed simultaneously with it's open. A client may ask for
314 DENY_NONE, DENY_READ, DENY_WRITE or DENY_ALL. There are also special
315 compatability modes called DENY_FCB and DENY_DOS.
316
317 You can disable share modes using "share modes = no". This may be
318 useful on a heavily loaded server as the share modes code is very
319 slow. See also the FAST_SHARE_MODES option in the Makefile for a way
320 to do full share modes very fast using shared memory (if your OS
321 supports it).
322
323
324 MAPPING USERNAMES
325 =================
326
327 If you have different usernames on the PCs and the unix server then
328 take a look at the "username map" option. See the smb.conf man page
329 for details.
330
331
332 OTHER CHARACTER SETS
333 ====================
334
335 If you have problems using filenames with accented characters in them
336 (like the German, French or Scandinavian character sets) then I
337 recommmend you look at the "valid chars" option in smb.conf and also
338 take a look at the validchars package in the examples directory.