2 .\" Author: [see the "AUTHOR" section]
3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
5 .\" Manual: System Administration tools
9 .TH "SWAT" "8" "09/30/2009" "Samba 3\&.0" "System Administration tools"
10 .\" -----------------------------------------------------------------
11 .\" * (re)Define some macros
12 .\" -----------------------------------------------------------------
13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 .\" toupper - uppercase a string (locale-aware)
15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" SH-xref - format a cross-reference to an SH section
23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 .\" SH - level-one heading that works better for non-TTY output
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36 .\" put an extra blank line of space above the head in non-TTY output
43 .nr an-prevailing-indent \\n[IN]
47 .HTML-TAG ".NH \\n[an-level]"
49 .nr an-no-space-flag 1
51 \." make the size of the head bigger
56 .\" if n (TTY output), use uppercase
61 .\" if not n (not TTY), use normal case (not uppercase)
65 .\" if not n (not TTY), put a border/line under subheading
70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 .\" SS - level-two heading that works better for non-TTY output
72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77 .nr an-prevailing-indent \\n[IN]
82 .nr an-no-space-flag 1
85 \." make the size of the head bigger
91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 .\" BB/BE - put background/screen (filled box) around block of text
93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106 .if "\\$2"adjust-for-leading-newline" \{\
114 .nr BW \\n(.lu-\\n(.i
117 .ie "\\$2"adjust-for-leading-newline" \{\
118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 .\" BM/EM - put colored marker in margin next to block of text
134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
159 .\" -----------------------------------------------------------------
160 .\" * set default formatting
161 .\" -----------------------------------------------------------------
162 .\" disable hyphenation
164 .\" disable justification (adjust text to left margin only)
166 .\" -----------------------------------------------------------------
167 .\" * MAIN CONTENT STARTS HERE *
168 .\" -----------------------------------------------------------------
170 swat \- Samba Web Administration Tool
174 \FCswat\F[] [\-s\ <smb\ config\ file>] [\-a] [\-P]
178 This tool is part of the
183 allows a Samba administrator to configure the complex
185 file via a Web browser\&. In addition, a
187 configuration page has help links to all the configurable options in the
189 file allowing an administrator to easily look up the effects of any change\&.
196 \-s smb configuration file
198 The default configuration file path is determined at compile time\&. The file specified contains the configuration details required by the
200 server\&. This is the file that
202 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
204 for more information\&.
209 This option disables authentication and places
211 in demo mode\&. In that mode anyone will be able to modify the
215 \fIWARNING: Do NOT enable this option on a production server\&. \fR
220 This option restricts read\-only users to the password management page\&.
222 can then be used to change user passwords without users seeing the "View" and "Status" menu buttons\&.
225 \-d|\-\-debuglevel=level
228 is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
230 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\&.
232 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\&.
234 Note that specifying this parameter here will override the
235 \m[blue]\fBlog level\fR\m[]
243 Prints the program version number\&.
246 \-s <configuration file>
248 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
250 for more information\&. The default configuration file name is determined at compile time\&.
253 \-l|\-\-log\-basename=logdirectory
255 Base directory name for log/debug files\&. The extension
257 will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
262 Print a summary of command line options\&.
266 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\&.
268 After you compile SWAT you need to run
272 binary and the various help files and images\&. A default install would put these in:
282 /usr/local/samba/sbin/swat
293 /usr/local/samba/swat/images/*
304 /usr/local/samba/swat/help/*
307 .SS "Inetd Installation"
309 You need to edit your
310 \FC/etc/inetd\&.conf \F[]
313 to enable SWAT to be launched via
318 you need to add a line like this:
322 Note for NIS/YP and LDAP users \- you may need to rebuild the NIS service maps rather than alter your local
323 \FC /etc/services\F[]
326 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
331 \FC/etc/inetd\&.conf\F[]
332 you should add a line like this:
334 \FCswat stream tcp nowait\&.400 root /usr/local/samba/sbin/swat swat\F[]
339 \FC/etc/inetd\&.conf\F[]
340 you need to send a HUP signal to inetd\&. To do this use
342 where PID is the process ID of the inetd daemon\&.
345 To launch SWAT just run your favorite web browser and point it at "http://localhost:901/"\&.
347 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\&.
350 \FC/etc/inetd\&.conf\F[]
352 This file must contain suitable startup information for the meta\-daemon\&.
357 This file must contain a mapping of service name (e\&.g\&., swat) to service port (e\&.g\&., 901) and protocol type (e\&.g\&., tcp)\&.
360 \FC/usr/local/samba/lib/smb\&.conf\F[]
362 This is the default location of the
364 server configuration file that swat edits\&. Other common places that systems install this file are
365 \FC /usr/samba/lib/smb\&.conf\F[]
367 \FC/etc/smb\&.conf \F[]\&. This file describes all the services the server is to make available to clients\&.
374 file\&. It will rearrange the entries and delete all comments,
378 options\&. If you have a carefully crafted
380 then back it up or don\'t use swat!
383 This man page is correct for version 3\&.0 of the Samba suite\&.
391 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\&.
393 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
394 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\&.