path: root/docs/htmldocs/swat.8.html

<?xml version="1.0"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
	        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

	<!ENTITY % globalentities SYSTEM 'global.ent'> %globalentities;
 ]>
<refentry id="swat.8">

<refmeta>
	<refentrytitle>swat</refentrytitle>
	<manvolnum>8</manvolnum>
</refmeta>


<refnamediv>
	<refname>swat</refname>
	<refpurpose>Samba Web Administration Tool</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis sepchar=" ">
		<command moreinfo="none">swat</command>
		<arg rep="norepeat" choice="opt">-s &lt;smb config file&gt;</arg>
		<arg rep="norepeat" choice="opt">-a</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>


	<para><command moreinfo="none">swat</command> allows a Samba administrator to 
	configure the complex <citerefentry><refentrytitle>smb.conf</refentrytitle>
	<manvolnum>5</manvolnum></citerefentry> file via a Web browser. In addition, 
	a <command moreinfo="none">swat</command> configuration page has help links 
	to all the configurable options in the <filename moreinfo="none">smb.conf</filename> file allowing an 
	administrator to easily look up the effects of any change. </para>

	<para><command moreinfo="none">swat</command> is run from <command moreinfo="none">inetd</command> </para>
</refsect1>


<refsect1>
	<title>OPTIONS</title>

	<variablelist>
		<varlistentry>
		<term>-s smb configuration file</term>
		<listitem><para>The default configuration file path is 
		determined at compile time.  The file specified contains 
		the configuration details required by the <citerefentry><refentrytitle>smbd</refentrytitle>
		<manvolnum>8</manvolnum></citerefentry> server. This is the file 
		that <command moreinfo="none">swat</command> will modify. 
		The information in this file includes server-specific 
		information such as what printcap file to use, as well as 
		descriptions of all the services that the server is to provide.
		See <filename moreinfo="none">smb.conf</filename> for more information. 
		</para></listitem>
		</varlistentry>


		<varlistentry>
		<term>-a</term>
		<listitem><para>This option disables authentication and puts 
		<command moreinfo="none">swat</command> in demo mode. In that mode anyone will be able to modify 
		the <filename moreinfo="none">smb.conf</filename> file. </para>
		
		<para><emphasis>WARNING: Do NOT enable this option on a production 
		server. </emphasis></para></listitem>
		</varlistentry>

		

<varlistentry>
<term>-V</term>
<listitem><para>Prints the version number for 
<command moreinfo="none">smbd</command>.</para></listitem>
</varlistentry>

<varlistentry>
<term>-s &lt;configuration file&gt;</term>
<listitem><para>The file specified contains the 
configuration details required by the server.  The 
information in this file includes server-specific
information such as what printcap file to use, as well 
as descriptions of all the services that the server is 
to provide. See <filename moreinfo="none">smb.conf</filename> for more information.
The default configuration file name is determined at 
compile time.</para></listitem>
</varlistentry>

<varlistentry>
<term>-d|--debug=debuglevel</term>
<listitem>
<para><replaceable>debuglevel</replaceable> is an integer 
from 0 to 10.  The default value if this parameter is 
not specified is zero.</para>

<para>The higher this value, the more detail will be 
logged to the log files about the activities of the 
server. At level 0, only critical errors and serious 
warnings will be logged. Level 1 is a reasonable level for
day to day running - it generates a small amount of 
information about operations carried out.</para>

<para>Levels above 1 will generate considerable 
amounts of log data, and should only be used when 
investigating a problem. Levels above 3 are designed for 
use only by developers and generate HUGE amounts of log
data, most of which is extremely cryptic.</para>

<para>Note that specifying this parameter here will 
override the <indexterm><primary>log level</primary></indexterm><parameter moreinfo="none">log level</parameter> parameter
in the <filename moreinfo="none">smb.conf</filename> file.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-l|--logfile=logbasename</term>
<listitem><para>File name for log/debug files. The extension
<constant>&quot;.client&quot;</constant> will be appended. The log file is
never removed by the client.
</para></listitem>
</varlistentry>

		
<varlistentry>
<term>-h|--help</term>
<listitem><para>Print a summary of command line options.
</para></listitem>
</varlistentry>

	</variablelist>

</refsect1>

<refsect1>

	<title>INSTALLATION</title>

	<para>Swat is included as binary package with most distributions. The 
	package manager in this case takes care of the installation and 
	configuration. This section is only for those who have compiled 
	swat from scratch.
	</para>

	<para>After you compile SWAT you need to run <command moreinfo="none">make install
	</command> to install the <command moreinfo="none">swat</command> binary
	and the various help files and images. A default install would put 
	these in: </para>
	
	<itemizedlist>
		<listitem><para>/usr/local/samba/bin/swat</para></listitem>
		<listitem><para>/usr/local/samba/swat/images/*</para></listitem>
		<listitem><para>/usr/local/samba/swat/help/*</para></listitem>
	</itemizedlist>

	<refsect2> 
		<title>Inetd Installation</title>

		<para>You need to edit your <filename moreinfo="none">/etc/inetd.conf
		</filename> and <filename moreinfo="none">/etc/services</filename>
		to enable SWAT to be launched via <command moreinfo="none">inetd</command>.</para>

		<para>In <filename moreinfo="none">/etc/services</filename> you need to 
		add a line like this: </para>

		<para><command moreinfo="none">swat            901/tcp</command></para>

		<para>Note for NIS/YP and LDAP users - you may need to rebuild the 
		NIS service maps rather than alter your local <filename moreinfo="none">
		/etc/services</filename> file. </para>

		<para>the choice of port number isn't really important 
		except that it should be less than 1024 and not currently 
		used (using a number above 1024 presents an obscure security 
		hole depending on the implementation details of your 
		<command moreinfo="none">inetd</command> daemon). </para>

		<para>In <filename moreinfo="none">/etc/inetd.conf</filename> you should 
		add a line like this: </para>

		<para><command moreinfo="none">swat    stream  tcp     nowait.400  root
		/usr/local/samba/bin/swat swat</command></para>
	
		<para>One you have edited <filename moreinfo="none">/etc/services</filename> 
		and <filename moreinfo="none">/etc/inetd.conf</filename> you need to send a 
		HUP signal to inetd. To do this use <command moreinfo="none">kill -1 PID
		</command> where PID is the process ID of the inetd daemon. </para>

	</refsect2>



</refsect1>

<refsect1>
	<title>LAUNCHING</title>

	<para>To launch SWAT just run your favorite web browser and 
	point it at &quot;http://localhost:901/&quot;.</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>
</refsect1>

<refsect1>
	<title>FILES</title>
	
	<variablelist>
		<varlistentry>
		<term><filename moreinfo="none">/etc/inetd.conf</filename></term>
		<listitem><para>This file must contain suitable startup 
		information for the meta-daemon.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><filename moreinfo="none">/etc/services</filename></term>
		<listitem><para>This file must contain a mapping of service name 
		(e.g., swat) to service port (e.g., 901) and protocol type 
		(e.g., tcp).  </para></listitem>
		</varlistentry>

		<varlistentry>
		<term><filename moreinfo="none">/usr/local/samba/lib/smb.conf</filename></term>
		<listitem><para>This is the default location of the <citerefentry>
		<refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
		</citerefentry> server configuration file that swat edits. Other 
		common places that systems install this file are <filename moreinfo="none">
		/usr/samba/lib/smb.conf</filename> and <filename moreinfo="none">/etc/smb.conf
		</filename>.  This file describes all the services the server 
		is to make available to clients. </para></listitem>
		</varlistentry>
	</variablelist>
</refsect1>


<refsect1>
	<title>WARNINGS</title>

	<para><command moreinfo="none">swat</command> will rewrite your <citerefentry>
	<refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
	</citerefentry> file. It will rearrange the entries and delete all 
	comments, <parameter moreinfo="none">include=</parameter> and <parameter moreinfo="none">copy=
	</parameter> options. If you have a carefully crafted <filename moreinfo="none">
	smb.conf</filename> then back it up or don't use swat! </para>
</refsect1>


<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 3.0 of the Samba suite.</para>
</refsect1>

<refsect1>
	<title>SEE ALSO</title>
	<para><command moreinfo="none">inetd(5)</command>, <citerefentry>
	<refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum>
	</citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle>
	<manvolnum>5</manvolnum></citerefentry></para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>
	
	<para>The original Samba software and related utilities 
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar 
	to the way the Linux kernel is developed.</para>
	
	<para>The original Samba man pages were written by Karl Auer. 
	The man page sources were converted to YODL format (another 
	excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
	ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 
	release by Jeremy Allison.  The conversion to DocBook for 
	Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
	Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>

</refentry>