global change from samba.anu.edu.au to samba.org
[samba.git] / docs / yodldocs / swat.8.yo
1 mailto(samba-bugs@samba.org) 
2
3 manpage(swat htmlcommand((8)))(8)(23 Oct 1998)(Samba)(SAMBA)
4
5 label(NAME)
6 manpagename(swat)(swat - Samba Web Administration Tool)
7
8 label(SYNOPSIS)
9 manpagesynopsis()
10
11 bf(swat) [link(-s smb config file)(minuss)] [link(-a)(minusa)]
12
13 label(DESCRIPTION)
14 manpagedescription()
15
16 This program is part of the bf(Samba) suite.
17
18 bf(swat) allows a Samba administrator to configure the complex
19 url(bf(smb.conf))(smb.conf.5.html) file via a Web browser. In
20 addition, a swat configuration page has help links to all the
21 configurable options in the url(bf(smb.conf))(smb.conf.5.html) file
22 allowing an administrator to easily look up the effects of any change.
23
24 bf(swat) is run from bf(inetd)
25
26 label(OPTIONS)
27 manpageoptions()
28
29 startdit()
30
31 label(minuss)
32 dit(bf(-s smb configuration file)) The default configuration file path is
33 determined at compile time.
34
35 The file specified contains the configuration details required by the
36 url(bf(smbd))(smbd.8.html) server. This is the file that bf(swat) will
37 modify. The information in this file includes server-specific
38 information such as what printcap file to use, as well as descriptions
39 of all the services that the server is to provide. See url(smb.conf
40 (5))(smb.conf.5.html) for more information.
41
42 label(minusa)
43 dit(bf(-a)) 
44
45 This option disables authentication and puts bf(swat) in demo mode. In
46 that mode anyone will be able to modify the
47 url(bf(smb.conf))(smb.conf.5.html) file.
48
49 Do NOT enable this option on a production server.
50
51 endit()
52
53 label(INSTALLATION)
54 manpagesection(INSTALLATION)
55
56 After you compile SWAT you need to run tt("make install") to install the
57 swat binary and the various help files and images. A default install
58 would put these in:
59
60 verb(
61 /usr/local/samba/bin/swat
62 /usr/local/samba/swat/images/*
63 /usr/local/samba/swat/help/*
64 )
65
66 label(INETD)
67 manpagesection(INETD INSTALLATION)
68
69 You need to edit your tt(/etc/inetd.conf) and tt(/etc/services) to
70 enable bf(SWAT) to be launched via inetd. 
71
72 In tt(/etc/services) you need to add a line like this:
73
74 tt(swat            901/tcp)
75
76 Note for NIS/YP users - you may need to rebuild the NIS service maps
77 rather than alter your local tt(/etc/services) file.
78
79 the choice of port number isn't really important except that it should
80 be less than 1024 and not currently used (using a number above 1024
81 presents an obscure security hole depending on the implementation
82 details of your bf(inetd) daemon).
83
84 In tt(/etc/inetd.conf) you should add a line like this:
85
86 tt(swat    stream  tcp     nowait.400  root    /usr/local/samba/bin/swat swat)
87
88 One you have edited tt(/etc/services) and tt(/etc/inetd.conf) you need
89 to send a HUP signal to inetd. To do this use tt("kill -1 PID") where
90 PID is the process ID of the inetd daemon.
91
92 label(LAUNCHING)
93 manpagesection(LAUNCHING)
94
95 To launch bf(swat) just run your favorite web browser and point it at
96 tt(http://localhost:901/).
97
98 bf(Note that you can attach to bf(swat) from any IP connected machine but
99 connecting from a remote machine leaves your connection open to
100 password sniffing as passwords will be sent in the clear over the
101 wire.)
102
103 manpagefiles()
104
105 bf(/etc/inetd.conf)
106
107 This file must contain suitable startup information for the
108 meta-daemon. 
109
110 bf(/etc/services)
111
112 This file must contain a mapping of service name (e.g., swat) to
113 service port (e.g., 901) and protocol type (e.g., tcp). 
114
115 bf(/usr/local/samba/lib/smb.conf)
116
117 This is the default location of the em(smb.conf) server configuration
118 file that bf(swat) edits. Other common places that systems install
119 this file are em(/usr/samba/lib/smb.conf) and em(/etc/smb.conf).
120
121 This file describes all the services the server is to make available
122 to clients. See bf(smb.conf (5)) for more information.
123
124 label(WARNINGS)
125 manpagesection(WARNINGS)
126
127 bf(swat) will rewrite your url(bf(smb.conf))(smb.conf.5.html) file. It
128 will rearrange the entries and delete all comments,
129 url(bf("include="))(smb.conf.5.html#include) and
130 url(bf("copy="))(smb.conf.5.html#copy) options. If you have a
131 carefully crafted url(bf(smb.conf))(smb.conf.5.html) then back it up
132 or don't use bf(swat)!
133
134 label(VERSION)
135 manpagesection(VERSION)
136
137 This man page is correct for version 2.0 of the Samba suite.
138
139 label(SEEALSO)
140 manpageseealso()
141
142 bf(inetd (8)), url(bf(nmbd (8)))(nmbd.8.html),
143 url(bf(smb.conf (5)))(smb.conf.5.html).
144
145 label(AUTHOR)
146 manpageauthor()
147
148 The original Samba software and related utilities were created by
149 Andrew Tridgell (samba-bugs@samba.org). Samba is now developed
150 by the Samba Team as an Open Source project similar to the way the
151 Linux kernel is developed.
152
153 The original Samba man pages were written by Karl Auer. The man page
154 sources were converted to YODL format (another excellent piece of Open
155 Source software, available at
156 url(bf(ftp://ftp.icce.rug.nl/pub/unix/))(ftp://ftp.icce.rug.nl/pub/unix/))
157 and updated for the Samba2.0 release by Jeremy Allison.
158 email(samba-bugs@samba.org).
159
160 See url(bf(samba (7)))(samba.7.html) to find out how to get a full
161 list of contributors and details on how to submit bug reports,
162 comments etc.