docs/htmldocs/swat.8.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >swat</TITLE
   5 ><META
   6 NAME="GENERATOR"
   7 CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD
   8 ><BODY
   9 CLASS="REFENTRY"
  10 BGCOLOR="#FFFFFF"
  11 TEXT="#000000"
  12 LINK="#0000FF"
  13 VLINK="#840084"
  14 ALINK="#0000FF"
  15 ><H1
  16 ><A
  17 NAME="SWAT"
  18 >swat</A
  19 ></H1
  20 ><DIV
  21 CLASS="REFNAMEDIV"
  22 ><A
  23 NAME="AEN5"
  24 ></A
  25 ><H2
  26 >Name</H2
  27 >swat&nbsp;--&nbsp;Samba Web Administration Tool</DIV
  28 ><DIV
  29 CLASS="REFSYNOPSISDIV"
  30 ><A
  31 NAME="AEN8"
  32 ></A
  33 ><H2
  34 >Synopsis</H2
  35 ><P
  36 ><B
  37 CLASS="COMMAND"
  38 >nmblookup</B
  39 >  [-s &#60;smb config file&#62;] [-a]</P
  40 ></DIV
  41 ><DIV
  42 CLASS="REFSECT1"
  43 ><A
  44 NAME="AEN13"
  45 ></A
  46 ><H2
  47 >DESCRIPTION</H2
  48 ><P
  49 >This tool is part of the <A
  50 HREF="samba.7.html"
  51 TARGET="_top"
  52 >       Samba</A
  53 > suite.</P
  54 ><P
  55 ><B
  56 CLASS="COMMAND"
  57 >swat</B
  58 > allows a Samba administrator to
  59         configure the complex <A
  60 HREF="smb.conf.5.html"
  61 TARGET="_top"
  62 ><TT
  63 CLASS="FILENAME"
  64 >       smb.conf(5)</TT
  65 ></A
  66 > file via a Web browser. In addition,
  67         a <B
  68 CLASS="COMMAND"
  69 >swat</B
  70 > configuration page has help links
  71         to all the configurable options in the smb.conf file allowing an
  72         administrator to easily look up the effects of any change. </P
  73 ><P
  74 >swat is run from inetd </P
  75 ></DIV
  76 ><DIV
  77 CLASS="REFSECT1"
  78 ><A
  79 NAME="AEN23"
  80 ></A
  81 ><H2
  82 >OPTIONS</H2
  83 ><P
  84 ></P
  85 ><DIV
  86 CLASS="VARIABLELIST"
  87 ><DL
  88 ><DT
  89 >-s smb configuration file</DT
  90 ><DD
  91 ><P
  92 >The default configuration file path is
  93                 determined at compile time.  The file specified contains
  94                 the configuration details required by the <B
  95 CLASS="COMMAND"
  96 >smbd
  97                 </B
  98 > server. This is the file that swat will modify.
  99                 The information in this file includes server-specific
 100                 information such as what printcap file to use, as well as
 101                 descriptions of all the services that the server is to provide.
 102                 See <TT
 103 CLASS="FILENAME"
 104 >smb.conf</TT
 105 > for more information.
 106                 </P
 107 ></DD
 108 ><DT
 109 >-a</DT
 110 ><DD
 111 ><P
 112 >This option disables authentication and puts
 113                 swat in demo mode. In that mode anyone will be able to modify
 114                 the smb.conf file. </P
 115 ><P
 116 ><EM
 117 >Do NOT enable this option on a production
 118                 server. </EM
 119 ></P
 120 ></DD
 121 ></DL
 122 ></DIV
 123 ></DIV
 124 ><DIV
 125 CLASS="REFSECT1"
 126 ><A
 127 NAME="AEN38"
 128 ></A
 129 ><H2
 130 >INSTALLATION</H2
 131 ><P
 132 >After you compile SWAT you need to run <B
 133 CLASS="COMMAND"
 134 >make install
 135         </B
 136 > to install the <B
 137 CLASS="COMMAND"
 138 >swat</B
 139 > binary
 140         and the various help files and images. A default install would put
 141         these in: </P
 142 ><P
 143 ></P
 144 ><UL
 145 ><LI
 146 ><P
 147 >/usr/local/samba/bin/swat</P
 148 ></LI
 149 ><LI
 150 ><P
 151 >/usr/local/samba/swat/images/*</P
 152 ></LI
 153 ><LI
 154 ><P
 155 >/usr/local/samba/swat/help/*</P
 156 ></LI
 157 ></UL
 158 ><DIV
 159 CLASS="REFSECT2"
 160 ><A
 161 NAME="AEN50"
 162 ></A
 163 ><H3
 164 >Inetd Installation</H3
 165 ><P
 166 >You need to edit your <TT
 167 CLASS="FILENAME"
 168 >/etc/inetd.conf
 169                 </TT
 170 > and <TT
 171 CLASS="FILENAME"
 172 >/etc/services</TT
 173 >
 174                 to enable SWAT to be launched via inetd.</P
 175 ><P
 176 >In <TT
 177 CLASS="FILENAME"
 178 >/etc/services</TT
 179 > you need to
 180                 add a line like this: </P
 181 ><P
 182 ><B
 183 CLASS="COMMAND"
 184 >swat            901/tcp</B
 185 ></P
 186 ><P
 187 >Note for NIS/YP users - you may need to rebuild the
 188                 NIS service maps rather than alter your local <TT
 189 CLASS="FILENAME"
 190 >               /etc/services</TT
 191 > file. </P
 192 ><P
 193 >the choice of port number isn't really important
 194                 except that it should be less than 1024 and not currently
 195                 used (using a number above 1024 presents an obscure security
 196                 hole depending on the implementation details of your
 197                 <B
 198 CLASS="COMMAND"
 199 >inetd</B
 200 > daemon). </P
 201 ><P
 202 >In <TT
 203 CLASS="FILENAME"
 204 >/etc/inetd.conf</TT
 205 > you should
 206                 add a line like this: </P
 207 ><P
 208 ><B
 209 CLASS="COMMAND"
 210 >swat    stream  tcp     nowait.400  root
 211                 /usr/local/samba/bin/swat swat</B
 212 ></P
 213 ><P
 214 >One you have edited <TT
 215 CLASS="FILENAME"
 216 >/etc/services</TT
 217 >
 218                 and <TT
 219 CLASS="FILENAME"
 220 >/etc/inetd.conf</TT
 221 > you need to send a
 222                 HUP signal to inetd. To do this use <B
 223 CLASS="COMMAND"
 224 >kill -1 PID
 225                 </B
 226 > where PID is the process ID of the inetd daemon. </P
 227 ></DIV
 228 ><DIV
 229 CLASS="REFSECT2"
 230 ><A
 231 NAME="AEN71"
 232 ></A
 233 ><H3
 234 >Launching</H3
 235 ><P
 236 >To launch swat just run your favorite web browser and
 237                 point it at "http://localhost:901/".</P
 238 ><P
 239 >Note that you can attach to swat from any IP connected
 240                 machine but connecting from a remote machine leaves your
 241                 connection open to password sniffing as passwords will be sent
 242                 in the clear over the wire. </P
 243 ></DIV
 244 ></DIV
 245 ><DIV
 246 CLASS="REFSECT1"
 247 ><A
 248 NAME="AEN75"
 249 ></A
 250 ><H2
 251 >FILES</H2
 252 ><P
 253 ></P
 254 ><DIV
 255 CLASS="VARIABLELIST"
 256 ><DL
 257 ><DT
 258 ><TT
 259 CLASS="FILENAME"
 260 >/etc/inetd.conf</TT
 261 ></DT
 262 ><DD
 263 ><P
 264 >This file must contain suitable startup
 265                 information for the meta-daemon.</P
 266 ></DD
 267 ><DT
 268 ><TT
 269 CLASS="FILENAME"
 270 >/etc/services</TT
 271 ></DT
 272 ><DD
 273 ><P
 274 >This file must contain a mapping of service name
 275                 (e.g., swat) to service port (e.g., 901) and protocol type
 276                 (e.g., tcp).  </P
 277 ></DD
 278 ><DT
 279 ><TT
 280 CLASS="FILENAME"
 281 >/usr/local/samba/lib/smb.conf</TT
 282 ></DT
 283 ><DD
 284 ><P
 285 >This is the default location of the <TT
 286 CLASS="FILENAME"
 287 >smb.conf(5)
 288                 </TT
 289 > server configuration file that swat edits. Other
 290                 common places that systems install this file are <TT
 291 CLASS="FILENAME"
 292 >               /usr/samba/lib/smb.conf</TT
 293 > and <TT
 294 CLASS="FILENAME"
 295 >/etc/smb.conf
 296                 </TT
 297 >.  This file describes all the services the server
 298                 is to make available to clients. </P
 299 ></DD
 300 ></DL
 301 ></DIV
 302 ></DIV
 303 ><DIV
 304 CLASS="REFSECT1"
 305 ><A
 306 NAME="AEN96"
 307 ></A
 308 ><H2
 309 >WARNINGS</H2
 310 ><P
 311 ><B
 312 CLASS="COMMAND"
 313 >swat</B
 314 > will rewrite your <TT
 315 CLASS="FILENAME"
 316 >smb.conf
 317         </TT
 318 > file. It will rearrange the entries and delete all
 319         comments, <TT
 320 CLASS="PARAMETER"
 321 ><I
 322 >include=</I
 323 ></TT
 324 > and <TT
 325 CLASS="PARAMETER"
 326 ><I
 327 >copy="
 328         </I
 329 ></TT
 330 > options. If you have a carefully crafted <TT
 331 CLASS="FILENAME"
 332 >       smb.conf</TT
 333 > then back it up or don't use swat! </P
 334 ></DIV
 335 ><DIV
 336 CLASS="REFSECT1"
 337 ><A
 338 NAME="AEN104"
 339 ></A
 340 ><H2
 341 >VERSION</H2
 342 ><P
 343 >This man page is correct for version 2.2 of
 344         the Samba suite.</P
 345 ></DIV
 346 ><DIV
 347 CLASS="REFSECT1"
 348 ><A
 349 NAME="AEN107"
 350 ></A
 351 ><H2
 352 >SEE ALSO</H2
 353 ><P
 354 ><B
 355 CLASS="COMMAND"
 356 >inetd(5)</B
 357 >,
 358         <A
 359 HREF="smbd.8.html"
 360 TARGET="_top"
 361 ><B
 362 CLASS="COMMAND"
 363 >smbd(8)</B
 364 ></A
 365 >,
 366         <A
 367 HREF="smb.conf.5.html"
 368 TARGET="_top"
 369 >smb.conf(5)</A
 370 >
 371         </P
 372 ></DIV
 373 ><DIV
 374 CLASS="REFSECT1"
 375 ><A
 376 NAME="AEN114"
 377 ></A
 378 ><H2
 379 >AUTHOR</H2
 380 ><P
 381 >The original Samba software and related utilities
 382         were created by Andrew Tridgell. Samba is now developed
 383         by the Samba Team as an Open Source project similar
 384         to the way the Linux kernel is developed.</P
 385 ><P
 386 >The original Samba man pages were written by Karl Auer.
 387         The man page sources were converted to YODL format (another
 388         excellent piece of Open Source software, available at
 389         <A
 390 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
 391 TARGET="_top"
 392 >       ftp://ftp.icce.rug.nl/pub/unix/</A
 393 >) and updated for the Samba 2.0
 394         release by Jeremy Allison.  The conversion to DocBook for
 395         Samba 2.2 was done by Gerald Carter</P
 396 ></DIV
 397 ></BODY
 398 ></HTML
 399 >