docs: Remove referenece to old Red Hat Linux habits on winbindd
[metze/samba/wip.git] / docs-xml / Samba3-HOWTO / TOSHARG-Compiling.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE chapter PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <chapter id="compiling">
4 <chapterinfo>
5         &author.jelmer;
6         &author.jht;
7         &author.tridge;
8         
9         <pubdate> 22 May 2001 </pubdate>
10         <pubdate> 18 March 2003 </pubdate>
11         <pubdate> June 2005 </pubdate>
12 </chapterinfo>
13
14 <title>How to Compile Samba</title>
15
16 <para>
17 You can obtain the Samba source file from the
18 <ulink url="http://samba.org/">Samba Web site</ulink>. To obtain a development version, 
19 you can download Samba from Subversion or using <command>rsync</command>.
20 </para>
21
22 <sect1>
23 <title>Access Samba Source Code via GIT</title>
24
25
26 <sect2>
27 <title>Introduction</title>
28
29 <para>
30 <indexterm><primary>Subversion</primary></indexterm>
31 Samba is developed in an open environment. Developers use
32 GIT to <quote>checkin</quote> (also known as 
33 <quote>commit</quote>) new source code.  See the
34 <ulink noescape="1"
35        url="https://wiki.samba.org/index.php/Using_Git_for_Samba_Development">Using
36 Git for Samba Development page</ulink> in the Samba wiki.
37 </para>
38
39 </sect2>
40
41
42 </sect1>
43
44 <sect1>
45         <title>Accessing the Samba Sources via rsync and ftp</title>
46
47
48         <para>
49         <indexterm><primary>rsync</primary></indexterm>
50         <indexterm><primary>ftp</primary></indexterm>
51         <parameter>pserver.samba.org</parameter> also exports unpacked copies of most parts of the Subversion tree
52         at the Samba <ulink noescape="1" url="ftp://samba.org/pub/unpacked">unpacked</ulink> location and also
53         via anonymous rsync at the Samba <ulink noescape="1"
54         url="rsync://samba.org/ftp/unpacked/">rsync</ulink> server location.  I recommend using rsync rather
55         than ftp, because rsync is capable of compressing data streams, but it is also more useful than FTP because
56         during a partial update it will transfer only the data that is missing plus a small overhead.  See <ulink
57         noescape="1" url="http://rsync.samba.org/">the rsync home page</ulink> for more info on rsync.
58         </para>
59
60         <para>
61         The disadvantage of the unpacked trees is that they do not support automatic
62         merging of local changes as GIT does. <command>rsync</command> access is most convenient 
63         for an initial install.                      
64         </para>
65 </sect1>
66
67 <sect1>
68 <title>Verifying Samba's PGP Signature</title>
69
70 <para>
71 <indexterm><primary>GPG</primary></indexterm>
72 <indexterm><primary>PGP</primary></indexterm>
73 It is strongly recommended that you verify the PGP signature for any source file before
74 installing it. Even if you're not downloading from a mirror site, verifying PGP signatures
75 should be a standard reflex. Many people today use the GNU GPG tool set in place of PGP.
76 GPG can substitute for PGP.
77 </para>
78
79
80 <para>
81 With that said, go ahead and download the following files:
82 </para>
83
84 <para><screen>
85 &prompt;<userinput>wget http://samba.org/samba/ftp/samba-latest.tar.asc</userinput>
86 &prompt;<userinput>wget http://samba.org/samba/ftp/samba-latest.tar.gz</userinput>
87 &prompt;<userinput>wget http://samba.org/samba/ftp/samba-pubkey.asc</userinput>
88 </screen></para>
89
90
91 <para>
92 <indexterm><primary>PGP</primary></indexterm>
93 The first file is the PGP signature for the Samba source file; the other is the Samba public
94 PGP key itself. Import the public PGP key with:
95 <screen>
96 &prompt;<userinput>gpg --import samba-pubkey.asc</userinput>
97 </screen>
98 and verify the Samba source code integrity with:
99 <screen>
100 &prompt;<userinput>gzip -d samba-latest.tar.gz</userinput>
101 &prompt;<userinput>gpg --verify samba-latest.tar.asc</userinput>
102 </screen>
103 </para>
104
105 <para>
106 If you receive a message like, <quote>Good signature from Samba Distribution Verification Key...,</quote>
107 then all is well. The warnings about trust relationships can be ignored. An
108 example of what you would not want to see would be:
109 <screen>
110 gpg: BAD signature from <quote>Samba Distribution Verification Key</quote>
111 </screen>
112 </para>
113
114 </sect1>
115
116 <sect1>
117         <title>Building the Binaries</title>
118         
119         <para>
120         <indexterm><primary>configure</primary></indexterm>
121         To build the binaries, run the program <userinput>./configure
122         </userinput> in the top level director of the source tree. This should automatically 
123         configure Samba for your operating system. If you have unusual 
124         needs, then you may wish to first run:
125 <screen>
126 &rootprompt;<userinput>./configure --help</userinput>
127 </screen>
128 </para>
129         
130         <para>
131         This will help you to see what special options can be enabled. Now execute
132         <userinput>./configure</userinput> with any arguments it might need:
133 <screen>
134 &rootprompt;<userinput>./configure <replaceable>[... arguments ...]</replaceable></userinput>
135 </screen>
136         </para>
137         
138         <para>
139         <indexterm><primary>make</primary></indexterm>
140         Execute the following create the binaries:
141 <screen>
142 &rootprompt; <userinput>make</userinput>
143 </screen>
144         Once it is successfully compiled, you can execute the command shown here to
145         install the binaries and manual pages:
146 <screen>
147 &rootprompt; <userinput>make install</userinput>
148 </screen>
149         </para>
150         
151         <sect2>
152         <title>Compiling Samba with Active Directory Support</title>
153         
154         <para>
155         In order to compile Samba with ADS support, you need to have installed
156         on your system:
157         </para>
158
159         <itemizedlist>
160         
161             <listitem><para>
162                 The MIT or Heimdal Kerberos development libraries
163             (either install from the sources or use a package).
164                 </para></listitem>
165         
166             <listitem><para>
167                 The OpenLDAP development libraries.
168                 </para></listitem>
169             
170         </itemizedlist>
171
172         <para>
173         If your Kerberos libraries are in a nonstandard location, then
174         remember to add the configure option
175         <option>--with-krb5=<replaceable>DIR</replaceable></option>.
176         </para>
177
178         <para>
179         After you run configure, make sure that the 
180         <filename>bin/include/config.h</filename> it generates contain lines like this:
181 <programlisting>
182 #define HAVE_KRB5 1
183 #define HAVE_LDAP 1
184 </programlisting>
185         </para>
186
187         <para>
188         If it does not, configure did not find your KRB5 libraries or
189         your LDAP libraries. Look in <filename>config.log</filename> to figure
190         out why and fix it.
191         </para>
192
193         <sect3>
194         <title>Installing the Required Packages for Debian</title>
195
196         <para>On Debian, you need to install the following packages:</para>
197         <para>
198                 <itemizedlist>
199                         <listitem><para>libkrb5-dev</para></listitem>
200                         <listitem><para>krb5-user</para></listitem>
201                 </itemizedlist>
202         </para>
203         </sect3>
204
205         <sect3>
206         <title>Installing the Required Packages for Red Hat Linux</title>
207
208         <para>On Red Hat Linux, this means you should have at least: </para>
209         <para>
210                 <itemizedlist>
211                         <listitem><para>krb5-workstation (for kinit)</para></listitem>
212                         <listitem><para>krb5-libs (for linking with)</para></listitem>
213                         <listitem><para>krb5-devel (because you are compiling from source)</para></listitem>
214                 </itemizedlist>
215         </para>
216
217         <para>in addition to the standard development environment.</para>
218
219         <para>If these files are not installed on your system, you should check the installation
220         CDs to find which has them and install the files using your tool of choice. If in doubt
221         about what tool to use, refer to the Red Hat Linux documentation.</para>
222
223         </sect3>
224
225         <sect3>
226         <title>SuSE Linux Package Requirements</title>
227
228         <para>
229         SuSE Linux installs Heimdal packages that may be required to allow you to build
230         binary packages. You should verify that the development libraries have been installed on
231         your system.
232         </para>
233
234         <para>
235         SuSE Linux Samba RPMs support Kerberos. Please refer to the documentation for
236         your SuSE Linux system for information regarding SuSE Linux specific configuration.
237         Additionally, SuSE is very active in the maintenance of Samba packages that provide
238         the maximum capabilities that are available. You should consider using SuSE-provided
239         packages where they are available.
240         </para>
241
242         </sect3>
243         
244         </sect2>
245                           
246 </sect1>
247
248 <sect1 id="startingSamba">
249         <title>Starting the &smbd; &nmbd; and &winbindd;</title>
250
251
252         <para>
253         <indexterm><primary>inetd</primary></indexterm>
254         You must choose to start &smbd;, &winbindd;  and &nmbd; either as daemons or from
255         <application>inetd</application>. Don't try to do both!  Either you can put
256         them in <filename> inetd.conf</filename> and have them started on demand by
257         <application>inetd</application> or <application>xinetd</application>, or you
258         can start them as daemons either from the command-line or in
259         <filename>/etc/rc.local</filename>. See the man pages for details on the
260         command line options. Take particular care to read the bit about what user
261         you need to have to start Samba. In many cases, you must be root.
262         </para>
263
264         <para>
265         The main advantage of starting &smbd; and &nmbd; using the recommended daemon method
266         is that they will respond slightly more quickly to an initial connection request.
267         </para>
268
269         <sect2>
270         <title>Starting from inetd.conf</title>
271
272         <indexterm><primary>inetd</primary></indexterm>
273         
274         <note>
275         <para>The following will be different if 
276         you use NIS, NIS+, or LDAP to distribute services maps.</para>
277         </note>
278         
279         <para>Look at your <filename>/etc/services</filename>. 
280         What is defined at port 139/tcp? If nothing is defined, 
281         then add a line like this:</para>
282
283         <para><programlisting>netbios-ssn     139/tcp</programlisting></para>
284
285         <para>Similarly for 137/udp, you should have an entry like:</para>
286
287         <para><programlisting>netbios-ns        137/udp</programlisting></para>
288
289         <para>
290         Next, edit your <filename>/etc/inetd.conf</filename> and add two lines like this:
291 <programlisting>
292 netbios-ssn stream tcp nowait root /usr/local/samba/sbin/smbd smbd 
293 netbios-ns dgram udp wait root /usr/local/samba/sbin/nmbd nmbd 
294 </programlisting>
295         </para>
296
297 <indexterm><primary>/etc/inetd.conf</primary></indexterm>
298         <para>
299         The exact syntax of <filename>/etc/inetd.conf</filename> 
300         varies between UNIXes. Look at the other entries in inetd.conf 
301         for a guide.
302         </para>
303
304         <para>
305         <indexterm><primary>xinetd</primary></indexterm>
306         Some distributions use xinetd instead of inetd. Consult the 
307         xinetd manual for configuration information.
308         </para>
309
310         <note><para>Some UNIXes already have entries like netbios_ns 
311         (note the underscore) in <filename>/etc/services</filename>. 
312         You must edit <filename>/etc/services</filename> or
313         <filename>/etc/inetd.conf</filename> to make them consistent.
314         </para></note>
315
316         <note><para>
317         <indexterm><primary>ifconfig</primary></indexterm>
318         On many systems you may need to use the
319         <smbconfoption name="interfaces"/> option in &smb.conf; to specify
320         the IP address and netmask of your interfaces. Run 
321         <application>ifconfig</application> as root if you do
322         not know what the broadcast is for your net. &nmbd; tries
323         to determine it at runtime, but fails on some UNIXes. 
324         </para></note>
325
326         <warning><para>
327         Many UNIXes only accept around five parameters on the command
328         line in <filename>inetd.conf</filename>.  This means you shouldn't
329         use spaces between the options and arguments, or you should use
330         a script and start the script from <command>inetd</command>.
331         </para></warning>
332
333         <para>
334         Restart <application>inetd</application>, perhaps just send it a HUP,
335         like this:
336 <indexterm><primary>killall</primary></indexterm>
337 <screen>
338 &rootprompt;<userinput>killall -HUP inetd</userinput>
339 </screen>
340         </para>
341                 
342         </sect2>
343         
344         <sect2>
345         <title>Alternative: Starting &smbd; as a Daemon</title>
346                 
347         <para>
348         <indexterm><primary>daemon</primary></indexterm>
349 <indexterm><primary>startsmb</primary></indexterm>
350         To start the server as a daemon, you should create a script something
351         like this one, perhaps calling it <filename>startsmb</filename>.
352         </para>
353
354 <para><programlisting>
355 #!/bin/sh
356 /usr/local/samba/sbin/smbd -D
357 /usr/local/samba/sbin/winbindd -D
358 /usr/local/samba/sbin/nmbd -D
359 </programlisting></para>
360
361         <para>
362         Make it executable with <command>chmod +x startsmb</command>.
363         </para>
364
365         <para>
366         You can then run <command>startsmb</command> by hand or execute
367         it from <filename>/etc/rc.local</filename>.
368         </para>
369
370         <para>
371         To kill it, send a kill signal to the processes &nmbd; and &smbd;.
372         </para>
373
374         <note><para>
375         If you use the SVR4-style init system, you may like to look at the
376         <filename>examples/svr4-startup</filename> script to make Samba fit
377         into that system.
378         </para></note>
379
380         <sect3>
381         <title>Starting Samba for Red Hat Linux</title>
382         <para>
383         The process for starting Samba will now be outlined. Be sure to configure Samba's &smb.conf;
384         file before starting Samba. When configured, start Samba by executing:
385 <screen>
386 &rootprompt; service smb start
387 &rootprompt; service winbind start
388 </screen>
389         These steps will start &nmbd;, &smbd; and &winbindd;.
390         </para>
391
392         <para>
393         To ensure that these services will be automatically restarted when the system is rebooted
394         execute:
395 <screen>
396 &rootprompt; chkconfig smb on
397 &rootprompt; chkconfig winbind on
398 </screen>
399         Samba will be started automatically at every system reboot.
400         </para>
401
402         </sect3>
403
404         <sect3>
405         <title>Starting Samba for Novell SUSE Linux</title>
406
407         <para>
408         Novell SUSE Linux products automatically install all essential Samba components in a default installation.
409         Configure your &smb.conf; file, then execute the following to start Samba:
410 <screen>
411 &rootprompt; rcnmb start
412 &rootprompt; rcsmb start
413 &rootprompt; rcwinbind start
414 </screen>
415         Now execute these commands so that Samba will be started automatically following a system
416         reboot:
417 <screen>
418 &rootprompt; chkconfig nmb on
419 &rootprompt; chkconfig smb on
420 &rootprompt; chkconfig winbind on
421 </screen>
422         The Samba services will now be started automatically following a system reboot.
423         </para>
424
425         </sect3>
426
427         </sect2>
428
429 </sect1>
430
431 </chapter>