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