| 1 | '\" t
|
|---|
| 2 | .\" Title: swat
|
|---|
| 3 | .\" Author: [see the "AUTHOR" section]
|
|---|
| 4 | .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
|---|
| 5 | .\" Date: 11/01/2012
|
|---|
| 6 | .\" Manual: System Administration tools
|
|---|
| 7 | .\" Source: Samba 3.5
|
|---|
| 8 | .\" Language: English
|
|---|
| 9 | .\"
|
|---|
| 10 | .TH "SWAT" "8" "11/01/2012" "Samba 3\&.5" "System Administration tools"
|
|---|
| 11 | .\" -----------------------------------------------------------------
|
|---|
| 12 | .\" * set default formatting
|
|---|
| 13 | .\" -----------------------------------------------------------------
|
|---|
| 14 | .\" disable hyphenation
|
|---|
| 15 | .nh
|
|---|
| 16 | .\" disable justification (adjust text to left margin only)
|
|---|
| 17 | .ad l
|
|---|
| 18 | .\" -----------------------------------------------------------------
|
|---|
| 19 | .\" * MAIN CONTENT STARTS HERE *
|
|---|
| 20 | .\" -----------------------------------------------------------------
|
|---|
| 21 | .SH "NAME"
|
|---|
| 22 | swat \- Samba Web Administration Tool
|
|---|
| 23 | .SH "SYNOPSIS"
|
|---|
| 24 | .HP \w'\ 'u
|
|---|
| 25 | swat [\-s\ <smb\ config\ file>] [\-a] [\-P]
|
|---|
| 26 | .SH "DESCRIPTION"
|
|---|
| 27 | .PP
|
|---|
| 28 | This tool is part of the
|
|---|
| 29 | \fBsamba\fR(7)
|
|---|
| 30 | suite\&.
|
|---|
| 31 | .PP
|
|---|
| 32 | swat
|
|---|
| 33 | allows a Samba administrator to configure the complex
|
|---|
| 34 | \fBsmb.conf\fR(5)
|
|---|
| 35 | file via a Web browser\&. In addition, a
|
|---|
| 36 | swat
|
|---|
| 37 | configuration page has help links to all the configurable options in the
|
|---|
| 38 | smb\&.conf
|
|---|
| 39 | file allowing an administrator to easily look up the effects of any change\&.
|
|---|
| 40 | .PP
|
|---|
| 41 | swat
|
|---|
| 42 | is run from
|
|---|
| 43 | inetd
|
|---|
| 44 | .SH "OPTIONS"
|
|---|
| 45 | .PP
|
|---|
| 46 | \-s smb configuration file
|
|---|
| 47 | .RS 4
|
|---|
| 48 | The default configuration file path is determined at compile time\&. The file specified contains the configuration details required by the
|
|---|
| 49 | \fBsmbd\fR(8)
|
|---|
| 50 | server\&. This is the file that
|
|---|
| 51 | swat
|
|---|
| 52 | 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
|
|---|
| 53 | smb\&.conf
|
|---|
| 54 | for more information\&.
|
|---|
| 55 | .RE
|
|---|
| 56 | .PP
|
|---|
| 57 | \-a
|
|---|
| 58 | .RS 4
|
|---|
| 59 | This option disables authentication and places
|
|---|
| 60 | swat
|
|---|
| 61 | in demo mode\&. In that mode anyone will be able to modify the
|
|---|
| 62 | smb\&.conf
|
|---|
| 63 | file\&.
|
|---|
| 64 | .sp
|
|---|
| 65 | \fIWARNING: Do NOT enable this option on a production server\&. \fR
|
|---|
| 66 | .RE
|
|---|
| 67 | .PP
|
|---|
| 68 | \-P
|
|---|
| 69 | .RS 4
|
|---|
| 70 | This option restricts read\-only users to the password management page\&.
|
|---|
| 71 | swat
|
|---|
| 72 | can then be used to change user passwords without users seeing the "View" and "Status" menu buttons\&.
|
|---|
| 73 | .RE
|
|---|
| 74 | .PP
|
|---|
| 75 | \-d|\-\-debuglevel=level
|
|---|
| 76 | .RS 4
|
|---|
| 77 | \fIlevel\fR
|
|---|
| 78 | is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
|
|---|
| 79 | .sp
|
|---|
| 80 | 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\&.
|
|---|
| 81 | .sp
|
|---|
| 82 | 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\&.
|
|---|
| 83 | .sp
|
|---|
| 84 | Note that specifying this parameter here will override the
|
|---|
| 85 | \m[blue]\fB\%smb.conf.5.html#\fR\m[]
|
|---|
| 86 | parameter in the
|
|---|
| 87 | smb\&.conf
|
|---|
| 88 | file\&.
|
|---|
| 89 | .RE
|
|---|
| 90 | .PP
|
|---|
| 91 | \-V|\-\-version
|
|---|
| 92 | .RS 4
|
|---|
| 93 | Prints the program version number\&.
|
|---|
| 94 | .RE
|
|---|
| 95 | .PP
|
|---|
| 96 | \-s|\-\-configfile <configuration file>
|
|---|
| 97 | .RS 4
|
|---|
| 98 | 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
|
|---|
| 99 | smb\&.conf
|
|---|
| 100 | for more information\&. The default configuration file name is determined at compile time\&.
|
|---|
| 101 | .RE
|
|---|
| 102 | .PP
|
|---|
| 103 | \-l|\-\-log\-basename=logdirectory
|
|---|
| 104 | .RS 4
|
|---|
| 105 | Base directory name for log/debug files\&. The extension
|
|---|
| 106 | \fB"\&.progname"\fR
|
|---|
| 107 | will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
|
|---|
| 108 | .RE
|
|---|
| 109 | .PP
|
|---|
| 110 | \-h|\-\-help
|
|---|
| 111 | .RS 4
|
|---|
| 112 | Print a summary of command line options\&.
|
|---|
| 113 | .RE
|
|---|
| 114 | .SH "INSTALLATION"
|
|---|
| 115 | .PP
|
|---|
| 116 | 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\&.
|
|---|
| 117 | .PP
|
|---|
| 118 | After you compile SWAT you need to run
|
|---|
| 119 | make install
|
|---|
| 120 | to install the
|
|---|
| 121 | swat
|
|---|
| 122 | binary and the various help files and images\&. A default install would put these in:
|
|---|
| 123 | .sp
|
|---|
| 124 | .RS 4
|
|---|
| 125 | .ie n \{\
|
|---|
| 126 | \h'-04'\(bu\h'+03'\c
|
|---|
| 127 | .\}
|
|---|
| 128 | .el \{\
|
|---|
| 129 | .sp -1
|
|---|
| 130 | .IP \(bu 2.3
|
|---|
| 131 | .\}
|
|---|
| 132 | /usr/local/samba/sbin/swat
|
|---|
| 133 | .RE
|
|---|
| 134 | .sp
|
|---|
| 135 | .RS 4
|
|---|
| 136 | .ie n \{\
|
|---|
| 137 | \h'-04'\(bu\h'+03'\c
|
|---|
| 138 | .\}
|
|---|
| 139 | .el \{\
|
|---|
| 140 | .sp -1
|
|---|
| 141 | .IP \(bu 2.3
|
|---|
| 142 | .\}
|
|---|
| 143 | /usr/local/samba/swat/images/*
|
|---|
| 144 | .RE
|
|---|
| 145 | .sp
|
|---|
| 146 | .RS 4
|
|---|
| 147 | .ie n \{\
|
|---|
| 148 | \h'-04'\(bu\h'+03'\c
|
|---|
| 149 | .\}
|
|---|
| 150 | .el \{\
|
|---|
| 151 | .sp -1
|
|---|
| 152 | .IP \(bu 2.3
|
|---|
| 153 | .\}
|
|---|
| 154 | /usr/local/samba/swat/help/*
|
|---|
| 155 | .sp
|
|---|
| 156 | .RE
|
|---|
| 157 | .SS "Inetd Installation"
|
|---|
| 158 | .PP
|
|---|
| 159 | You need to edit your
|
|---|
| 160 | /etc/inetd\&.conf
|
|---|
| 161 | and
|
|---|
| 162 | /etc/services
|
|---|
| 163 | to enable SWAT to be launched via
|
|---|
| 164 | inetd\&.
|
|---|
| 165 | .PP
|
|---|
| 166 | In
|
|---|
| 167 | /etc/services
|
|---|
| 168 | you need to add a line like this:
|
|---|
| 169 | .PP
|
|---|
| 170 | swat 901/tcp
|
|---|
| 171 | .PP
|
|---|
| 172 | Note for NIS/YP and LDAP users \- you may need to rebuild the NIS service maps rather than alter your local
|
|---|
| 173 | /etc/services
|
|---|
| 174 | file\&.
|
|---|
| 175 | .PP
|
|---|
| 176 | 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
|
|---|
| 177 | inetd
|
|---|
| 178 | daemon)\&.
|
|---|
| 179 | .PP
|
|---|
| 180 | In
|
|---|
| 181 | /etc/inetd\&.conf
|
|---|
| 182 | you should add a line like this:
|
|---|
| 183 | .PP
|
|---|
| 184 | swat stream tcp nowait\&.400 root /usr/local/samba/sbin/swat swat
|
|---|
| 185 | .PP
|
|---|
| 186 | Once you have edited
|
|---|
| 187 | /etc/services
|
|---|
| 188 | and
|
|---|
| 189 | /etc/inetd\&.conf
|
|---|
| 190 | you need to send a HUP signal to inetd\&. To do this use
|
|---|
| 191 | kill \-1 PID
|
|---|
| 192 | where PID is the process ID of the inetd daemon\&.
|
|---|
| 193 | .SH "LAUNCHING"
|
|---|
| 194 | .PP
|
|---|
| 195 | To launch SWAT just run your favorite web browser and point it at "http://localhost:901/"\&.
|
|---|
| 196 | .PP
|
|---|
| 197 | 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\&.
|
|---|
| 198 | .SH "FILES"
|
|---|
| 199 | .PP
|
|---|
| 200 | /etc/inetd\&.conf
|
|---|
| 201 | .RS 4
|
|---|
| 202 | This file must contain suitable startup information for the meta\-daemon\&.
|
|---|
| 203 | .RE
|
|---|
| 204 | .PP
|
|---|
| 205 | /etc/services
|
|---|
| 206 | .RS 4
|
|---|
| 207 | This file must contain a mapping of service name (e\&.g\&., swat) to service port (e\&.g\&., 901) and protocol type (e\&.g\&., tcp)\&.
|
|---|
| 208 | .RE
|
|---|
| 209 | .PP
|
|---|
| 210 | /usr/local/samba/lib/smb\&.conf
|
|---|
| 211 | .RS 4
|
|---|
| 212 | This is the default location of the
|
|---|
| 213 | \fBsmb.conf\fR(5)
|
|---|
| 214 | server configuration file that swat edits\&. Other common places that systems install this file are
|
|---|
| 215 | /usr/samba/lib/smb\&.conf
|
|---|
| 216 | and
|
|---|
| 217 | /etc/smb\&.conf\&. This file describes all the services the server is to make available to clients\&.
|
|---|
| 218 | .RE
|
|---|
| 219 | .SH "WARNINGS"
|
|---|
| 220 | .PP
|
|---|
| 221 | swat
|
|---|
| 222 | will rewrite your
|
|---|
| 223 | \fBsmb.conf\fR(5)
|
|---|
| 224 | file\&. It will rearrange the entries and delete all comments,
|
|---|
| 225 | \fIinclude=\fR
|
|---|
| 226 | and
|
|---|
| 227 | \fIcopy= \fR
|
|---|
| 228 | options\&. If you have a carefully crafted
|
|---|
| 229 | smb\&.conf
|
|---|
| 230 | then back it up or don\'t use swat!
|
|---|
| 231 | .SH "VERSION"
|
|---|
| 232 | .PP
|
|---|
| 233 | This man page is correct for version 3 of the Samba suite\&.
|
|---|
| 234 | .SH "SEE ALSO"
|
|---|
| 235 | .PP
|
|---|
| 236 | inetd(5),
|
|---|
| 237 | \fBsmbd\fR(8),
|
|---|
| 238 | \fBsmb.conf\fR(5)
|
|---|
| 239 | .SH "AUTHOR"
|
|---|
| 240 | .PP
|
|---|
| 241 | 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\&.
|
|---|
| 242 | .PP
|
|---|
| 243 | 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
|
|---|
| 244 | 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\&.
|
|---|
