| 1 | .\" Title: swat
|
|---|
| 2 | .\" Author:
|
|---|
| 3 | .\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
|
|---|
| 4 | .\" Date: 08/27/2008
|
|---|
| 5 | .\" Manual: System Administration tools
|
|---|
| 6 | .\" Source: Samba 3.2
|
|---|
| 7 | .\"
|
|---|
| 8 | .TH "SWAT" "8" "08/27/2008" "Samba 3\.2" "System Administration tools"
|
|---|
| 9 | .\" disable hyphenation
|
|---|
| 10 | .nh
|
|---|
| 11 | .\" disable justification (adjust text to left margin only)
|
|---|
| 12 | .ad l
|
|---|
| 13 | .SH "NAME"
|
|---|
| 14 | swat - Samba Web Administration Tool
|
|---|
| 15 | .SH "SYNOPSIS"
|
|---|
| 16 | .HP 1
|
|---|
| 17 | swat [\-s\ <smb\ config\ file>] [\-a] [\-P]
|
|---|
| 18 | .SH "DESCRIPTION"
|
|---|
| 19 | .PP
|
|---|
| 20 | This tool is part of the
|
|---|
| 21 | \fBsamba\fR(7)
|
|---|
| 22 | suite\.
|
|---|
| 23 | .PP
|
|---|
| 24 | swat
|
|---|
| 25 | allows a Samba administrator to configure the complex
|
|---|
| 26 | \fBsmb.conf\fR(5)
|
|---|
| 27 | file via a Web browser\. In addition, a
|
|---|
| 28 | swat
|
|---|
| 29 | configuration page has help links to all the configurable options in the
|
|---|
| 30 | \fIsmb\.conf\fR
|
|---|
| 31 | file allowing an administrator to easily look up the effects of any change\.
|
|---|
| 32 | .PP
|
|---|
| 33 | swat
|
|---|
| 34 | is run from
|
|---|
| 35 | inetd
|
|---|
| 36 | .SH "OPTIONS"
|
|---|
| 37 | .PP
|
|---|
| 38 | \-s smb configuration file
|
|---|
| 39 | .RS 4
|
|---|
| 40 | The default configuration file path is determined at compile time\. The file specified contains the configuration details required by the
|
|---|
| 41 | \fBsmbd\fR(8)
|
|---|
| 42 | server\. This is the file that
|
|---|
| 43 | swat
|
|---|
| 44 | 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
|
|---|
| 45 | \fIsmb\.conf\fR
|
|---|
| 46 | for more information\.
|
|---|
| 47 | .RE
|
|---|
| 48 | .PP
|
|---|
| 49 | \-a
|
|---|
| 50 | .RS 4
|
|---|
| 51 | This option disables authentication and places
|
|---|
| 52 | swat
|
|---|
| 53 | in demo mode\. In that mode anyone will be able to modify the
|
|---|
| 54 | \fIsmb\.conf\fR
|
|---|
| 55 | file\.
|
|---|
| 56 | .sp
|
|---|
| 57 | \fIWARNING: Do NOT enable this option on a production server\. \fR
|
|---|
| 58 | .RE
|
|---|
| 59 | .PP
|
|---|
| 60 | \-P
|
|---|
| 61 | .RS 4
|
|---|
| 62 | This option restricts read\-only users to the password management page\.
|
|---|
| 63 | swat
|
|---|
| 64 | can then be used to change user passwords without users seeing the "View" and "Status" menu buttons\.
|
|---|
| 65 | .RE
|
|---|
| 66 | .PP
|
|---|
| 67 | \-d|\-\-debuglevel=level
|
|---|
| 68 | .RS 4
|
|---|
| 69 | \fIlevel\fR
|
|---|
| 70 | is an integer from 0 to 10\. The default value if this parameter is not specified is 0\.
|
|---|
| 71 | .sp
|
|---|
| 72 | 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\.
|
|---|
| 73 | .sp
|
|---|
| 74 | 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\.
|
|---|
| 75 | .sp
|
|---|
| 76 | Note that specifying this parameter here will override the
|
|---|
| 77 | \fIlog level\fR
|
|---|
| 78 | parameter in the
|
|---|
| 79 | \fIsmb\.conf\fR
|
|---|
| 80 | file\.
|
|---|
| 81 | .RE
|
|---|
| 82 | .PP
|
|---|
| 83 | \-V
|
|---|
| 84 | .RS 4
|
|---|
| 85 | Prints the program version number\.
|
|---|
| 86 | .RE
|
|---|
| 87 | .PP
|
|---|
| 88 | \-s <configuration file>
|
|---|
| 89 | .RS 4
|
|---|
| 90 | 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
|
|---|
| 91 | \fIsmb\.conf\fR
|
|---|
| 92 | for more information\. The default configuration file name is determined at compile time\.
|
|---|
| 93 | .RE
|
|---|
| 94 | .PP
|
|---|
| 95 | \-l|\-\-log\-basename=logdirectory
|
|---|
| 96 | .RS 4
|
|---|
| 97 | Base directory name for log/debug files\. The extension
|
|---|
| 98 | \fB"\.progname"\fR
|
|---|
| 99 | will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\.
|
|---|
| 100 | .RE
|
|---|
| 101 | .PP
|
|---|
| 102 | \-h|\-\-help
|
|---|
| 103 | .RS 4
|
|---|
| 104 | Print a summary of command line options\.
|
|---|
| 105 | .RE
|
|---|
| 106 | .SH "INSTALLATION"
|
|---|
| 107 | .PP
|
|---|
| 108 | 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\.
|
|---|
| 109 | .PP
|
|---|
| 110 | After you compile SWAT you need to run
|
|---|
| 111 | make install
|
|---|
| 112 | to install the
|
|---|
| 113 | swat
|
|---|
| 114 | binary and the various help files and images\. A default install would put these in:
|
|---|
| 115 | .sp
|
|---|
| 116 | .RS 4
|
|---|
| 117 | .ie n \{\
|
|---|
| 118 | \h'-04'\(bu\h'+03'\c
|
|---|
| 119 | .\}
|
|---|
| 120 | .el \{\
|
|---|
| 121 | .sp -1
|
|---|
| 122 | .IP \(bu 2.3
|
|---|
| 123 | .\}
|
|---|
| 124 | /usr/local/samba/sbin/swat
|
|---|
| 125 | .RE
|
|---|
| 126 | .sp
|
|---|
| 127 | .RS 4
|
|---|
| 128 | .ie n \{\
|
|---|
| 129 | \h'-04'\(bu\h'+03'\c
|
|---|
| 130 | .\}
|
|---|
| 131 | .el \{\
|
|---|
| 132 | .sp -1
|
|---|
| 133 | .IP \(bu 2.3
|
|---|
| 134 | .\}
|
|---|
| 135 | /usr/local/samba/swat/images/*
|
|---|
| 136 | .RE
|
|---|
| 137 | .sp
|
|---|
| 138 | .RS 4
|
|---|
| 139 | .ie n \{\
|
|---|
| 140 | \h'-04'\(bu\h'+03'\c
|
|---|
| 141 | .\}
|
|---|
| 142 | .el \{\
|
|---|
| 143 | .sp -1
|
|---|
| 144 | .IP \(bu 2.3
|
|---|
| 145 | .\}
|
|---|
| 146 | /usr/local/samba/swat/help/*
|
|---|
| 147 | .sp
|
|---|
| 148 | .RE
|
|---|
| 149 | .SS "Inetd Installation"
|
|---|
| 150 | .PP
|
|---|
| 151 | You need to edit your
|
|---|
| 152 | \fI/etc/inetd\.conf \fR
|
|---|
| 153 | and
|
|---|
| 154 | \fI/etc/services\fR
|
|---|
|
|---|
