summaryrefslogtreecommitdiff
path: root/docs/docbook/projdoc/SWAT.sgml
blob: 763872d56795c905bda3efaf2abbb389eaa6a4d2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<chapter id="SWAT">
<chapterinfo>
	&author.jht;
	<pubdate>April 21, 2003</pubdate>
</chapterinfo>

<title>SWAT - The Samba Web Admininistration Tool</title>

<para>
There are many and varied opinions regarding the usefulness or otherwise of SWAT.
No matter how hard one tries to produce the perfect configuration tool it remains
an object of personal taste. SWAT is a tool that will allow web based configuration
of samba. It has a wizard that may help to get samba configured quickly, it has context
sensitive help on each smb.conf parameter, it provides for monitoring of current state
of connection information, and it allows network wide MS Windows network password
management.
</para>

<sect1>
<title>SWAT Features and Benefits</title>

<para>
There are network administrators who believe that it is a good idea to write systems
documentation inside configuration files, for them SWAT will aways be a nasty tool. SWAT
does not store the configuration file in any intermediate form, rather, it stores only the
parameter settings, so when SWAT writes the smb.conf file to disk it will write only
those parameters that are at other than the default settings. The result is that all comments
will be lost from the smb.conf file. Additionally, the parameters will be written back in
internal ordering.
</para>

<note><para>
So before using SWAT please be warned - SWAT will completely replace your smb.conf with
a fully optimised file that has been stripped of all comments you might have placed there
and only non-default settings will be written to the file.
</para></note>

<para>
SWAT should be installed to run via the network super daemon. Depending on which system
your Unix/Linux system has you will have either an <filename>inetd</filename> or
<filename>xinetd</filename> based system.
</para>

<para>
The nature and location of the network super-daemon varies with the operating system
implementation. The control file (or files) can be located in the file 
<filename>/etc/inetd.conf</filename> or in the directory <filename>/etc/[x]inet.d</filename>
or similar.
</para>

<para>
The control entry for the older style file might be:
</para>

<para><programlisting>
	# swat is the Samba Web Administration Tool
	swat stream tcp nowait.400 root /usr/sbin/swat swat
</programlisting></para>

<para>
A control file for the newer style xinetd could be:
</para>

<para>
<programlisting>
	# default: off
	# description: SWAT is the Samba Web Admin Tool. Use swat \
	#              to configure your Samba server. To use SWAT, \
	#              connect to port 901 with your favorite web browser.
	service swat
	{
		port    = 901
		socket_type     = stream
		wait    = no
		only_from = localhost
		user    = root
		server  = /usr/sbin/swat
		log_on_failure  += USERID
		disable = yes
	}
</programlisting>
</para>

<para>
Both the above examples assume that the <filename>swat</filename> binary has been
located in the <filename>/usr/sbin</filename> directory. In addition to the above
SWAT will use a directory access point from which it will load all it's help files,
as well as other control information. The default location for this on most Linux
systems is in the directory <filename>/usr/share/samba/swat</filename>.
</para>

<para>
Access to SWAT will prompt for a logon. If you log onto SWAT as any non-root user
the only permission allowed is to view certain aspects of configuration as well as
access to the password change facility.
</para>

<para>
So long as you log onto SWAT as the user <command>root</command> you should obtain
full change and commit ability.
</para>

<sect2>
<title>The SWAT Home Page</title>

<para>
The SWAT title page provides access to the latest Samba documentation. The manual page for
each samba component is accessible from this page as are the Samba-HOWTO-Collection (this 
document) as well as the O'Reilly book "Using Samba".
</para>

</sect2>
<sect2>
<title>Global Settings</title>

<para>
Document steps right here!
</para>

</sect2>
<sect2>
<title>The SWAT Wizard</title>

<para>
Lots of blah blah here.
</para>

</sect2>

<sect2>
<title>Share Settings</title>

<para>
Document steps right here!
</para>

</sect2>

<sect2>
<title>Printing Settings</title>

<para>
Document steps right here!
</para>

</sect2>
<sect2>
<title>The Status Page</title>

<para>
Document steps right here!
</para>

</sect2>

<sect2>
<title>The Password Change Page</title>

<para>
Document steps right here!
</para>

</sect2>
</sect1>
</chapter>