docs/manpages/swat.8

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