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 Please note that SWAT is still being developed so you should not
   5 expect it to be bug free. You should only install and use it if you
   6 want to either get a preview of what we are doing with SWAT or you
   7 want to help in the development of SWAT.
   8
   9 Installation
  10 ------------
  11
  12 After you compile SWAT you need to run "make install" to install the
  13 swat binary and the various help files and images. A default install
  14 would put these in:
  15
  16 /usr/local/samba/bin/swat
  17 /usr/local/samba/swat/images/*
  18 /usr/local/samba/swat/help/*
  19
  20 You then need to edit your /etc/inetd.conf and /etc/services to enable
  21 SWAT to be launched via inetd. Note that SWAT can also be launched via
  22 the cgi-bin mechanisms of a web server (such as apache) but that is
  23 not described here and has not been tested recently.
  24
  25 In /etc/services you need to add a line like this:
  26
  27 swat            901/tcp
  28
  29 the choice of port number isn't really important except that it should
  30 be less than 1024 and not currently used (using a number above 1024
  31 presents an obscure security hole depending on the implementation
  32 details of your inetd daemon).
  33
  34 In /etc/inetd.conf you should add a line like this:
  35
  36 swat    stream  tcp     nowait  root    /usr/local/samba/bin/swat swat
  37
  38 If you just want to see a demo of ho swat works and don't want to be
  39 able to actually change any Samba config via swat then you may chose
  40 to change "root" to some other user that does not have permission to
  41 write to smb.conf.
  42
  43 One you have edited /etc/services and /etc/inetd.conf you need to send
  44 a HUP signal to inetd. On many systems "killall -1 inetd" will do this
  45 on others you will need to use "kill -1 PID" where PID is the process
  46 ID of the inetd daemon.
  47
  48 Launching
  49 ---------
  50
  51 To launch SWAT just run your favourite web browser and point it at
  52 http://localhost:901/
  53
  54 Note that you can attach to SWAT from any IP connected machine but
  55 connecting from a remote machine leaves your connection open to
  56 password sniffing as passwords will be sent in the clear over the
  57 wire.
  58
  59 You should be prompted for a username/password when you connect. You
  60 will need to provide the username "root" and the correct root
  61 password. More sophisticated authentication options are planned for
  62 future versions of SWAT.
  63
  64 Running
  65 -------
  66
  67 Just follow your nose! If you can't work out how to use it then maybe
  68 you should use "vi smb.conf" instead.
  69
  70
  71 WARNINGS
  72 --------
  73
  74 SWAT will rewrite your smb.conf file. It will rearrange the entries
  75 and delete all comments, include= and copy= options. If you have a
  76 carefully crafted smb.conf then back it up or don't use SWAT!
  77
  78
  79 Development
  80 -----------
  81
  82 Please join the samba-technical mailing list if you want to discuss
  83 the development of SWAT. Note that this list is for technical developer
  84 discussions and is not a general help list.
  85