docs/manpages-3/swat.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="swat.8">
   4
   5 <refmeta>
   6         <refentrytitle>swat</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>swat</refname>
  13         <refpurpose>Samba Web Administration Tool</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>swat</command>
  19                 <arg choice="opt">-s &lt;smb config file&gt;</arg>
  20                 <arg choice="opt">-a</arg>
  21                 <arg choice="opt">-P</arg>
  22         </cmdsynopsis>
  23 </refsynopsisdiv>
  24
  25 <refsect1>
  26         <title>DESCRIPTION</title>
  27
  28         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  29         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  30
  31
  32         <para><command>swat</command> allows a Samba administrator to
  33         configure the complex <citerefentry><refentrytitle>smb.conf</refentrytitle>
  34         <manvolnum>5</manvolnum></citerefentry> file via a Web browser. In addition,
  35         a <command>swat</command> configuration page has help links
  36         to all the configurable options in the <filename>smb.conf</filename> file allowing an
  37         administrator to easily look up the effects of any change. </para>
  38
  39         <para><command>swat</command> is run from <command>inetd</command> </para>
  40 </refsect1>
  41
  42
  43 <refsect1>
  44         <title>OPTIONS</title>
  45
  46         <variablelist>
  47                 <varlistentry>
  48                 <term>-s smb configuration file</term>
  49                 <listitem><para>The default configuration file path is
  50                 determined at compile time.  The file specified contains
  51                 the configuration details required by the <citerefentry><refentrytitle>smbd</refentrytitle>
  52                 <manvolnum>8</manvolnum></citerefentry> server. This is the file
  53                 that <command>swat</command> will modify.
  54                 The information in this file includes server-specific
  55                 information such as what printcap file to use, as well as
  56                 descriptions of all the services that the server is to provide.
  57                 See <filename>smb.conf</filename> for more information.
  58                 </para></listitem>
  59                 </varlistentry>
  60
  61
  62                 <varlistentry>
  63                 <term>-a</term>
  64                 <listitem><para>This option disables authentication and
  65                 places <command>swat</command> in demo mode. In that mode anyone will be able to modify
  66                 the <filename>smb.conf</filename> file. </para>
  67
  68                 <para><emphasis>WARNING: Do NOT enable this option on a production
  69                 server. </emphasis></para></listitem>
  70                 </varlistentry>
  71
  72                 <varlistentry>
  73                 <term>-P</term>
  74                 <listitem><para>This option restricts read-only users to the password
  75         management page.  <command>swat</command> can then be used to change
  76         user passwords without users seeing the "View" and "Status" menu
  77         buttons.</para></listitem>
  78                 </varlistentry>
  79
  80                 &stdarg.server.debug;
  81                 &popt.common.samba;
  82                 &stdarg.help;
  83
  84         </variablelist>
  85
  86 </refsect1>
  87
  88 <refsect1>
  89
  90         <title>INSTALLATION</title>
  91
  92         <para>Swat is included as binary package with most distributions. The
  93         package manager in this case takes care of the installation and
  94         configuration. This section is only for those who have compiled
  95         swat from scratch.
  96         </para>
  97
  98         <para>After you compile SWAT you need to run <command>make install
  99         </command> to install the <command>swat</command> binary
 100         and the various help files and images. A default install would put
 101         these in: </para>
 102
 103         <itemizedlist>
 104                 <listitem><para>/usr/local/samba/sbin/swat</para></listitem>
 105                 <listitem><para>/usr/local/samba/swat/images/*</para></listitem>
 106                 <listitem><para>/usr/local/samba/swat/help/*</para></listitem>
 107         </itemizedlist>
 108
 109         <refsect2>
 110                 <title>Inetd Installation</title>
 111
 112                 <para>You need to edit your <filename>/etc/inetd.conf
 113                 </filename> and <filename>/etc/services</filename>
 114                 to enable SWAT to be launched via <command>inetd</command>.</para>
 115
 116                 <para>In <filename>/etc/services</filename> you need to
 117                 add a line like this: </para>
 118
 119                 <para><command>swat            901/tcp</command></para>
 120
 121                 <para>Note for NIS/YP and LDAP users - you may need to rebuild the
 122                 NIS service maps rather than alter your local <filename>
 123                 /etc/services</filename> file. </para>
 124
 125                 <para>the choice of port number isn't really important
 126                 except that it should be less than 1024 and not currently
 127                 used (using a number above 1024 presents an obscure security
 128                 hole depending on the implementation details of your
 129                 <command>inetd</command> daemon). </para>
 130
 131                 <para>In <filename>/etc/inetd.conf</filename> you should
 132                 add a line like this: </para>
 133
 134                 <para><command>swat    stream  tcp     nowait.400  root
 135                 /usr/local/samba/sbin/swat swat</command></para>
 136
 137                 <para>Once you have edited <filename>/etc/services</filename>
 138                 and <filename>/etc/inetd.conf</filename> you need to send a
 139                 HUP signal to inetd. To do this use <command>kill -1 PID
 140                 </command> where PID is the process ID of the inetd daemon. </para>
 141
 142         </refsect2>
 143
 144
 145
 146 </refsect1>
 147
 148 <refsect1>
 149         <title>LAUNCHING</title>
 150
 151         <para>To launch SWAT just run your favorite web browser and
 152         point it at "http://localhost:901/".</para>
 153
 154         <para>Note that you can attach to SWAT from any IP connected
 155         machine but connecting from a remote machine leaves your
 156         connection open to password sniffing as passwords will be sent
 157         in the clear over the wire. </para>
 158 </refsect1>
 159
 160 <refsect1>
 161         <title>FILES</title>
 162
 163         <variablelist>
 164                 <varlistentry>
 165                 <term><filename>/etc/inetd.conf</filename></term>
 166                 <listitem><para>This file must contain suitable startup
 167                 information for the meta-daemon.</para></listitem>
 168                 </varlistentry>
 169
 170                 <varlistentry>
 171                 <term><filename>/etc/services</filename></term>
 172                 <listitem><para>This file must contain a mapping of service name
 173                 (e.g., swat) to service port (e.g., 901) and protocol type
 174                 (e.g., tcp).  </para></listitem>
 175                 </varlistentry>
 176
 177                 <varlistentry>
 178                 <term><filename>/usr/local/samba/lib/smb.conf</filename></term>
 179                 <listitem><para>This is the default location of the <citerefentry>
 180                 <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
 181                 </citerefentry> server configuration file that swat edits. Other
 182                 common places that systems install this file are <filename>
 183                 /usr/samba/lib/smb.conf</filename> and <filename>/etc/smb.conf
 184                 </filename>.  This file describes all the services the server
 185                 is to make available to clients. </para></listitem>
 186                 </varlistentry>
 187         </variablelist>
 188 </refsect1>
 189
 190
 191 <refsect1>
 192         <title>WARNINGS</title>
 193
 194         <para><command>swat</command> will rewrite your <citerefentry>
 195         <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
 196         </citerefentry> file. It will rearrange the entries and delete all
 197         comments, <parameter>include=</parameter> and <parameter>copy=
 198         </parameter> options. If you have a carefully crafted <filename>
 199         smb.conf</filename> then back it up or don't use swat! </para>
 200 </refsect1>
 201
 202
 203 <refsect1>
 204         <title>VERSION</title>
 205
 206         <para>This man page is correct for version 3.0 of the Samba suite.</para>
 207 </refsect1>
 208
 209 <refsect1>
 210         <title>SEE ALSO</title>
 211         <para><command>inetd(5)</command>, <citerefentry>
 212         <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum>
 213         </citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle>
 214         <manvolnum>5</manvolnum></citerefentry></para>
 215 </refsect1>
 216
 217 <refsect1>
 218         <title>AUTHOR</title>
 219
 220         <para>The original Samba software and related utilities
 221         were created by Andrew Tridgell. Samba is now developed
 222         by the Samba Team as an Open Source project similar
 223         to the way the Linux kernel is developed.</para>
 224
 225         <para>The original Samba man pages were written by Karl Auer.
 226         The man page sources were converted to YODL format (another
 227         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 228         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 229         release by Jeremy Allison.  The conversion to DocBook for
 230         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
 231         Samba 3.0 was done by Alexander Bokovoy.</para>
 232 </refsect1>
 233
 234 </refentry>