path: root/docs/docbook/projdoc/UNIX_INSTALL.xml

<chapter id="install">
<chapterinfo>
	&author.tridge;
	&author.jelmer;
	&author.jht;
	<author><firstname>Karl</firstname><surname>Auer</surname></author>
	<!-- Isn't some of this written by others as well? -->

</chapterinfo>

<title>How to Install and Test SAMBA</title>

<sect1>
	<title>Obtaining and installing samba</title>

	<para>
	Binary packages of samba are included in almost any Linux or
	UNIX distribution. There are also some packages available at 
	<ulink url="http://samba.org/">the samba homepage</ulink>.
	</para>

	<para>If you need to compile samba from source, check 
		<link linkend="compiling">the chapter about compiling samba from scratch</link>.</para>

	<para>If you have already installed samba, or if your operating system
	was pre-installed with samba, then you may not need to bother with this
	chapter. On the other hand, you may want to read this chapter anyhow
	for information about updating samba.</para>

</sect1>

<sect1>
	<title>Configuring samba (smb.conf)</title>

	<para>
	Samba's configuration is stored in the &smb.conf; file, 
	that usually resides in <filename>/etc/samba/smb.conf</filename> 
	or <filename>/usr/local/samba/lib/smb.conf</filename>. You can either 
	edit this file yourself or do it using one of the many graphical 
	tools that are available, such as the web-based interface swat, that 
	is included with samba.
	</para>
	
<sect2>
	<title>Example Configuration</title>
	
	<para>
	There are sample configuration files in the examples subdirectory in the
	distribution. I suggest you read them carefully so you can see how the options
	go together in practice. See the man page for all the options.
	</para>

	<para>
	The simplest useful configuration file would be something like this:
	</para>

	<para>
	<smbconfexample>
		<title>Simplest possible smb.conf file</title>
<smbconfsection>[global]</smbconfsection>
<smbconfoption><name>workgroup</name><value>&example.workgroup;</value></smbconfoption>

<smbconfsection>[homes]</smbconfsection>
<smbconfoption><name>guest ok</name><value>no</value></smbconfoption>
<smbconfoption><name>read only</name><value>no</value></smbconfoption>
	</smbconfexample>
	</para>
	
	<para>
	This will allow connections by anyone with an account on the server, using either
	their login name or <smbconfsection>homes</smbconfsection>" as the service name.
	(Note that the workgroup that Samba must also be set.)
	</para>
	
	<para>
	Make sure you put the &smb.conf; file in the correct place 
	(usually in <filename>/etc/samba</filename>).
	</para>

	<para>
	For more information about security settings for the 
	<smbconfsection>[homes]</smbconfsection> share please refer to 
	<link linkend="securing-samba">"Securing Samba"</link>.
	</para>

<sect3>
	<title>Test your config file with <command>testparm</command></title>

	<para>
	It's important that you test the validity of your &smb.conf;
	file using the &testparm; program. If testparm runs OK
	then it will list the loaded services. If not it will give an error message.
	</para>

	<para>
	Make sure it runs OK and that the services look reasonable before proceeding.
	</para>

	<para>
	Always run testparm again when you change &smb.conf;!
	</para>

</sect3>
</sect2>

<sect2>
	<title>SWAT</title>

	<para>
	SWAT is a web-based interface that helps you configure samba. 
	SWAT might not be available in the samba package on your platform, 
	but in a separate package. Please read the swat manpage 
	on compiling, installing and configuring swat from source.
	</para>

	<para>
	To launch SWAT just run your favorite web browser and 
	point it at <ulink url="http://localhost:901/" noescape="1">http://localhost:901/</ulink>. Replace
	<replaceable>localhost</replaceable>
	with the name of the computer you are running samba on if you 
	are running samba on a different computer than your browser.
	</para>

	<para>
	Note that you can attach to SWAT from any IP connected 
	machine but connecting from a remote machine leaves your 
	connection open to password sniffing as passwords will be sent 
	in the clear over the wire. 
	</para>
</sect2>
</sect1>

<sect1>
	<title>Try listing the shares available on your 
	server</title>

<para><screen>
&prompt;<userinput>smbclient -L <replaceable>yourhostname</replaceable></userinput>
</screen></para>

	<para>You should get back a list of shares available on 
	your server. If you don't then something is incorrectly setup. 
	Note that this method can also be used to see what shares 
	are available on other LanManager clients (such as WfWg).</para>

	<para>If you choose user level security then you may find 
	that Samba requests a password before it will list the shares. 
	See the <command>smbclient</command> man page for details. (you 
	can force it to list the shares without a password by
	adding the option -U% to the command line. This will not work 
	with non-Samba servers)</para>
</sect1>

<sect1>
	<title>Try connecting with the unix client</title>
	
	<para>
<screen>
&prompt;<userinput>smbclient <replaceable> //yourhostname/aservice</replaceable></userinput>
</screen></para>
	
	<para>Typically the <replaceable>yourhostname</replaceable> 
	would be the name of the host where you installed &smbd;. 
	The <replaceable>aservice</replaceable> is 
	any service you have defined in the &smb.conf;
	file. Try your user name if you just have a <smbconfsection>[homes]</smbconfsection>
	section
	in &smb.conf;.</para>

	<para>For example if your unix host is <replaceable>bambi</replaceable>
	and your login name is <replaceable>fred</replaceable> you would type:</para>

<para><screen>
&prompt;<userinput>smbclient //<replaceable>bambi</replaceable>/<replaceable>fred</replaceable></userinput>
</screen></para>
</sect1>

<sect1>
	<title>Try connecting from another SMB client</title>

	<para>Try mounting disks. from a DOS, Windows or OS/2 client, eg:</para>

	<para><screen>
&dosprompt;<userinput>net use d: \\servername\service</userinput>
</screen></para>

	<para>Try printing. eg:</para>

	<para>
<screen>
&dosprompt;<userinput>net use lpt1:	\\servername\spoolservice</userinput>
</screen></para>

<para>
<screen>&dosprompt;<userinput>print filename</userinput>
</screen></para>
</sect1>

<sect1>
	<title>What If Things Don't Work?</title>
	
	<para>Then you might read the file chapter <link linkend="diagnosis">diagnosis</link>
	and the FAQ. If you are still stuck then refer to <link linkend="problems">"Analysing and solving problems"</link>.
	Samba has been successfully installed at thousands of sites worldwide,
	so maybe someone else has hit your problem and has overcome it.</para>

</sect1>

<sect1>
<title>Common Errors</title>

<para>
The following questions and issues get raised on the samba mailing list over and over again.
</para>

<sect2>
	<title>Large number of smbd processes</title>

<para>
Samba consists on three core programs:
&nmbd;, &smbd;, &winbindd;. &nmbd; is the name server message daemon,
&smbd; is the server message daemon, &winbindd; is the daemon that
handles communication with Domain Controllers.
</para>

<para>
If your system is NOT running as a WINS server, then there will be one (1) single instance of
 &nmbd; running on your system. If it is running as a WINS server then there will be
two (2) instances - one to handle the WINS requests.
</para>

<para>
&smbd; handles ALL connection requests and then spawns a new process for each client
connection made. That is why you are seeing so many of them, one (1) per client connection.
</para>

<para>
&winbindd; will run as one or two daemons, depending on whether or not it is being
run in "split mode" (in which case there will be two instances).
</para>

</sect2>

	<sect2>
		<title>"open_oplock_ipc: Failed to get local UDP socket for address 100007f. Error was Cannot assign requested"</title>
	<para>Your loopback device isn't working correctly. Make sure it's configured properly. The loopback device is an internal (virtual) network device with 
		the ip address 127.0.0.1. Read your OS documentation for details 
	on how to configure the loopback on your system.</para>
	</sect2>

	<sect2>
		<title>"<errorname>The network name cannot be found</errorname>"</title>

		<para>
			This error can be caused by one of these misconfigurations:
		</para>

		<itemizedlist>
			<listitem><para>You specified an nonexisting <smbconfoption><name>path</name></smbconfoption> for the share in &smb.conf; </para></listitem>
			<listitem><para>The user you are trying to access the share with does not 
					have sufficient permissions to access the <smbconfoption><name>path</name></smbconfoption> for the share. Both read (r) and access (x) should be possible.</para></listitem>
			<listitem><para>The share you are trying to access does not exist.</para></listitem>
	</itemizedlist>

	</sect2>
</sect1>

</chapter>