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