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