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.60.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"><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><b class=
"command">swat
</b> allows a Samba administrator to
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 a
<b class=
"command">swat
</b> configuration page has help links
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><b class=
"command">swat
</b> is run from
<b class=
"command">inetd
</b> </p></div><div class=
"refsect1" lang=
"en"><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 determined at compile time. The file specified contains
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 that
<b class=
"command">swat
</b> will modify.
9 The information in this file includes server-specific
10 information such as what printcap file to use, as well as
11 descriptions of all the services that the server is to provide.
12 See
<tt class=
"filename">smb.conf
</tt> for more information.
13 </p></dd><dt><span class=
"term">-a
</span></dt><dd><p>This option disables authentication and puts
14 <b class=
"command">swat
</b> in demo mode. In that mode anyone will be able to modify
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.
17 </p></dd><dt><span class=
"term">-s
<configuration file
></span></dt><dd><p>The file specified contains the
18 configuration details required by the server. The
19 information in this file includes server-specific
20 information such as what printcap file to use, as well
21 as descriptions of all the services that the server is
22 to provide. See
<tt class=
"filename">smb.conf
</tt> for more information.
23 The default configuration file name is determined at
24 compile time.
</p></dd><dt><span class=
"term">-d|--debug=debuglevel
</span></dt><dd><p><i class=
"replaceable"><tt>debuglevel
</tt></i> is an integer
25 from
0 to
10. The default value if this parameter is
26 not specified is zero.
</p><p>The higher this value, the more detail will be
27 logged to the log files about the activities of the
28 server. At level
0, only critical errors and serious
29 warnings will be logged. Level
1 is a reasonable level for
30 day-to-day running - it generates a small amount of
31 information about operations carried out.
</p><p>Levels above
1 will generate considerable
32 amounts of log data, and should only be used when
33 investigating a problem. Levels above
3 are designed for
34 use only by developers and generate HUGE amounts of log
35 data, most of which is extremely cryptic.
</p><p>Note that specifying this parameter here will
36 override the
<a class=
"indexterm" name=
"id2796611"></a><i class=
"parameter"><tt>log level
</tt></i> parameter
37 in the
<tt class=
"filename">smb.conf
</tt> file.
</p></dd><dt><span class=
"term">-l|--logfile=logbasename
</span></dt><dd><p>File name for log/debug files. The extension
38 <tt class=
"constant">".client"</tt> will be appended. The log file is
39 never removed by the client.
40 </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"><h2>INSTALLATION
</h2><p>Swat is included as binary package with most distributions. The
42 package manager in this case takes care of the installation and
43 configuration. This section is only for those who have compiled
45 </p><p>After you compile SWAT you need to run
<b class=
"command">make install
46 </b> to install the
<b class=
"command">swat
</b> binary
47 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/bin/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"><h3>Inetd Installation
</h3><p>You need to edit your
<tt class=
"filename">/etc/inetd.conf
49 </tt> and
<tt class=
"filename">/etc/services
</tt>
50 to enable SWAT to be launched via
<b class=
"command">inetd
</b>.
</p><p>In
<tt class=
"filename">/etc/services
</tt> you need to
51 add a line like this:
</p><p><b class=
"command">swat
901/tcp
</b></p><p>Note for NIS/YP and LDAP users - you may need to rebuild the
52 NIS service maps rather than alter your local
<tt class=
"filename">
53 /etc/services
</tt> file.
</p><p>the choice of port number isn't really important
54 except that it should be less than
1024 and not currently
55 used (using a number above
1024 presents an obscure security
56 hole depending on the implementation details of your
57 <b class=
"command">inetd
</b> daemon).
</p><p>In
<tt class=
"filename">/etc/inetd.conf
</tt> you should
58 add a line like this:
</p><p><b class=
"command">swat stream tcp nowait
.400 root
59 /usr/local/samba/bin/swat swat
</b></p><p>One you have edited
<tt class=
"filename">/etc/services
</tt>
60 and
<tt class=
"filename">/etc/inetd.conf
</tt> you need to send a
61 HUP signal to inetd. To do this use
<b class=
"command">kill -
1 PID
62 </b> where PID is the process ID of the inetd daemon.
</p></div></div><div class=
"refsect1" lang=
"en"><h2>LAUNCHING
</h2><p>To launch SWAT just run your favorite web browser and
63 point it at
"http://localhost:901/".
</p><p>Note that you can attach to SWAT from any IP connected
64 machine but connecting from a remote machine leaves your
65 connection open to password sniffing as passwords will be sent
66 in the clear over the wire.
</p></div><div class=
"refsect1" lang=
"en"><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 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 (e.g., swat) to service port (e.g.,
901) and protocol type
69 (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 common places that systems install this file are
<tt class=
"filename">
71 /usr/samba/lib/smb.conf
</tt> and
<tt class=
"filename">/etc/smb.conf
72 </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"><h2>WARNINGS
</h2><p><b class=
"command">swat
</b> 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 comments,
<i class=
"parameter"><tt>include=
</tt></i> and
<i class=
"parameter"><tt>copy=
75 </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"><h2>VERSION
</h2><p>This man page is correct for version
3.0 of the Samba suite.
</p></div><div class=
"refsect1" lang=
"en"><h2>SEE ALSO
</h2><p><b class=
"command">inetd(
5)
</b>,
<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"><h2>AUTHOR
</h2><p>The original Samba software and related utilities
77 were created by Andrew Tridgell. Samba is now developed
78 by the Samba Team as an Open Source project similar
79 to the way the Linux kernel is developed.
</p><p>The original Samba man pages were written by Karl Auer.
80 The man page sources were converted to YODL format (another
81 excellent piece of Open Source software, available at
<ulink url=
"ftp://ftp.icce.rug.nl/pub/unix/">
82 ftp://ftp.icce.rug.nl/pub/unix/
</ulink>) and updated for the Samba
2.0
83 release by Jeremy Allison. The conversion to DocBook for
84 Samba
2.2 was done by Gerald Carter. The conversion to DocBook XML
4.2 for
85 Samba
3.0 was done by Alexander Bokovoy.
</p></div></div></body></html>