docs/manpages/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 puts
  65                 <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                 &popt.common.samba;
  81                 &stdarg.help;
  82
  83         </variablelist>
  84
  85 </refsect1>
  86
  87 <refsect1>
  88
  89         <title>INSTALLATION</title>
  90
  91         <para>Swat is included as binary package with most distributions. The
  92         package manager in this case takes care of the installation and
  93         configuration. This section is only for those who have compiled
  94         swat from scratch.
  95         </para>
  96
  97         <para>After you compile SWAT you need to run <command>make install
  98         </command> to install the <command>swat</command> binary
  99         and the various help files and images. A default install would put
 100         these in: </para>
 101
 102         <itemizedlist>
 103                 <listitem><para>/usr/local/samba/sbin/swat</para></listitem>
 104                 <listitem><para>/usr/local/samba/swat/images/*</para></listitem>
 105                 <listitem><para>/usr/local/samba/swat/help/*</para></listitem>
 106         </itemizedlist>
 107
 108         <refsect2>
 109                 <title>Inetd Installation</title>
 110
 111                 <para>You need to edit your <filename>/etc/inetd.conf
 112                 </filename> and <filename>/etc/services</filename>
 113                 to enable SWAT to be launched via <command>inetd</command>.</para>
 114
 115                 <para>In <filename>/etc/services</filename> you need to
 116                 add a line like this: </para>
 117
 118                 <para><command>swat            901/tcp</command></para>
 119
 120                 <para>Note for NIS/YP and LDAP users - you may need to rebuild the
 121                 NIS service maps rather than alter your local <filename>
 122                 /etc/services</filename> file. </para>
 123
 124                 <para>the choice of port number isn't really important
 125                 except that it should be less than 1024 and not currently
 126                 used (using a number above 1024 presents an obscure security
 127                 hole depending on the implementation details of your
 128                 <command>inetd</command> daemon). </para>
 129
 130                 <para>In <filename>/etc/inetd.conf</filename> you should
 131                 add a line like this: </para>
 132
 133                 <para><command>swat    stream  tcp     nowait.400  root
 134                 /usr/local/samba/sbin/swat swat</command></para>
 135
 136                 <para>Once you have edited <filename>/etc/services</filename>
 137                 and <filename>/etc/inetd.conf</filename> you need to send a
 138                 HUP signal to inetd. To do this use <command>kill -1 PID
 139                 </command> where PID is the process ID of the inetd daemon. </para>
 140
 141         </refsect2>
 142
 143
 144
 145 </refsect1>
 146
 147 <refsect1>
 148         <title>LAUNCHING</title>
 149
 150         <para>To launch SWAT just run your favorite web browser and
 151         point it at "http://localhost:901/".</para>
 152
 153         <para>Note that you can attach to SWAT from any IP connected
 154         machine but connecting from a remote machine leaves your
 155         connection open to password sniffing as passwords will be sent
 156         in the clear over the wire. </para>
 157 </refsect1>
 158
 159 <refsect1>
 160         <title>FILES</title>
 161
 162         <variablelist>
 163                 <varlistentry>
 164                 <term><filename>/etc/inetd.conf</filename></term>
 165                 <listitem><para>This file must contain suitable startup
 166                 information for the meta-daemon.</para></listitem>
 167                 </varlistentry>
 168
 169                 <varlistentry>
 170                 <term><filename>/etc/services</filename></term>
 171                 <listitem><para>This file must contain a mapping of service name
 172                 (e.g., swat) to service port (e.g., 901) and protocol type
 173                 (e.g., tcp).  </para></listitem>
 174                 </varlistentry>
 175
 176                 <varlistentry>
 177                 <term><filename>/usr/local/samba/lib/smb.conf</filename></term>
 178                 <listitem><para>This is the default location of the <citerefentry>
 179                 <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
 180                 </citerefentry> server configuration file that swat edits. Other
 181                 common places that systems install this file are <filename>
 182                 /usr/samba/lib/smb.conf</filename> and <filename>/etc/smb.conf
 183                 </filename>.  This file describes all the services the server
 184                 is to make available to clients. </para></listitem>
 185                 </varlistentry>
 186         </variablelist>
 187 </refsect1>
 188
 189
 190 <refsect1>
 191         <title>WARNINGS</title>
 192
 193         <para><command>swat</command> will rewrite your <citerefentry>
 194         <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
 195         </citerefentry> file. It will rearrange the entries and delete all
 196         comments, <parameter>include=</parameter> and <parameter>copy=
 197         </parameter> options. If you have a carefully crafted <filename>
 198         smb.conf</filename> then back it up or don't use swat! </para>
 199 </refsect1>
 200
 201
 202 <refsect1>
 203         <title>VERSION</title>
 204
 205         <para>This man page is correct for version 3.0 of the Samba suite.</para>
 206 </refsect1>
 207
 208 <refsect1>
 209         <title>SEE ALSO</title>
 210         <para><command>inetd(5)</command>, <citerefentry>
 211         <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum>
 212         </citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle>
 213         <manvolnum>5</manvolnum></citerefentry></para>
 214 </refsect1>
 215
 216 <refsect1>
 217         <title>AUTHOR</title>
 218
 219         <para>The original Samba software and related utilities
 220         were created by Andrew Tridgell. Samba is now developed
 221         by the Samba Team as an Open Source project similar
 222         to the way the Linux kernel is developed.</para>
 223
 224         <para>The original Samba man pages were written by Karl Auer.
 225         The man page sources were converted to YODL format (another
 226         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 227         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 228         release by Jeremy Allison.  The conversion to DocBook for
 229         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
 230         Samba 3.0 was done by Alexander Bokovoy.</para>
 231 </refsect1>
 232
 233 </refentry>