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