git.maemo.org Git - samba/blob - 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 .ad l
  25 .hy 0
  26 .HP 5
  27 \fBswat\fR [\-s\ <smb\ config\ file>] [\-a] [\-P]
  28 .ad
  29 .hy
  30
  31 .SH "DESCRIPTION"
  32
  33 .PP
  34 This tool is part of the \fBsamba\fR(7) suite\&.
  35
  36 .PP
  37 \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\&.
  38
  39 .PP
  40 \fBswat\fR is run from \fBinetd\fR
  41
  42 .SH "OPTIONS"
  43
  44 .TP
  45 \-s smb configuration file
  46 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\&.
  47
  48 .TP
  49 \-a
  50 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\&.
  51
  52 \fBWARNING: Do NOT enable this option on a production server\&. \fR
  53
  54 .TP
  55 \-P
  56 This option restricts read\-only users to the password management page\&. \fBswat\fR can then be used to change user passwords without users seeing the "View" and "Status" menu buttons\&.
  57
  58 .TP
  59 \-V
  60 Prints the program version number\&.
  61
  62 .TP
  63 \-s <configuration file>
  64 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 \fIsmb\&.conf\fR for more information\&. The default configuration file name is determined at compile time\&.
  65
  66 .TP
  67 \-d|\-\-debuglevel=level
  68 \fIlevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
  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 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\&.
  73
  74 Note that specifying this parameter here will override the  parameter in the \fIsmb\&.conf\fR file\&.
  75
  76 .TP
  77 \-l|\-\-logfile=logdirectory
  78 Base directory name for log/debug files\&. The extension \fB"\&.progname"\fR will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
  79
  80 .TP
  81 \-h|\-\-help
  82 Print a summary of command line options\&.
  83
  84 .SH "INSTALLATION"
  85
  86 .PP
  87 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\&.
  88
  89 .PP
  90 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:
  91
  92 .TP 3
  93 \(bu
  94 /usr/local/samba/sbin/swat
  95 .TP
  96 \(bu
  97 /usr/local/samba/swat/images/*
  98 .TP
  99 \(bu
 100 /usr/local/samba/swat/help/*
 101 .LP
 102
 103 .SS "Inetd Installation"
 104
 105 .PP
 106 You need to edit your \fI/etc/inetd\&.conf \fR and \fI/etc/services\fR to enable SWAT to be launched via \fBinetd\fR\&.
 107
 108 .PP
 109 In \fI/etc/services\fR you need to add a line like this:
 110
 111 .PP
 112 \fBswat 901/tcp\fR
 113
 114 .PP
 115 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\&.
 116
 117 .PP
 118 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)\&.
 119
 120 .PP
 121 In \fI/etc/inetd\&.conf\fR you should add a line like this:
 122
 123 .PP
 124 \fBswat stream tcp nowait\&.400 root /usr/local/samba/sbin/swat swat\fR
 125
 126 .PP
 127 Once 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\&.
 128
 129 .SH "LAUNCHING"
 130
 131 .PP
 132 To launch SWAT just run your favorite web browser and point it at "http://localhost:901/"\&.
 133
 134 .PP
 135 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\&.
 136
 137 .SH "FILES"
 138
 139 .TP
 140 \fI/etc/inetd\&.conf\fR
 141 This file must contain suitable startup information for the meta\-daemon\&.
 142
 143 .TP
 144 \fI/etc/services\fR
 145 This file must contain a mapping of service name (e\&.g\&., swat) to service port (e\&.g\&., 901) and protocol type (e\&.g\&., tcp)\&.
 146
 147 .TP
 148 \fI/usr/local/samba/lib/smb\&.conf\fR
 149 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\&.
 150
 151 .SH "WARNINGS"
 152
 153 .PP
 154 \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!
 155
 156 .SH "VERSION"
 157
 158 .PP
 159 This man page is correct for version 3\&.0 of the Samba suite\&.
 160
 161 .SH "SEE ALSO"
 162
 163 .PP
 164 \fBinetd(5)\fR, \fBsmbd\fR(8), \fBsmb\&.conf\fR(5)
 165
 166 .SH "AUTHOR"
 167
 168 .PP
 169 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\&.
 170
 171 .PP
 172 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\&.
 173