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