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 ><DT
 149 >-V</DT
 150 ><DD
 151 ><P
 152 >Prints the version number for
 153 <B
 154 CLASS="COMMAND"
 155 >smbd</B
 156 >.</P
 157 ></DD
 158 ><DT
 159 >-s &#60;configuration file&#62;</DT
 160 ><DD
 161 ><P
 162 >The file specified contains the
 163 configuration details required by the server.  The
 164 information in this file includes server-specific
 165 information such as what printcap file to use, as well
 166 as descriptions of all the services that the server is
 167 to provide. See <A
 168 HREF="smb.conf.5.html"
 169 TARGET="_top"
 170 ><TT
 171 CLASS="FILENAME"
 172 >smb.conf(5)</TT
 173 ></A
 174 > for more information.
 175 The default configuration file name is determined at
 176 compile time.</P
 177 ></DD
 178 ><DT
 179 >-d|--debug=debuglevel</DT
 180 ><DD
 181 ><P
 182 ><VAR
 183 CLASS="REPLACEABLE"
 184 >debuglevel</VAR
 185 > is an integer
 186 from 0 to 10.  The default value if this parameter is
 187 not specified is zero.</P
 188 ><P
 189 >The higher this value, the more detail will be
 190 logged to the log files about the activities of the
 191 server. At level 0, only critical errors and serious
 192 warnings will be logged. Level 1 is a reasonable level for
 193 day to day running - it generates a small amount of
 194 information about operations carried out.</P
 195 ><P
 196 >Levels above 1 will generate considerable
 197 amounts of log data, and should only be used when
 198 investigating a problem. Levels above 3 are designed for
 199 use only by developers and generate HUGE amounts of log
 200 data, most of which is extremely cryptic.</P
 201 ><P
 202 >Note that specifying this parameter here will
 203 override the <A
 204 HREF="smb.conf.5.html#loglevel"
 205 TARGET="_top"
 206 >log
 207 level</A
 208 > parameter in the <A
 209 HREF="smb.conf.5.html"
 210 TARGET="_top"
 211 ><TT
 212 CLASS="FILENAME"
 213 >smb.conf(5)</TT
 214 ></A
 215 > file.</P
 216 ></DD
 217 ><DT
 218 >-l|--logfile=logbasename</DT
 219 ><DD
 220 ><P
 221 >File name for log/debug files. The extension
 222 <CODE
 223 CLASS="CONSTANT"
 224 >".client"</CODE
 225 > will be appended. The log file is
 226 never removed by the client.</P
 227 ></DD
 228 ><DT
 229 >-h|--help</DT
 230 ><DD
 231 ><P
 232 >Print a summary of command line options.</P
 233 ></DD
 234 ></DL
 235 ></DIV
 236 ></DIV
 237 ><DIV
 238 CLASS="REFSECT1"
 239 ><A
 240 NAME="AEN80"
 241 ></A
 242 ><H2
 243 >INSTALLATION</H2
 244 ><P
 245 >Swat is included as binary package with most distributions. The
 246         package manager in this case takes care of the installation and
 247         configuration. This section is only for those who have compiled
 248         swat from scratch.
 249         </P
 250 ><P
 251 >After you compile SWAT you need to run <B
 252 CLASS="COMMAND"
 253 >make install
 254         </B
 255 > to install the <B
 256 CLASS="COMMAND"
 257 >swat</B
 258 > binary
 259         and the various help files and images. A default install would put
 260         these in: </P
 261 ><P
 262 ></P
 263 ><UL
 264 ><LI
 265 ><P
 266 >/usr/local/samba/bin/swat</P
 267 ></LI
 268 ><LI
 269 ><P
 270 >/usr/local/samba/swat/images/*</P
 271 ></LI
 272 ><LI
 273 ><P
 274 >/usr/local/samba/swat/help/*</P
 275 ></LI
 276 ></UL
 277 ><DIV
 278 CLASS="REFSECT2"
 279 ><A
 280 NAME="AEN93"
 281 ></A
 282 ><H3
 283 >Inetd Installation</H3
 284 ><P
 285 >You need to edit your <TT
 286 CLASS="FILENAME"
 287 >/etc/inetd.conf
 288                 </TT
 289 > and <TT
 290 CLASS="FILENAME"
 291 >/etc/services</TT
 292 >
 293                 to enable SWAT to be launched via <B
 294 CLASS="COMMAND"
 295 >inetd</B
 296 >.</P
 297 ><P
 298 >In <TT
 299 CLASS="FILENAME"
 300 >/etc/services</TT
 301 > you need to
 302                 add a line like this: </P
 303 ><P
 304 ><B
 305 CLASS="COMMAND"
 306 >swat            901/tcp</B
 307 ></P
 308 ><P
 309 >Note for NIS/YP and LDAP users - you may need to rebuild the
 310                 NIS service maps rather than alter your local <TT
 311 CLASS="FILENAME"
 312 >               /etc/services</TT
 313 > file. </P
 314 ><P
 315 >the choice of port number isn't really important
 316                 except that it should be less than 1024 and not currently
 317                 used (using a number above 1024 presents an obscure security
 318                 hole depending on the implementation details of your
 319                 <B
 320 CLASS="COMMAND"
 321 >inetd</B
 322 > daemon). </P
 323 ><P
 324 >In <TT
 325 CLASS="FILENAME"
 326 >/etc/inetd.conf</TT
 327 > you should
 328                 add a line like this: </P
 329 ><P
 330 ><B
 331 CLASS="COMMAND"
 332 >swat    stream  tcp     nowait.400  root
 333                 /usr/local/samba/bin/swat swat</B
 334 ></P
 335 ><P
 336 >One you have edited <TT
 337 CLASS="FILENAME"
 338 >/etc/services</TT
 339 >
 340                 and <TT
 341 CLASS="FILENAME"
 342 >/etc/inetd.conf</TT
 343 > you need to send a
 344                 HUP signal to inetd. To do this use <B
 345 CLASS="COMMAND"
 346 >kill -1 PID
 347                 </B
 348 > where PID is the process ID of the inetd daemon. </P
 349 ></DIV
 350 ></DIV
 351 ><DIV
 352 CLASS="REFSECT1"
 353 ><A
 354 NAME="AEN115"
 355 ></A
 356 ><H2
 357 >LAUNCHING</H2
 358 ><P
 359 >To launch SWAT just run your favorite web browser and
 360         point it at "http://localhost:901/".</P
 361 ><P
 362 >Note that you can attach to SWAT from any IP connected
 363         machine but connecting from a remote machine leaves your
 364         connection open to password sniffing as passwords will be sent
 365         in the clear over the wire. </P
 366 ></DIV
 367 ><DIV
 368 CLASS="REFSECT1"
 369 ><A
 370 NAME="AEN119"
 371 ></A
 372 ><H2
 373 >FILES</H2
 374 ><P
 375 ></P
 376 ><DIV
 377 CLASS="VARIABLELIST"
 378 ><DL
 379 ><DT
 380 ><TT
 381 CLASS="FILENAME"
 382 >/etc/inetd.conf</TT
 383 ></DT
 384 ><DD
 385 ><P
 386 >This file must contain suitable startup
 387                 information for the meta-daemon.</P
 388 ></DD
 389 ><DT
 390 ><TT
 391 CLASS="FILENAME"
 392 >/etc/services</TT
 393 ></DT
 394 ><DD
 395 ><P
 396 >This file must contain a mapping of service name
 397                 (e.g., swat) to service port (e.g., 901) and protocol type
 398                 (e.g., tcp).  </P
 399 ></DD
 400 ><DT
 401 ><TT
 402 CLASS="FILENAME"
 403 >/usr/local/samba/lib/smb.conf</TT
 404 ></DT
 405 ><DD
 406 ><P
 407 >This is the default location of the <SPAN
 408 CLASS="CITEREFENTRY"
 409 ><SPAN
 410 CLASS="REFENTRYTITLE"
 411 >smb.conf</SPAN
 412 >(5)</SPAN
 413 > server configuration file that swat edits. Other
 414                 common places that systems install this file are <TT
 415 CLASS="FILENAME"
 416 >               /usr/samba/lib/smb.conf</TT
 417 > and <TT
 418 CLASS="FILENAME"
 419 >/etc/smb.conf
 420                 </TT
 421 >.  This file describes all the services the server
 422                 is to make available to clients. </P
 423 ></DD
 424 ></DL
 425 ></DIV
 426 ></DIV
 427 ><DIV
 428 CLASS="REFSECT1"
 429 ><A
 430 NAME="AEN142"
 431 ></A
 432 ><H2
 433 >WARNINGS</H2
 434 ><P
 435 ><B
 436 CLASS="COMMAND"
 437 >swat</B
 438 > will rewrite your <SPAN
 439 CLASS="CITEREFENTRY"
 440 ><SPAN
 441 CLASS="REFENTRYTITLE"
 442 >smb.conf</SPAN
 443 >(5)</SPAN
 444 > file. It will rearrange the entries and delete all
 445         comments, <VAR
 446 CLASS="PARAMETER"
 447 >include=</VAR
 448 > and <VAR
 449 CLASS="PARAMETER"
 450 >copy=
 451         </VAR
 452 > options. If you have a carefully crafted <TT
 453 CLASS="FILENAME"
 454 >       smb.conf</TT
 455 > then back it up or don't use swat! </P
 456 ></DIV
 457 ><DIV
 458 CLASS="REFSECT1"
 459 ><A
 460 NAME="AEN152"
 461 ></A
 462 ><H2
 463 >VERSION</H2
 464 ><P
 465 >This man page is correct for version 3.0 of the Samba suite.</P
 466 ></DIV
 467 ><DIV
 468 CLASS="REFSECT1"
 469 ><A
 470 NAME="AEN155"
 471 ></A
 472 ><H2
 473 >SEE ALSO</H2
 474 ><P
 475 ><B
 476 CLASS="COMMAND"
 477 >inetd(5)</B
 478 >, <SPAN
 479 CLASS="CITEREFENTRY"
 480 ><SPAN
 481 CLASS="REFENTRYTITLE"
 482 >smbd</SPAN
 483 >(8)</SPAN
 484 >, <SPAN
 485 CLASS="CITEREFENTRY"
 486 ><SPAN
 487 CLASS="REFENTRYTITLE"
 488 >smb.conf</SPAN
 489 >(5)</SPAN
 490 ></P
 491 ></DIV
 492 ><DIV
 493 CLASS="REFSECT1"
 494 ><A
 495 NAME="AEN165"
 496 ></A
 497 ><H2
 498 >AUTHOR</H2
 499 ><P
 500 >The original Samba software and related utilities
 501         were created by Andrew Tridgell. Samba is now developed
 502         by the Samba Team as an Open Source project similar
 503         to the way the Linux kernel is developed.</P
 504 ><P
 505 >The original Samba man pages were written by Karl Auer.
 506         The man page sources were converted to YODL format (another
 507         excellent piece of Open Source software, available at <A
 508 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
 509 TARGET="_top"
 510 >       ftp://ftp.icce.rug.nl/pub/unix/</A
 511 >) and updated for the Samba 2.0
 512         release by Jeremy Allison.  The conversion to DocBook for
 513         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
 514         Samba 3.0 was done by Alexander Bokovoy.</P
 515 ></DIV
 516 ></BODY
 517 ></HTML
 518 >