1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>swat</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.64.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="swat.8"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>swat — Samba Web Administration Tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">swat</tt> [-s <smb config file>] [-a]</p></div></div><div class="refsect1" lang="en"><a name="id2478431"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><span><b class="command">swat</b></span> allows a Samba administrator to
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>swat</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="swat.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>swat — Samba Web Administration Tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">swat</tt> [-s <smb config file>] [-a] [-P]</p></div></div><div class="refsect1" lang="en"><a name="id2497544"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><span><b class="command">swat</b></span> allows a Samba administrator to
2
2
configure the complex <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file via a Web browser. In addition,
3
3
a <span><b class="command">swat</b></span> configuration page has help links
4
4
to all the configurable options in the <tt class="filename">smb.conf</tt> file allowing an
5
administrator to easily look up the effects of any change. </p><p><span><b class="command">swat</b></span> is run from <span><b class="command">inetd</b></span> </p></div><div class="refsect1" lang="en"><a name="id2478494"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-s smb configuration file</span></dt><dd><p>The default configuration file path is
5
administrator to easily look up the effects of any change. </p><p><span><b class="command">swat</b></span> is run from <span><b class="command">inetd</b></span> </p></div><div class="refsect1" lang="en"><a name="id2497607"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-s smb configuration file</span></dt><dd><p>The default configuration file path is
6
6
determined at compile time. The file specified contains
7
7
the configuration details required by the <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> server. This is the file
8
8
that <span><b class="command">swat</b></span> will modify.
13
13
</p></dd><dt><span class="term">-a</span></dt><dd><p>This option disables authentication and puts
14
14
<span><b class="command">swat</b></span> in demo mode. In that mode anyone will be able to modify
15
15
the <tt class="filename">smb.conf</tt> file. </p><p><span class="emphasis"><em>WARNING: Do NOT enable this option on a production
16
server. </em></span></p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number.
16
server. </em></span></p></dd><dt><span class="term">-P</span></dt><dd><p>This option restricts read-only users to the password
17
management page. <span><b class="command">swat</b></span> can then be used to change
18
user passwords without users seeing the "View" and "Status" menu
19
buttons.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number.
17
20
</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the
18
21
configuration details required by the server. The
19
22
information in this file includes server-specific
33
36
investigating a problem. Levels above 3 are designed for
34
37
use only by developers and generate HUGE amounts of log
35
38
data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
36
override the <a class="indexterm" name="id2430112"></a>log level parameter
39
override the <a class="indexterm" name="id2449176"></a> parameter
37
40
in the <tt class="filename">smb.conf</tt> file.</p></dd><dt><span class="term">-l|--logfile=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension
38
41
<tt class="constant">".progname"</tt> will be appended (e.g. log.smbclient,
39
42
log.smbd, etc...). The log file is never removed by the client.
40
43
</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
41
</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2430159"></a><h2>INSTALLATION</h2><p>Swat is included as binary package with most distributions. The
44
</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2449222"></a><h2>INSTALLATION</h2><p>Swat is included as binary package with most distributions. The
42
45
package manager in this case takes care of the installation and
43
46
configuration. This section is only for those who have compiled
45
48
</p><p>After you compile SWAT you need to run <span><b class="command">make install
46
49
</b></span> to install the <span><b class="command">swat</b></span> binary
47
50
and the various help files and images. A default install would put
48
these in: </p><div class="itemizedlist"><ul type="disc"><li><p>/usr/local/samba/sbin/swat</p></li><li><p>/usr/local/samba/swat/images/*</p></li><li><p>/usr/local/samba/swat/help/*</p></li></ul></div><div class="refsect2" lang="en"><a name="id2430207"></a><h3>Inetd Installation</h3><p>You need to edit your <tt class="filename">/etc/inetd.conf
51
these in: </p><div class="itemizedlist"><ul type="disc"><li><p>/usr/local/samba/sbin/swat</p></li><li><p>/usr/local/samba/swat/images/*</p></li><li><p>/usr/local/samba/swat/help/*</p></li></ul></div><div class="refsect2" lang="en"><a name="id2449270"></a><h3>Inetd Installation</h3><p>You need to edit your <tt class="filename">/etc/inetd.conf
49
52
</tt> and <tt class="filename">/etc/services</tt>
50
53
to enable SWAT to be launched via <span><b class="command">inetd</b></span>.</p><p>In <tt class="filename">/etc/services</tt> you need to
51
54
add a line like this: </p><p><span><b class="command">swat 901/tcp</b></span></p><p>Note for NIS/YP and LDAP users - you may need to rebuild the
59
62
/usr/local/samba/sbin/swat swat</b></span></p><p>Once you have edited <tt class="filename">/etc/services</tt>
60
63
and <tt class="filename">/etc/inetd.conf</tt> you need to send a
61
64
HUP signal to inetd. To do this use <span><b class="command">kill -1 PID
62
</b></span> where PID is the process ID of the inetd daemon. </p></div></div><div class="refsect1" lang="en"><a name="id2429153"></a><h2>LAUNCHING</h2><p>To launch SWAT just run your favorite web browser and
65
</b></span> where PID is the process ID of the inetd daemon. </p></div></div><div class="refsect1" lang="en"><a name="id2448314"></a><h2>LAUNCHING</h2><p>To launch SWAT just run your favorite web browser and
63
66
point it at "http://localhost:901/".</p><p>Note that you can attach to SWAT from any IP connected
64
67
machine but connecting from a remote machine leaves your
65
68
connection open to password sniffing as passwords will be sent
66
in the clear over the wire. </p></div><div class="refsect1" lang="en"><a name="id2429172"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><tt class="filename">/etc/inetd.conf</tt></span></dt><dd><p>This file must contain suitable startup
69
in the clear over the wire. </p></div><div class="refsect1" lang="en"><a name="id2448332"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><tt class="filename">/etc/inetd.conf</tt></span></dt><dd><p>This file must contain suitable startup
67
70
information for the meta-daemon.</p></dd><dt><span class="term"><tt class="filename">/etc/services</tt></span></dt><dd><p>This file must contain a mapping of service name
68
71
(e.g., swat) to service port (e.g., 901) and protocol type
69
72
(e.g., tcp). </p></dd><dt><span class="term"><tt class="filename">/usr/local/samba/lib/smb.conf</tt></span></dt><dd><p>This is the default location of the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> server configuration file that swat edits. Other
70
73
common places that systems install this file are <tt class="filename">
71
74
/usr/samba/lib/smb.conf</tt> and <tt class="filename">/etc/smb.conf
72
75
</tt>. This file describes all the services the server
73
is to make available to clients. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2429254"></a><h2>WARNINGS</h2><p><span><b class="command">swat</b></span> will rewrite your <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file. It will rearrange the entries and delete all
76
is to make available to clients. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2448414"></a><h2>WARNINGS</h2><p><span><b class="command">swat</b></span> will rewrite your <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file. It will rearrange the entries and delete all
74
77
comments, <i class="parameter"><tt>include=</tt></i> and <i class="parameter"><tt>copy=
75
78
</tt></i> options. If you have a carefully crafted <tt class="filename">
76
smb.conf</tt> then back it up or don't use swat! </p></div><div class="refsect1" lang="en"><a name="id2429298"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id2429309"></a><h2>SEE ALSO</h2><p><span><b class="command">inetd(5)</b></span>, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a></p></div><div class="refsect1" lang="en"><a name="id2429339"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
79
smb.conf</tt> then back it up or don't use swat! </p></div><div class="refsect1" lang="en"><a name="id2448458"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id2448470"></a><h2>SEE ALSO</h2><p><span><b class="command">inetd(5)</b></span>, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a></p></div><div class="refsect1" lang="en"><a name="id2448500"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
77
80
were created by Andrew Tridgell. Samba is now developed
78
81
by the Samba Team as an Open Source project similar
79
82
to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer.
added
removed
docs/htmldocs/swat.8.html
