docs/htmldocs/swat.8.html

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