1SWAT(8)                   System Administration tools                  SWAT(8)
2
3
4

NAME

6       swat - Samba Web Administration Tool
7

SYNOPSIS

9       swat [-s <smb config file>] [-a] [-P]
10

DESCRIPTION

12       This tool is part of the samba(7) suite.
13
14       swat allows a Samba administrator to configure the complex smb.conf(5)
15       file via a Web browser. In addition, a swat configuration page has help
16       links to all the configurable options in the smb.conf file allowing an
17       administrator to easily look up the effects of any change.
18
19       swat is run from inetd
20

OPTIONS

22       -s smb configuration file
23           The default configuration file path is determined at compile time.
24           The file specified contains the configuration details required by
25           the smbd(8) server. This is the file that swat will modify. The
26           information in this file includes server-specific information such
27           as what printcap file to use, as well as descriptions of all the
28           services that the server is to provide. See smb.conf for more
29           information.
30
31       -a
32           This option disables authentication and places swat in demo mode.
33           In that mode anyone will be able to modify the smb.conf file.
34
35           WARNING: Do NOT enable this option on a production server.
36
37       -P
38           This option restricts read-only users to the password management
39           page.  swat can then be used to change user passwords without users
40           seeing the "View" and "Status" menu buttons.
41
42       -d|--debuglevel=level
43           level is an integer from 0 to 10. The default value if this
44           parameter is not specified is 0.
45
46           The higher this value, the more detail will be logged to the log
47           files about the activities of the server. At level 0, only critical
48           errors and serious warnings will be logged. Level 1 is a reasonable
49           level for day-to-day running - it generates a small amount of
50           information about operations carried out.
51
52           Levels above 1 will generate considerable amounts of log data, and
53           should only be used when investigating a problem. Levels above 3
54           are designed for use only by developers and generate HUGE amounts
55           of log data, most of which is extremely cryptic.
56
57           Note that specifying this parameter here will override the
58           smb.conf.5.html# parameter in the smb.conf file.
59
60       -V|--version
61           Prints the program version number.
62
63       -s|--configfile <configuration file>
64           The file specified contains the configuration details required by
65           the server. The information in this file includes server-specific
66           information such as what printcap file to use, as well as
67           descriptions of all the services that the server is to provide. See
68           smb.conf for more information. The default configuration file name
69           is determined at compile time.
70
71       -l|--log-basename=logdirectory
72           Base directory name for log/debug files. The extension ".progname"
73           will be appended (e.g. log.smbclient, log.smbd, etc...). The log
74           file is never removed by the client.
75
76       -h|--help
77           Print a summary of command line options.
78

INSTALLATION

80       Swat is included as binary package with most distributions. The package
81       manager in this case takes care of the installation and configuration.
82       This section is only for those who have compiled swat from scratch.
83
84       After you compile SWAT you need to run make install to install the swat
85       binary and the various help files and images. A default install would
86       put these in:
87
88       ·   /usr/local/samba/sbin/swat
89
90       ·   /usr/local/samba/swat/images/*
91
92       ·   /usr/local/samba/swat/help/*
93
94
95   Inetd Installation
96       You need to edit your /etc/inetd.conf and /etc/services to enable SWAT
97       to be launched via inetd.
98
99       In /etc/services you need to add a line like this:
100
101       swat 901/tcp
102
103       Note for NIS/YP and LDAP users - you may need to rebuild the NIS
104       service maps rather than alter your local /etc/services file.
105
106       the choice of port number isn´t really important except that it should
107       be less than 1024 and not currently used (using a number above 1024
108       presents an obscure security hole depending on the implementation
109       details of your inetd daemon).
110
111       In /etc/inetd.conf you should add a line like this:
112
113       swat stream tcp nowait.400 root /usr/local/samba/sbin/swat swat
114
115       Once you have edited /etc/services and /etc/inetd.conf you need to send
116       a HUP signal to inetd. To do this use kill -1 PID where PID is the
117       process ID of the inetd daemon.
118

LAUNCHING

120       To launch SWAT just run your favorite web browser and point it at
121       "http://localhost:901/".
122
123       Note that you can attach to SWAT from any IP connected machine but
124       connecting from a remote machine leaves your connection open to
125       password sniffing as passwords will be sent in the clear over the wire.
126

FILES

128       /etc/inetd.conf
129           This file must contain suitable startup information for the
130           meta-daemon.
131
132       /etc/services
133           This file must contain a mapping of service name (e.g., swat) to
134           service port (e.g., 901) and protocol type (e.g., tcp).
135
136       /usr/local/samba/lib/smb.conf
137           This is the default location of the smb.conf(5) server
138           configuration file that swat edits. Other common places that
139           systems install this file are /usr/samba/lib/smb.conf and
140           /etc/smb.conf. This file describes all the services the server is
141           to make available to clients.
142

WARNINGS

144       swat will rewrite your smb.conf(5) file. It will rearrange the entries
145       and delete all comments, include= and copy= options. If you have a
146       carefully crafted smb.conf then back it up or don´t use swat!
147

VERSION

149       This man page is correct for version 3 of the Samba suite.
150

SEE ALSO

152       inetd(5), smbd(8), smb.conf(5)
153

AUTHOR

155       The original Samba software and related utilities were created by
156       Andrew Tridgell. Samba is now developed by the Samba Team as an Open
157       Source project similar to the way the Linux kernel is developed.
158
159       The original Samba man pages were written by Karl Auer. The man page
160       sources were converted to YODL format (another excellent piece of Open
161       Source software, available at ftp://ftp.icce.rug.nl/pub/unix/) and
162       updated for the Samba 2.0 release by Jeremy Allison. The conversion to
163       DocBook for Samba 2.2 was done by Gerald Carter. The conversion to
164       DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.
165
166
167
168Samba 3.5                         08/02/2011                           SWAT(8)
Impressum