docs/manpages/swat.8

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