docs/htmldocs/swat.8.html

   1
   2
   3
   4
   5
   6 <html><head><title>swat (8)</title>
   7
   8 <link rev="made" href="mailto:samba-bugs@samba.anu.edu.au">
   9 </head>
  10 <body>
  11
  12 <hr>
  13
  14 <h1>swat (8)</h1>
  15 <h2>Samba</h2>
  16 <h2>23 Oct 1998</h2>
  17
  18
  19
  20
  21 <p><br><a name="NAME"></a>
  22 <h2>NAME</h2>
  23     swat - swat - Samba Web Administration Tool
  24 <p><br><a name="SYNOPSIS"></a>
  25 <h2>SYNOPSIS</h2>
  26
  27 <p><br><strong>swat</strong> [<a href="swat.8.html#minuss">-s smb config file</a>] [<a href="swat.8.html#minusa">-a</a>]
  28 <p><br><a name="DESCRIPTION"></a>
  29 <h2>DESCRIPTION</h2>
  30
  31 <p><br>This program is part of the <strong>Samba</strong> suite.
  32 <p><br><strong>swat</strong> allows a Samba administrator to configure the complex
  33 <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file via a Web browser. In
  34 addition, a swat configuration page has help links to all the
  35 configurable options in the <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file
  36 allowing an administrator to easily look up the effects of any change.
  37 <p><br><strong>swat</strong> is run from <strong>inetd</strong>
  38 <p><br><a name="OPTIONS"></a>
  39 <h2>OPTIONS</h2>
  40
  41 <p><br><ul>
  42 <p><br><a name="minuss"></a>
  43 <li><strong><strong>-s smb configuration file</strong></strong> The default configuration file path is
  44 determined at compile time.
  45 <p><br>The file specified contains the configuration details required by the
  46 <a href="smbd.8.html"><strong>smbd</strong></a> server. This is the file that <strong>swat</strong> will
  47 modify. The information in this file includes server-specific
  48 information such as what printcap file to use, as well as descriptions
  49 of all the services that the server is to provide. See <a href="smb.conf.5.html">smb.conf
  50 (5)</a> for more information.
  51 <p><br><a name="minusa"></a>
  52 <li><strong><strong>-a</strong></strong>
  53 <p><br>This option disables authentication and puts <strong>swat</strong> in demo mode. In
  54 that mode anyone will be able to modify the
  55 <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file.
  56 <p><br>Do NOT enable this option on a production server.
  57 <p><br></ul>
  58 <p><br><a name="INSTALLATION"></a>
  59 <h2>INSTALLATION</h2>
  60
  61 <p><br>After you compile SWAT you need to run <code>"make install"</code> to install the
  62 swat binary and the various help files and images. A default install
  63 would put these in:
  64 <p><br><pre>
  65
  66 /usr/local/samba/bin/swat
  67 /usr/local/samba/swat/images/*
  68 /usr/local/samba/swat/help/*
  69
  70 </pre>
  71
  72 <p><br><a name="INETD"></a>
  73 <h2>INETD INSTALLATION</h2>
  74
  75 <p><br>You need to edit your <code>/etc/inetd.conf</code> and <code>/etc/services</code> to
  76 enable <strong>SWAT</strong> to be launched via inetd.
  77 <p><br>In <code>/etc/services</code> you need to add a line like this:
  78 <p><br><code>swat            901/tcp</code>
  79 <p><br>Note for NIS/YP users - you may need to rebuild the NIS service maps
  80 rather than alter your local <code>/etc/services</code> file.
  81 <p><br>the choice of port number isn't really important except that it should
  82 be less than 1024 and not currently used (using a number above 1024
  83 presents an obscure security hole depending on the implementation
  84 details of your <strong>inetd</strong> daemon).
  85 <p><br>In <code>/etc/inetd.conf</code> you should add a line like this:
  86 <p><br><code>swat    stream  tcp     nowait.400  root    /usr/local/samba/bin/swat swat</code>
  87 <p><br>One you have edited <code>/etc/services</code> and <code>/etc/inetd.conf</code> you need
  88 to send a HUP signal to inetd. To do this use <code>"kill -1 PID"</code> where
  89 PID is the process ID of the inetd daemon.
  90 <p><br><a name="LAUNCHING"></a>
  91 <h2>LAUNCHING</h2>
  92
  93 <p><br>To launch <strong>swat</strong> just run your favorite web browser and point it at
  94 <code>http://localhost:901/</code>.
  95 <p><br><strong>Note that you can attach to <strong>swat</strong> from any IP connected machine but
  96 connecting from a remote machine leaves your connection open to
  97 password sniffing as passwords will be sent in the clear over the
  98 wire.</strong>
  99 <p><br><h2>FILES</h2>
 100
 101 <p><br><strong>/etc/inetd.conf</strong>
 102 <p><br>This file must contain suitable startup information for the
 103 meta-daemon.
 104 <p><br><strong>/etc/services</strong>
 105 <p><br>This file must contain a mapping of service name (e.g., swat) to
 106 service port (e.g., 901) and protocol type (e.g., tcp).
 107 <p><br><strong>/usr/local/samba/lib/smb.conf</strong>
 108 <p><br>This is the default location of the <em>smb.conf</em> server configuration
 109 file that <strong>swat</strong> edits. Other common places that systems install
 110 this file are <em>/usr/samba/lib/smb.conf</em> and <em>/etc/smb.conf</em>.
 111 <p><br>This file describes all the services the server is to make available
 112 to clients. See <strong>smb.conf (5)</strong> for more information.
 113 <p><br><a name="WARNINGS"></a>
 114 <h2>WARNINGS</h2>
 115
 116 <p><br><strong>swat</strong> will rewrite your <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file. It
 117 will rearrange the entries and delete all comments,
 118 <a href="smb.conf.5.html#include"><strong>"include="</strong></a> and
 119 <a href="smb.conf.5.html#copy"><strong>"copy="</strong></a> options. If you have a
 120 carefully crafted <a href="smb.conf.5.html"><strong>smb.conf</strong></a> then back it up
 121 or don't use <strong>swat</strong>!
 122 <p><br><a name="VERSION"></a>
 123 <h2>VERSION</h2>
 124
 125 <p><br>This man page is correct for version 2.0 of the Samba suite.
 126 <p><br><a name="SEEALSO"></a>
 127 <h2>SEE ALSO</h2>
 128
 129 <p><br><strong>inetd (8)</strong>, <a href="nmbd.8.html"><strong>nmbd (8)</strong></a>,
 130 <a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a>.
 131 <p><br><a name="AUTHOR"></a>
 132 <h2>AUTHOR</h2>
 133
 134 <p><br>The original Samba software and related utilities were created by
 135 Andrew Tridgell (samba-bugs@samba.anu.edu.au). Samba is now developed
 136 by the Samba Team as an Open Source project similar to the way the
 137 Linux kernel is developed.
 138 <p><br>The original Samba man pages were written by Karl Auer. The man page
 139 sources were converted to YODL format (another excellent piece of Open
 140 Source software, available at
 141 <a href="ftp://ftp.icce.rug.nl/pub/unix/"><strong>ftp://ftp.icce.rug.nl/pub/unix/</strong></a>)
 142 and updated for the Samba2.0 release by Jeremy Allison.
 143 <a href="mailto:samba-bugs@samba.anu.edu.au"><em>samba-bugs@samba.anu.edu.au</em></a>.
 144 <p><br>See <a href="samba.7.html"><strong>samba (7)</strong></a> to find out how to get a full
 145 list of contributors and details on how to submit bug reports,
 146 comments etc.
 147 </body>
 148 </html>