- removed smb.conf.5.html as it now comes as part of htmldocs
[tprouty/samba.git] / swat / README
1 This is a brief description of how to install and use the Samba Web
2 Administration Tool on your machine.
3
4 Installation
5 ------------
6
7 After you compile SWAT you need to run "make install" to install the
8 swat binary and the various help files and images. A default install
9 would put these in:
10
11 /usr/local/samba/bin/swat
12 /usr/local/samba/swat/images/*
13 /usr/local/samba/swat/help/*
14
15 Running via inetd
16 -----------------
17
18 You then need to edit your /etc/inetd.conf and /etc/services to enable
19 SWAT to be launched via inetd. 
20
21 In /etc/services you need to add a line like this:
22
23 swat            901/tcp
24
25 the choice of port number isn't really important except that it should
26 be less than 1024 and not currently used (using a number above 1024
27 presents an obscure security hole depending on the implementation
28 details of your inetd daemon).
29
30 In /etc/inetd.conf you should add a line like this:
31
32 swat    stream  tcp     nowait.400  root    /usr/local/samba/bin/swat swat
33
34 One you have edited /etc/services and /etc/inetd.conf you need to send
35 a HUP signal to inetd. On many systems "killall -1 inetd" will do this
36 on others you will need to use "kill -1 PID" where PID is the process
37 ID of the inetd daemon.
38
39
40
41 Launching
42 ---------
43
44 To launch SWAT just run your favourite web browser and point it at
45 http://localhost:901/ 
46
47 Note that you can attach to SWAT from any IP connected machine but
48 connecting from a remote machine leaves your connection open to
49 password sniffing as passwords will be sent in the clear over the
50 wire.
51
52 You should be prompted for a username/password when you connect. You
53 will need to provide the username "root" and the correct root
54 password. 
55
56 Running
57 -------
58
59 Just follow your nose! If you can't work out how to use it then maybe
60 you should use "vi smb.conf" instead.
61
62
63 WARNINGS
64 --------
65
66 SWAT will rewrite your smb.conf file. It will rearrange the entries
67 and delete all comments, include= and copy= options. If you have a
68 carefully crafted smb.conf then back it up or don't use SWAT!
69
70
71 Development
72 -----------
73
74 Please join the samba-technical mailing list if you want to discuss
75 the development of SWAT. Note that this list is for technical developer
76 discussions and is not a general help list.
77