docs/manpages/swat.8

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