source: trunk/samba/docs/htmldocs/manpages/swat.8.html @ 30

Last change on this file since 30 was 1, checked in by Paul Smedley, 14 years ago

Initial code import

File size: 10.1 KB
Line 
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.68.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 &#8212; Samba Web Administration Tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">swat</code>  [-s &lt;smb config file&gt;] [-a] [-P]</p></div></div><div class="refsect1" lang="en"><a name="id230783"></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><strong class="command">swat</strong></span> 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 <span><strong class="command">swat</strong></span> configuration page has help links
4        to all the configurable options in the <code class="filename">smb.conf</code> file allowing an
5        administrator to easily look up the effects of any change. </p><p><span><strong class="command">swat</strong></span> is run from <span><strong class="command">inetd</strong></span> </p></div><div class="refsect1" lang="en"><a name="id231168"></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                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 <span><strong class="command">swat</strong></span> 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 <code class="filename">smb.conf</code> for more information.
13                </p></dd><dt><span class="term">-a</span></dt><dd><p>This option disables authentication and
14                places <span><strong class="command">swat</strong></span> in demo mode. In that mode anyone will be able to modify
15                the <code class="filename">smb.conf</code> 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">-P</span></dt><dd><p>This option restricts read-only users to the password
17        management page.  <span><strong class="command">swat</strong></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.
20</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
21configuration details required by the server.  The
22information in this file includes server-specific
23information such as what printcap file to use, as well
24as descriptions of all the services that the server is
25to provide. See <code class="filename">smb.conf</code> for more information.
26The default configuration file name is determined at
27compile time.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer
28from 0 to 10.  The default value if this parameter is
29not specified is zero.</p><p>The higher this value, the more detail will be
30logged to the log files about the activities of the
31server. At level 0, only critical errors and serious
32warnings will be logged. Level 1 is a reasonable level for
33day-to-day running - it generates a small amount of
34information about operations carried out.</p><p>Levels above 1 will generate considerable
35amounts of log data, and should only be used when
36investigating a problem. Levels above 3 are designed for
37use only by developers and generate HUGE amounts of log
38data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
39override the <a class="indexterm" name="id231515"></a> parameter
40in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-l|--logfile=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension
41<code class="constant">".progname"</code> will be appended (e.g. log.smbclient,
42log.smbd, etc...). The log file is never removed by the client.
43</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
44</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id230507"></a><h2>INSTALLATION</h2><p>Swat is included as binary package with most distributions. The
45        package manager in this case takes care of the installation and
46        configuration. This section is only for those who have compiled
47        swat from scratch.
48        </p><p>After you compile SWAT you need to run <span><strong class="command">make install
49        </strong></span> to install the <span><strong class="command">swat</strong></span> binary
50        and the various help files and images. A default install would put
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="id230552"></a><h3>Inetd Installation</h3><p>You need to edit your <code class="filename">/etc/inetd.conf
52                </code> and <code class="filename">/etc/services</code>
53                to enable SWAT to be launched via <span><strong class="command">inetd</strong></span>.</p><p>In <code class="filename">/etc/services</code> you need to
54                add a line like this: </p><p><span><strong class="command">swat            901/tcp</strong></span></p><p>Note for NIS/YP and LDAP users - you may need to rebuild the
55                NIS service maps rather than alter your local <code class="filename">
56                /etc/services</code> file. </p><p>the choice of port number isn't really important
57                except that it should be less than 1024 and not currently
58                used (using a number above 1024 presents an obscure security
59                hole depending on the implementation details of your
60                <span><strong class="command">inetd</strong></span> daemon). </p><p>In <code class="filename">/etc/inetd.conf</code> you should
61                add a line like this: </p><p><span><strong class="command">swat    stream  tcp     nowait.400  root
62                /usr/local/samba/sbin/swat swat</strong></span></p><p>Once you have edited <code class="filename">/etc/services</code> 
63                and <code class="filename">/etc/inetd.conf</code> you need to send a
64                HUP signal to inetd. To do this use <span><strong class="command">kill -1 PID
65                </strong></span> where PID is the process ID of the inetd daemon. </p></div></div><div class="refsect1" lang="en"><a name="id271756"></a><h2>LAUNCHING</h2><p>To launch SWAT just run your favorite web browser and
66        point it at "http://localhost:901/".</p><p>Note that you can attach to SWAT from any IP connected
67        machine but connecting from a remote machine leaves your
68        connection open to password sniffing as passwords will be sent
69        in the clear over the wire. </p></div><div class="refsect1" lang="en"><a name="id271772"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><code class="filename">/etc/inetd.conf</code></span></dt><dd><p>This file must contain suitable startup
70                information for the meta-daemon.</p></dd><dt><span class="term"><code class="filename">/etc/services</code></span></dt><dd><p>This file must contain a mapping of service name
71                (e.g., swat) to service port (e.g., 901) and protocol type
72                (e.g., tcp).  </p></dd><dt><span class="term"><code class="filename">/usr/local/samba/lib/smb.conf</code></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
73                common places that systems install this file are <code class="filename">
74                /usr/samba/lib/smb.conf</code> and <code class="filename">/etc/smb.conf
75                </code>.  This file describes all the services the server
76                is to make available to clients. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id271849"></a><h2>WARNINGS</h2><p><span><strong class="command">swat</strong></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
77        comments, <em class="parameter"><code>include=</code></em> and <em class="parameter"><code>copy=
78        </code></em> options. If you have a carefully crafted <code class="filename">
79        smb.conf</code> then back it up or don't use swat! </p></div><div class="refsect1" lang="en"><a name="id271892"></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="id271902"></a><h2>SEE ALSO</h2><p><span><strong class="command">inetd(5)</strong></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="id271933"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
80        were created by Andrew Tridgell. Samba is now developed
81        by the Samba Team as an Open Source project similar
82        to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer.
83        The man page sources were converted to YODL format (another
84        excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
85        ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0
86        release by Jeremy Allison.  The conversion to DocBook for
87        Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
88        Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html>
Note: See TracBrowser for help on using the repository browser.