docs/manpages/swat.8

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "SWAT" 8 "" "" ""
  21 .SH NAME
  22 swat \- Samba Web Administration Tool
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fBswat\fR [-s <smb config file>] [-a]
  27 .fi
  28
  29 .SH "DESCRIPTION"
  30
  31 .PP
  32 This tool is part of the \fBSamba\fR(7) suite\&.
  33
  34 .PP
  35 \fBswat\fR allows a Samba administrator to configure the complex \fBsmb.conf\fR(5) file via a Web browser\&. In addition, a \fBswat\fR configuration page has help links to all the configurable options in the \fIsmb\&.conf\fR file allowing an administrator to easily look up the effects of any change\&.
  36
  37 .PP
  38 \fBswat\fR is run from \fBinetd\fR
  39
  40 .SH "OPTIONS"
  41
  42 .TP
  43 -s smb configuration file
  44 The default configuration file path is determined at compile time\&. The file specified contains the configuration details required by the \fBsmbd\fR(8) server\&. This is the file that \fBswat\fR will modify\&. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See \fIsmb\&.conf\fR for more information\&.
  45
  46
  47 .TP
  48 -a
  49 This option disables authentication and puts \fBswat\fR in demo mode\&. In that mode anyone will be able to modify the \fIsmb\&.conf\fR file\&.
  50
  51
  52 \fBWARNING: Do NOT enable this option on a production server\&. \fR
  53
  54
  55 .TP
  56 -V
  57 Prints the version number for \fBsmbd\fR\&.
  58
  59
  60 .TP
  61 -s <configuration file>
  62 The file specified contains the configuration details required by the server\&. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See \fI smb\&.conf(5)\fR for more information\&. The default configuration file name is determined at compile time\&.
  63
  64
  65 .TP
  66 -d|--debug=debuglevel
  67 \fIdebuglevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
  68
  69
  70 The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day to day running - it generates a small amount of information about operations carried out\&.
  71
  72
  73 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
  74
  75
  76 Note that specifying this parameter here will override the log level parameter in the \fIsmb\&.conf(5)\fR file\&.
  77
  78
  79 .TP
  80 -l|--logfile=logbasename
  81 File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&.
  82
  83
  84 .TP
  85 -h|--help
  86 Print a summary of command line options\&.
  87
  88
  89 .SH "INSTALLATION"
  90
  91 .PP
  92 Swat is included as binary package with most distributions\&. The package manager in this case takes care of the installation and configuration\&. This section is only for those who have compiled swat from scratch\&.
  93
  94 .PP
  95 After you compile SWAT you need to run \fBmake install \fR to install the \fBswat\fR binary and the various help files and images\&. A default install would put these in:
  96
  97 .TP 3
  98 \(bu
  99 /usr/local/samba/bin/swat
 100
 101 .TP
 102 \(bu
 103 /usr/local/samba/swat/images/*
 104
 105 .TP
 106 \(bu
 107 /usr/local/samba/swat/help/*
 108
 109 .LP
 110
 111 .SS "Inetd Installation"
 112
 113 .PP
 114 You need to edit your \fI/etc/inetd\&.conf \fR and \fI/etc/services\fR to enable SWAT to be launched via \fBinetd\fR\&.
 115
 116 .PP
 117 In \fI/etc/services\fR you need to add a line like this:
 118
 119 .PP
 120 \fBswat 901/tcp\fR
 121
 122 .PP
 123 Note for NIS/YP and LDAP users - you may need to rebuild the NIS service maps rather than alter your local \fI /etc/services\fR file\&.
 124
 125 .PP
 126 the choice of port number isn't really important except that it should be less than 1024 and not currently used (using a number above 1024 presents an obscure security hole depending on the implementation details of your\fBinetd\fR daemon)\&.
 127
 128 .PP
 129 In \fI/etc/inetd\&.conf\fR you should add a line like this:
 130
 131 .PP
 132 \fBswat stream tcp nowait.400 root /usr/local/samba/bin/swat swat\fR
 133
 134 .PP
 135 One you have edited \fI/etc/services\fR and \fI/etc/inetd\&.conf\fR you need to send a HUP signal to inetd\&. To do this use \fBkill -1 PID \fR where PID is the process ID of the inetd daemon\&.
 136
 137 .SH "LAUNCHING"
 138
 139 .PP
 140 To launch SWAT just run your favorite web browser and point it at "http://localhost:901/"\&.
 141
 142 .PP
 143 Note that you can attach to SWAT from any IP connected machine but connecting from a remote machine leaves your connection open to password sniffing as passwords will be sent in the clear over the wire\&.
 144
 145 .SH "FILES"
 146
 147 .TP
 148 \fI/etc/inetd\&.conf\fR
 149 This file must contain suitable startup information for the meta-daemon\&.
 150
 151
 152 .TP
 153 \fI/etc/services\fR
 154 This file must contain a mapping of service name (e\&.g\&., swat) to service port (e\&.g\&., 901) and protocol type (e\&.g\&., tcp)\&.
 155
 156
 157 .TP
 158 \fI/usr/local/samba/lib/smb\&.conf\fR
 159 This is the default location of the \fBsmb.conf\fR(5) server configuration file that swat edits\&. Other common places that systems install this file are \fI /usr/samba/lib/smb\&.conf\fR and \fI/etc/smb\&.conf \fR\&. This file describes all the services the server is to make available to clients\&.
 160
 161
 162 .SH "WARNINGS"
 163
 164 .PP
 165 \fBswat\fR will rewrite your \fBsmb.conf\fR(5) file\&. It will rearrange the entries and delete all comments, \fIinclude=\fR and \fIcopy= \fR options\&. If you have a carefully crafted \fI smb\&.conf\fR then back it up or don't use swat!
 166
 167 .SH "VERSION"
 168
 169 .PP
 170 This man page is correct for version 3\&.0 of the Samba suite\&.
 171
 172 .SH "SEE ALSO"
 173
 174 .PP
 175 \fBinetd(5)\fR, \fBsmbd\fR(8), \fBsmb.conf\fR(5)
 176
 177 .SH "AUTHOR"
 178
 179 .PP
 180 The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
 181
 182 .PP
 183 The original Samba man pages were written by Karl Auer\&. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at ftp://ftp\&.icce\&.rug\&.nl/pub/unix/) and updated for the Samba 2\&.0 release by Jeremy Allison\&. The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
 184