← Back to branch summary

~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to docs-xml/manpages-3/swat.8.xml

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs-xml/manpages-3/swat.8.xml
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
 
3
<refentry id="swat.8">
 
4
 
 
5
<refmeta>
 
6
        <refentrytitle>swat</refentrytitle>
 
7
        <manvolnum>8</manvolnum>
 
8
        <refmiscinfo class="source">Samba</refmiscinfo>
 
9
        <refmiscinfo class="manual">System Administration tools</refmiscinfo>
 
10
        <refmiscinfo class="version">3.4</refmiscinfo>
 
11
</refmeta>
 
12
 
 
13
 
 
14
<refnamediv>
 
15
        <refname>swat</refname>
 
16
        <refpurpose>Samba Web Administration Tool</refpurpose>
 
17
</refnamediv>
 
18
 
 
19
<refsynopsisdiv>
 
20
        <cmdsynopsis>
 
21
                <command>swat</command>
 
22
                <arg choice="opt">-s &lt;smb config file&gt;</arg>
 
23
                <arg choice="opt">-a</arg>
 
24
                <arg choice="opt">-P</arg>
 
25
        </cmdsynopsis>
 
26
</refsynopsisdiv>
 
27
 
 
28
<refsect1>
 
29
        <title>DESCRIPTION</title>
 
30
 
 
31
        <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
 
32
        <manvolnum>7</manvolnum></citerefentry> suite.</para>
 
33
 
 
34
 
 
35
        <para><command>swat</command> allows a Samba administrator to 
 
36
        configure the complex <citerefentry><refentrytitle>smb.conf</refentrytitle>
 
37
        <manvolnum>5</manvolnum></citerefentry> file via a Web browser. In addition, 
 
38
        a <command>swat</command> configuration page has help links 
 
39
        to all the configurable options in the <filename>smb.conf</filename> file allowing an 
 
40
        administrator to easily look up the effects of any change. </para>
 
41
 
 
42
        <para><command>swat</command> is run from <command>inetd</command> </para>
 
43
</refsect1>
 
44
 
 
45
 
 
46
<refsect1>
 
47
        <title>OPTIONS</title>
 
48
 
 
49
        <variablelist>
 
50
                <varlistentry>
 
51
                <term>-s smb configuration file</term>
 
52
                <listitem><para>The default configuration file path is 
 
53
                determined at compile time.  The file specified contains 
 
54
                the configuration details required by the <citerefentry><refentrytitle>smbd</refentrytitle>
 
55
                <manvolnum>8</manvolnum></citerefentry> server. This is the file 
 
56
                that <command>swat</command> will modify. 
 
57
                The information in this file includes server-specific 
 
58
                information such as what printcap file to use, as well as 
 
59
                descriptions of all the services that the server is to provide.
 
60
                See <filename>smb.conf</filename> for more information. 
 
61
                </para></listitem>
 
62
                </varlistentry>
 
63
 
 
64
 
 
65
                <varlistentry>
 
66
                <term>-a</term>
 
67
                <listitem><para>This option disables authentication and 
 
68
                places <command>swat</command> in demo mode. In that mode anyone will be able to modify 
 
69
                the <filename>smb.conf</filename> file. </para>
 
70
                
 
71
                <para><emphasis>WARNING: Do NOT enable this option on a production 
 
72
                server. </emphasis></para></listitem>
 
73
                </varlistentry>
 
74
 
 
75
                <varlistentry>
 
76
                <term>-P</term>
 
77
                <listitem><para>This option restricts read-only users to the password 
 
78
        management page.  <command>swat</command> can then be used to change
 
79
        user passwords without users seeing the "View" and "Status" menu 
 
80
        buttons.</para></listitem>
 
81
                </varlistentry>
 
82
 
 
83
                &stdarg.server.debug;
 
84
                &popt.common.samba;
 
85
                &stdarg.help;
 
86
 
 
87
        </variablelist>
 
88
 
 
89
</refsect1>
 
90
 
 
91
<refsect1>
 
92
 
 
93
        <title>INSTALLATION</title>
 
94
 
 
95
        <para>Swat is included as binary package with most distributions. The 
 
96
        package manager in this case takes care of the installation and 
 
97
        configuration. This section is only for those who have compiled 
 
98
        swat from scratch.
 
99
        </para>
 
100
 
 
101
        <para>After you compile SWAT you need to run <command>make install
 
102
        </command> to install the <command>swat</command> binary
 
103
        and the various help files and images. A default install would put 
 
104
        these in: </para>
 
105
        
 
106
        <itemizedlist>
 
107
                <listitem><para>/usr/local/samba/sbin/swat</para></listitem>
 
108
                <listitem><para>/usr/local/samba/swat/images/*</para></listitem>
 
109
                <listitem><para>/usr/local/samba/swat/help/*</para></listitem>
 
110
        </itemizedlist>
 
111
 
 
112
        <refsect2> 
 
113
                <title>Inetd Installation</title>
 
114
 
 
115
                <para>You need to edit your <filename>/etc/inetd.conf
 
116
                </filename> and <filename>/etc/services</filename>
 
117
                to enable SWAT to be launched via <command>inetd</command>.</para>
 
118
 
 
119
                <para>In <filename>/etc/services</filename> you need to 
 
120
                add a line like this: </para>
 
121
 
 
122
                <para><command>swat            901/tcp</command></para>
 
123
 
 
124
                <para>Note for NIS/YP and LDAP users - you may need to rebuild the 
 
125
                NIS service maps rather than alter your local <filename>
 
126
                /etc/services</filename> file. </para>
 
127
 
 
128
                <para>the choice of port number isn't really important 
 
129
                except that it should be less than 1024 and not currently 
 
130
                used (using a number above 1024 presents an obscure security 
 
131
                hole depending on the implementation details of your 
 
132
                <command>inetd</command> daemon). </para>
 
133
 
 
134
                <para>In <filename>/etc/inetd.conf</filename> you should 
 
135
                add a line like this: </para>
 
136
 
 
137
                <para><command>swat    stream  tcp     nowait.400  root
 
138
                /usr/local/samba/sbin/swat swat</command></para>
 
139
        
 
140
                <para>Once you have edited <filename>/etc/services</filename> 
 
141
                and <filename>/etc/inetd.conf</filename> you need to send a 
 
142
                HUP signal to inetd. To do this use <command>kill -1 PID
 
143
                </command> where PID is the process ID of the inetd daemon. </para>
 
144
 
 
145
        </refsect2>
 
146
 
 
147
 
 
148
 
 
149
</refsect1>
 
150
 
 
151
<refsect1>
 
152
        <title>LAUNCHING</title>
 
153
 
 
154
        <para>To launch SWAT just run your favorite web browser and 
 
155
        point it at "http://localhost:901/".</para>
 
156
 
 
157
        <para>Note that you can attach to SWAT from any IP connected 
 
158
        machine but connecting from a remote machine leaves your 
 
159
        connection open to password sniffing as passwords will be sent 
 
160
        in the clear over the wire. </para>
 
161
</refsect1>
 
162
 
 
163
<refsect1>
 
164
        <title>FILES</title>
 
165
        
 
166
        <variablelist>
 
167
                <varlistentry>
 
168
                <term><filename>/etc/inetd.conf</filename></term>
 
169
                <listitem><para>This file must contain suitable startup 
 
170
                information for the meta-daemon.</para></listitem>
 
171
                </varlistentry>
 
172
 
 
173
                <varlistentry>
 
174
                <term><filename>/etc/services</filename></term>
 
175
                <listitem><para>This file must contain a mapping of service name 
 
176
                (e.g., swat) to service port (e.g., 901) and protocol type 
 
177
                (e.g., tcp).  </para></listitem>
 
178
                </varlistentry>
 
179
 
 
180
                <varlistentry>
 
181
                <term><filename>/usr/local/samba/lib/smb.conf</filename></term>
 
182
                <listitem><para>This is the default location of the <citerefentry>
 
183
                <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
 
184
                </citerefentry> server configuration file that swat edits. Other 
 
185
                common places that systems install this file are <filename>
 
186
                /usr/samba/lib/smb.conf</filename> and <filename>/etc/smb.conf
 
187
                </filename>.  This file describes all the services the server 
 
188
                is to make available to clients. </para></listitem>
 
189
                </varlistentry>
 
190
        </variablelist>
 
191
</refsect1>
 
192
 
 
193
 
 
194
<refsect1>
 
195
        <title>WARNINGS</title>
 
196
 
 
197
        <para><command>swat</command> will rewrite your <citerefentry>
 
198
        <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
 
199
        </citerefentry> file. It will rearrange the entries and delete all 
 
200
        comments, <parameter>include=</parameter> and <parameter>copy=
 
201
        </parameter> options. If you have a carefully crafted <filename>
 
202
        smb.conf</filename> then back it up or don't use swat! </para>
 
203
</refsect1>
 
204
 
 
205
 
 
206
<refsect1>
 
207
        <title>VERSION</title>
 
208
 
 
209
        <para>This man page is correct for version 3 of the Samba suite.</para>
 
210
</refsect1>
 
211
 
 
212
<refsect1>
 
213
        <title>SEE ALSO</title>
 
214
        <para><command>inetd(5)</command>, <citerefentry>
 
215
        <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum>
 
216
        </citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle>
 
217
        <manvolnum>5</manvolnum></citerefentry></para>
 
218
</refsect1>
 
219
 
 
220
<refsect1>
 
221
        <title>AUTHOR</title>
 
222
        
 
223
        <para>The original Samba software and related utilities 
 
224
        were created by Andrew Tridgell. Samba is now developed
 
225
        by the Samba Team as an Open Source project similar 
 
226
        to the way the Linux kernel is developed.</para>
 
227
        
 
228
        <para>The original Samba man pages were written by Karl Auer. 
 
229
        The man page sources were converted to YODL format (another 
 
230
        excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 
231
        ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 
 
232
        release by Jeremy Allison.  The conversion to DocBook for 
 
233
        Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
 
234
        Samba 3.0 was done by Alexander Bokovoy.</para>
 
235
</refsect1>
 
236
 
 
237
</refentry>