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