summaryrefslogtreecommitdiff
path: root/docs/htmldocs/swat.8.html
blob: 2abd049b71c57b3db93751d2d04fe44c40b50027 (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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>swat</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="SWAT.8"
></A
>swat</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5"
></A
><H2
>Name</H2
>swat&nbsp;--&nbsp;Samba Web Administration Tool</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN8"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>swat</B
>  [-s &#60;smb config file&#62;] [-a]</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN13"
></A
><H2
>DESCRIPTION</H2
><P
>This tool is part of the <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>Samba</SPAN
>(7)</SPAN
> suite.</P
><P
><B
CLASS="COMMAND"
>swat</B
> allows a Samba administrator to 
	configure the complex <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>smb.conf</SPAN
>(5)</SPAN
> file via a Web browser. In addition, 
	a <B
CLASS="COMMAND"
>swat</B
> configuration page has help links 
	to all the configurable options in the <TT
CLASS="FILENAME"
>smb.conf</TT
> file allowing an 
	administrator to easily look up the effects of any change. </P
><P
><B
CLASS="COMMAND"
>swat</B
> is run from <B
CLASS="COMMAND"
>inetd</B
> </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN29"
></A
><H2
>OPTIONS</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>-s smb configuration file</DT
><DD
><P
>The default configuration file path is 
		determined at compile time.  The file specified contains 
		the configuration details required by the <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>smbd</SPAN
>(8)</SPAN
> server. This is the file 
		that <B
CLASS="COMMAND"
>swat</B
> 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 <TT
CLASS="FILENAME"
>smb.conf</TT
> for more information. 
		</P
></DD
><DT
>-a</DT
><DD
><P
>This option disables authentication and puts 
		<B
CLASS="COMMAND"
>swat</B
> in demo mode. In that mode anyone will be able to modify 
		the <TT
CLASS="FILENAME"
>smb.conf</TT
> file. </P
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>WARNING: Do NOT enable this option on a production 
		server. </I
></SPAN
></P
></DD
><DT
>-V</DT
><DD
><P
>Prints the version number for 
<B
CLASS="COMMAND"
>smbd</B
>.</P
></DD
><DT
>-s &#60;configuration file&#62;</DT
><DD
><P
>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 <A
HREF="smb.conf.5.html"
TARGET="_top"
><TT
CLASS="FILENAME"
>smb.conf(5)</TT
></A
> for more information.
The default configuration file name is determined at 
compile time.</P
></DD
><DT
>-d|--debug=debuglevel</DT
><DD
><P
><VAR
CLASS="REPLACEABLE"
>debuglevel</VAR
> is an integer 
from 0 to 10.  The default value if this parameter is 
not specified is zero.</P
><P
>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.</P
><P
>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.</P
><P
>Note that specifying this parameter here will 
override the <A
HREF="smb.conf.5.html#loglevel"
TARGET="_top"
>log
level</A
> parameter in the <A
HREF="smb.conf.5.html"
TARGET="_top"
><TT
CLASS="FILENAME"
>smb.conf(5)</TT
></A
> file.</P
></DD
><DT
>-l|--logfile=logbasename</DT
><DD
><P
>File name for log/debug files. The extension
<CODE
CLASS="CONSTANT"
>".client"</CODE
> will be appended. The log file is
never removed by the client.</P
></DD
><DT
>-h|--help</DT
><DD
><P
>Print a summary of command line options.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN80"
></A
><H2
>INSTALLATION</H2
><P
>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.
	</P
><P
>After you compile SWAT you need to run <B
CLASS="COMMAND"
>make install
	</B
> to install the <B
CLASS="COMMAND"
>swat</B
> binary
	and the various help files and images. A default install would put 
	these in: </P
><P
></P
><UL
><LI
><P
>/usr/local/samba/bin/swat</P
></LI
><LI
><P
>/usr/local/samba/swat/images/*</P
></LI
><LI
><P
>/usr/local/samba/swat/help/*</P
></LI
></UL
><DIV
CLASS="REFSECT2"
><A
NAME="AEN93"
></A
><H3
>Inetd Installation</H3
><P
>You need to edit your <TT
CLASS="FILENAME"
>/etc/inetd.conf
		</TT
> and <TT
CLASS="FILENAME"
>/etc/services</TT
>
		to enable SWAT to be launched via <B
CLASS="COMMAND"
>inetd</B
>.</P
><P
>In <TT
CLASS="FILENAME"
>/etc/services</TT
> you need to 
		add a line like this: </P
><P
><B
CLASS="COMMAND"
>swat            901/tcp</B
></P
><P
>Note for NIS/YP and LDAP users - you may need to rebuild the 
		NIS service maps rather than alter your local <TT
CLASS="FILENAME"
>		/etc/services</TT
> file. </P
><P
>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 
		<B
CLASS="COMMAND"
>inetd</B
> daemon). </P
><P
>In <TT
CLASS="FILENAME"
>/etc/inetd.conf</TT
> you should 
		add a line like this: </P
><P
><B
CLASS="COMMAND"
>swat    stream  tcp     nowait.400  root
		/usr/local/samba/bin/swat swat</B
></P
><P
>One you have edited <TT
CLASS="FILENAME"
>/etc/services</TT
> 
		and <TT
CLASS="FILENAME"
>/etc/inetd.conf</TT
> you need to send a 
		HUP signal to inetd. To do this use <B
CLASS="COMMAND"
>kill -1 PID
		</B
> where PID is the process ID of the inetd daemon. </P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN115"
></A
><H2
>LAUNCHING</H2
><P
>To launch SWAT just run your favorite web browser and 
	point it at "http://localhost:901/".</P
><P
>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. </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN119"
></A
><H2
>FILES</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="FILENAME"
>/etc/inetd.conf</TT
></DT
><DD
><P
>This file must contain suitable startup 
		information for the meta-daemon.</P
></DD
><DT
><TT
CLASS="FILENAME"
>/etc/services</TT
></DT
><DD
><P
>This file must contain a mapping of service name 
		(e.g., swat) to service port (e.g., 901) and protocol type 
		(e.g., tcp).  </P
></DD
><DT
><TT
CLASS="FILENAME"
>/usr/local/samba/lib/smb.conf</TT
></DT
><DD
><P
>This is the default location of the <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>smb.conf</SPAN
>(5)</SPAN
> server configuration file that swat edits. Other 
		common places that systems install this file are <TT
CLASS="FILENAME"
>		/usr/samba/lib/smb.conf</TT
> and <TT
CLASS="FILENAME"
>/etc/smb.conf
		</TT
>.  This file describes all the services the server 
		is to make available to clients. </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN142"
></A
><H2
>WARNINGS</H2
><P
><B
CLASS="COMMAND"
>swat</B
> will rewrite your <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>smb.conf</SPAN
>(5)</SPAN
> file. It will rearrange the entries and delete all 
	comments, <VAR
CLASS="PARAMETER"
>include=</VAR
> and <VAR
CLASS="PARAMETER"
>copy=
	</VAR
> options. If you have a carefully crafted <TT
CLASS="FILENAME"
>	smb.conf</TT
> then back it up or don't use swat! </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN152"
></A
><H2
>VERSION</H2
><P
>This man page is correct for version 3.0 of the Samba suite.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN155"
></A
><H2
>SEE ALSO</H2
><P
><B
CLASS="COMMAND"
>inetd(5)</B
>, <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>smbd</SPAN
>(8)</SPAN
>, <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>smb.conf</SPAN
>(5)</SPAN
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN165"
></A
><H2
>AUTHOR</H2
><P
>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.</P
><P
>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 <A
HREF="ftp://ftp.icce.rug.nl/pub/unix/"
TARGET="_top"
>	ftp://ftp.icce.rug.nl/pub/unix/</A
>) 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.</P
></DIV
></BODY
></HTML
>