home *** CD-ROM | disk | FTP | other *** search
/ Dream 52 / Amiga_Dream_52.iso / Linux / Magazine / wwwoffle-2.1.tar.gz / wwwoffle-2.1 / wwwoffle.conf < prev    next >
Text File  |  1998-03-02  |  19KB  |  599 lines
  1. #
  2. # WWWOFFLE - World Wide Web Offline Explorer - Version 2.1.
  3. #
  4. # WWWOFFLE Configuration file CONFDIR/wwwoffle.conf
  5. #
  6. # Derived from the example configuration file written by Andrew M. Bishop
  7. #
  8. # WWWOFFLE and example configuration file Copyright 1997,98 Andrew M. Bishop
  9. # They may be distributed under the GNU Public License, version 2, or
  10. # any higher version.  See section COPYING of the GNU Public license
  11. # for conditions under which this file may be redistributed.
  12. #
  13.  
  14.  
  15. #
  16. # Lines beginning with a '#' are comments and ignored.
  17. #
  18.  
  19.  
  20. #
  21. # Program startup configuration.
  22. #
  23. # This can not be changed without restarting the program.
  24. #
  25. # Header : StartUp
  26. # Options: http-port         = <integer>
  27. #               The port number to use for the proxy http server (default=8080).
  28. #        : wwwoffle-port     = <integer>
  29. #               The port number to use for wwwoffle control (default=8081).
  30. #        : spool-dir         = <directory name>
  31. #               The directory to use as the spool directory
  32. #               (default=/var/spool/wwwoffle).
  33. #        : run-uid           = <username> | <uid>
  34. #               The username or numeric uid to run the wwwoffled server as
  35. #               (default=none).
  36. #        : run-gid           = <groupname> | <gid>
  37. #               The groupname or numeric gid to run the wwwoffled server as
  38. #               (default=none).
  39. #        : use-syslog        = yes | no
  40. #               If true then log all important messages using syslog
  41. #               (default=yes).
  42. #        : password          = <word> | none |
  43. #               The authorisation password for demon configuration by wwwoffle
  44. #               (default=none).
  45. #        : max-servers       = <integer>
  46. #               The maximum number of server processes that are ever started,
  47. #               must be less than MAX_SERVERS (=64) (default=8).
  48. #        : max-fetch-servers = <integer>
  49. #               The maximum number of server processes that are started to
  50. #               fetch pages that were requested in offline mode, must be less
  51. #               than MAX_FETCH_SERVERS (=48). (default=4).
  52. #
  53. # Notes 1: For the password to work the configuration file must be set so that
  54. #          only authorised users can read it.
  55. #       2: To use the run-uid/run-gid options, the server must start as root.
  56. #       3: The max-fetch-servers value must be less than max-servers or you will
  57. #          not be able to use wwwoffle interactively online while fetching.
  58. #
  59.  
  60. StartUp
  61. {
  62.  http-port         = 8080
  63.  wwwoffle-port     = 8081
  64.  
  65.  spool-dir         = SPOOLDIR
  66.  
  67. #run-uid           = daemon
  68. #run-gid           = daemon
  69.  
  70.  use-syslog        = yes
  71.  
  72.  password          = none
  73.  
  74.  max-servers       = 8
  75.  max-fetch-servers = 4
  76. }
  77.  
  78.  
  79. #
  80. # Other configuration options.
  81. #
  82. # Header : Options
  83. # Options: log-level         = debug | info | important | warning | fatal
  84. #               Log messages with this or higher priority (default=important).
  85. #          fetch-images      = yes | no
  86. #               Whether to also fetch images when doing a fetch (default=no).
  87. #          fetch-frames      = yes | no
  88. #               Whether to also fetch frames when doing a fetch (default=no).
  89. #          index-latest-days = <age>
  90. #               The age in days of pages to show in the index of latest pages
  91. #               (default=7).
  92. #          add-info-refresh  = yes | no
  93. #               The option to add a tag at the bottom of spooled pages giving
  94. #               the date it was cached and a refresh button (default=no).
  95. #          request-changed   = <time>
  96. #               While online pages will only be fetched if the cached version
  97. #               is older than this specified time in seconds (default=600).
  98. #          pragma-no-cache   = yes | no
  99. #               Whether to request a new copy of a page if the request has
  100. #               'Pragma: no-cache' (default=yes).
  101. #          offline-requests  = yes | no
  102. #               Whether to record requests that are made while offline or to
  103. #               return an error (default=yes).
  104. #          monitor-interval  = <age>
  105. #               The interval in days between monitoring of the specified URLs
  106. #               (default=7 days).
  107. #
  108. #  Notes 1: The request-changed option can be set negative to indicate that
  109. #           cached pages are always used while online.
  110. #        2: The pragma-no-cache option should be set to 'no' if when browsing
  111. #           offline all pages are re-requested by a 'broken' browser.
  112. #        3: The monitor-interval option when set to '0' means to check each time
  113. #           wwwoffle is online, '1' means once per day, etc.
  114. #
  115.  
  116. Options
  117. {
  118.  log-level         = important
  119.  
  120.  fetch-images      = yes
  121.  fetch-frames      = no
  122.  
  123.  index-latest-days = 7
  124.  
  125.  add-info-refresh  = no
  126.  
  127.  request-changed   = 600
  128.  
  129.  pragma-no-cache   = yes
  130.  
  131.  offline-requests  = yes
  132.  
  133.  monitor-interval  = 7
  134. }
  135.  
  136.  
  137. #
  138. # wwwoffle server host name specification.
  139. #
  140. # The possible names that the server that wwwoffles is on may be known by.
  141. #
  142. # Header : LocalHost
  143. # Options: <host>
  144. #               One of the possible hostnames or IP addresses.
  145. #
  146. # Notes 1: All entries in here are also used the same way as those in the
  147. #          LocalNet and AllowedConnect sections.
  148. #       2: The first named host is used as the server name for several features so
  149. #          should be a name that will work from any client host if on a network.
  150. #       3: None of the entries here or in LocalNet are fetched via a proxy.
  151. #
  152.  
  153. LocalHost
  154. {
  155.  localhost
  156.  127.0.0.1
  157.  
  158. #### Example ####
  159. # The server is on www.foo.com, with IP address 11.22.33.44.
  160. # www.foo.com
  161. # 11.22.33.44
  162. }
  163.  
  164.  
  165. #
  166. # Local Network non-cached host name specification
  167. #
  168. # The names of hosts that are not cached because they are on the local network.
  169. #
  170. # Header : LocalNet
  171. # Options: <host>
  172. #               A hostname or IP address.
  173. #
  174. # Notes 1: The hostname matches from the right so that 'foo.com' here matches
  175. #          'www.bar.foo.com' and 'www.foo.com' etc, IP addresses from the left.
  176. #       2: All entries here are assumed to be reachable even when offline.
  177. #       3: All entries in the LocalHost section are used as if they were here.
  178. #       4: None of the entries here or in LocalHost are fetched via a proxy.
  179. #
  180.  
  181. LocalNet
  182. {
  183.  
  184. #### Example ####
  185. # The local domain is foo.com so don't cache any hosts in it.
  186. # foo.com
  187. }
  188.  
  189.  
  190. #
  191. # Allowed client host name specification
  192. #
  193. # The names of client hosts that are allowed to connect to the server.
  194. #
  195. # Header : AllowedConnect
  196. # Options: <host>
  197. #               A hostname or IP address.
  198. #
  199. # Notes 1: The hostname matches from the right so that 'foo.com' here matches
  200. #          'www.bar.foo.com' and 'www.foo.com' etc, IP addresses from the left.
  201. #       2: All entries in the LocalHost section are used as if they were here.
  202. #
  203.  
  204. AllowedConnect
  205. {
  206.  
  207. #### Example ####
  208. # Only allow connections from hosts in the foo.com domain.
  209. # foo.com
  210. }
  211.  
  212.  
  213. #
  214. # A list of ways of recognising a URL not to cache.
  215. #
  216. # Header : DontCache
  217. # Options: default            = ...
  218. #               When getting any URLs ...
  219. #          HOST-SPECIFICATION = ...
  220. #               When getting URLs that match this ...
  221. #          ...  = FILE-SPECIFICATION
  222. #               ... don't cache any whose path matches this.
  223. #
  224. # Notes 1: See the bottom of this file for the description of HOST-SPECIFICATION
  225. #       2: See the bottom of this file for the description of FILE-SPECIFICATION
  226. #       3: The URL will still be cached if fetched non-interactively.
  227. #
  228.  
  229. DontCache
  230. {
  231.  
  232. #### Example ####
  233. # Don't cache any hosts in the barfoo.com domain.
  234. # barfoo.com = /
  235. # Don't cache any gzipped or tar files.
  236. # default = .gz
  237. # default = .tar
  238. # Don't cache any files from /volatile in the foo.com domain.
  239. # foo.com = /volatile
  240. }
  241.  
  242.  
  243. #
  244. # A list of ways of recognising a URL not to get.
  245. #
  246. # Header : DontGet
  247. # Options: default            = ...
  248. #               When getting URLs ...
  249. #          HOST-SPECIFICATION = ...
  250. #               When getting URLs that match this ...
  251. #          ...  = FILE-SPECIFICATION
  252. #               ... don't cache any whose path matches this.
  253. #
  254. # Notes 1: See the bottom of this file for the description of HOST-SPECIFICATION
  255. #       2: See the bottom of this file for the description of FILE-SPECIFICATION
  256. #
  257.  
  258. DontGet
  259. {
  260.  
  261. #### Example ####
  262. # Don't get from any hosts in the barfoo.com domain.
  263. # barfoo.com = /
  264. # Don't get any gzipped or tar files.
  265. # default = .gz
  266. # default = .tar
  267. # Don't get any files from /adverts in the foo.com domain.
  268. # foo.com = /adverts
  269. }
  270.  
  271.  
  272. #
  273. # A list of ways of recognising a URL not to get when fetching recursively.
  274. #
  275. # Header : DontGetRecursive
  276. # Options: default        = ...
  277. #               When recursively getting URLs ...
  278. #          HOST-SPECIFICATION = ...
  279. #               When recursively getting URLs that match this ...
  280. #          ...  = FILE-SPECIFICATION
  281. #               ... don't cache any whose path matches this.
  282. #
  283. # Notes 1: See the bottom of this file for the description of HOST-SPECIFICATION
  284. #       2: See the bottom of this file for the description of FILE-SPECIFICATION
  285. #
  286.  
  287. DontGetRecursive
  288. {
  289.  
  290. #### Example ####
  291. # Dont get any gzipped or tar files when getting recursively.
  292. # default = .gz
  293. # default = .tar
  294. }
  295.  
  296.  
  297. #
  298. # Censorship of information sent to the server
  299. #
  300. # A list of HTTP header lines that are to be removed from the requests sent.
  301. #
  302. # Header : CensorHeader
  303. # Options: <header>
  304. #               A header field name, e.g. From, Cookie, User-Agent.
  305. #
  306. # Notes 1: The header is case sensitive, and does not have a ':' at the end.
  307. #
  308.  
  309. CensorHeader
  310. {
  311.  
  312. ### Example ###
  313. # Don't send the username.
  314. # From
  315. # Don't send Cookies back
  316. # Cookie
  317. # Don't reveal the Browser type and OS version.
  318. # User-Agent
  319. }
  320.  
  321.  
  322. #
  323. # Options to use when fetching files using ftp.
  324. #
  325. # Header : FTPOptions
  326. # Options: anon-username = <string>
  327. #               The username to use for anonymous ftp (default=anonymous).
  328. #          anon-password = <string>
  329. #               The password to use for anonymous ftp (default=<user>@<host>).
  330. #          auth-hostname = <host[:port]>
  331. #               A host to use a different username and password.
  332. #          auth-username = <string>
  333. #               The username to use on the above host.
  334. #          auth-password = <string>
  335. #               The password to use on the above host.
  336. #
  337. # Notes 1: The anon-password should be set to a sensible value especially if you
  338. #          are behind a firewall.
  339. #       2: The auth-hostname, auth-username and auth-password options must come
  340. #          together as a triplet.
  341. #       3: The auth-hostname must be exact, it is not used as a wildcard match.
  342. #
  343.  
  344. FTPOptions
  345. {
  346.  anon-username = anonymous
  347. #anon-password = 
  348.  
  349. }
  350.  
  351.  
  352. #
  353. # MIME Types to use when fetching files not using HTTP.
  354. #
  355. # Header : MIMETypes
  356. # Options: default     = <mime-type>/<subtype>
  357. #               The default MIME type (default=text/plain).
  358. #          .<file-ext> = <mime-type>/<subtype>
  359. #               The MIME type to associate with a file extension.
  360. #
  361. # Notes 1: You must include the '.' in the file extension.
  362. #       2: If more than one of the extensions match then the longest is used.
  363. #
  364.  
  365. MIMETypes
  366. {
  367.  default  = text/plain
  368.  
  369.  .pdf     = application/pdf
  370.  .eps     = application/postscript
  371.  .ps      = application/postscript
  372.  .rtf     = application/rtf
  373.  .dvi     = application/x-dvi
  374.  .latex   = application/x-latex
  375.  .tcl     = application/x-tcl
  376.  .tex     = application/x-tex
  377.  .texinfo = application/x-texinfo
  378.  .texi    = application/x-texinfo
  379.  .tr      = application/x-troff
  380.  .man     = application/x-troff-man
  381.  .me      = application/x-troff-me
  382.  .ms      = application/x-troff-ms
  383.  .zip     = application/zip
  384.  .cpio    = application/x-cpio
  385.  .tar     = application/x-tar
  386.  .Z       = application/x-compress
  387.  .gz      = application/x-gzip
  388.  .au      = audio/basic
  389.  .snd     = audio/basic
  390.  .wav     = audio/x-wav
  391.  .gif     = image/gif
  392.  .jpeg    = image/jpeg
  393.  .jpg     = image/jpeg
  394.  .tif     = image/tiff
  395.  .tiff    = image/tiff
  396.  .ras     = image/x-cmu-raster
  397.  .pnm     = image/x-portable-anymap
  398.  .pbm     = image/x-portable-bitmap
  399.  .pgm     = image/x-portable-graymap
  400.  .ppm     = image/x-portable-pixmap
  401.  .rgb     = image/x-rgb
  402.  .xbm     = image/x-xbitmap
  403.  .xpm     = image/x-xpixmap
  404.  .xwd     = image/x-xwindowdump
  405.  .html    = text/html
  406.  .txt     = text/plain
  407.  .mpeg    = video/mpeg
  408.  .mpg     = video/mpeg
  409.  .mov     = video/quicktime
  410.  .avi     = video/x-msvideo
  411. }
  412.  
  413.  
  414. #
  415. # Remote proxy configuration.
  416. #
  417. # The name and port number of machines to use as proxies.
  418. #
  419. # Header : Proxy
  420. # Options: default            = <hostname[:integer]> | none |
  421. #               The hostname (+ optionally a port number separated by a colon)
  422. #               to use as the default proxy.
  423. #          HOST-SPECIFICATION = <hostname[:integer]> | none |
  424. #               The hostname (+ optionally a port number separated by a colon)
  425. #               to use as the proxy for URLs that match HOST-SPECIFICATION.
  426. #          auth-hostname = <host[:port]>
  427. #               A proxy server that uses proxy authentication.
  428. #          auth-username = <string>
  429. #               The username to use on the above host.
  430. #          auth-password = <string>
  431. #               The password to use on the above host.
  432. #
  433. # Notes 1: See the bottom of this file for the description of HOST-SPECIFICATION
  434. #       2: A hostname that matches more than one entry here uses the proxy of
  435. #          the longest matching one (protocol is included in assessing length).
  436. #       3: Leave the hostname empty or use 'none' for no proxy.
  437. #       4: None of the hosts in LocalNet/LocalHost will be fetched via a proxy.
  438. #       5: The auth-hostname, auth-username and auth-password options must come
  439. #          together as a triplet.
  440. #       6: The auth-hostname must be exact, it is not used as a wildcard match.
  441. #
  442.  
  443. Proxy
  444. {
  445.  http/ = none
  446.  
  447. #### Example ####
  448. # Use www.foo.com as a default http proxy server on port 8080
  449. # Except for the foo.com domain which has no proxy.
  450. # http/   = www.foo.com:8080
  451. # foo.com = none
  452. }
  453.  
  454.  
  455. #
  456. # Mirror servers specification
  457. #
  458. # A list of servers that have mirrors to be used in preference or to resolve
  459. # conflicts over multiple names for the same server.
  460. #
  461. # Header : Mirror
  462. # Options: <proto>/<host> = <proto>/<host>
  463. #               The first named protocol and host is to be replaced by the
  464. #               second named protocol and host.
  465. #          <host>         = <host>
  466. #               The first named host is to be replaced by the second named host
  467. #               for all protocols.
  468. #
  469. # Notes 1: Symbolic links in the spool directory also work, but they are only
  470. #          checked when wwwoffled is started or 'wwwoffle -config' is run.
  471. #       2: The host names must match exactly, no wildcards.
  472. #
  473.  
  474. Mirror
  475. {
  476.  
  477. #### Example ####
  478. # The http server www.bar.com is mirrored locally at www.bar-mirror.foo.com
  479. # http/www.bar.com = http/www.bar-mirror.foo.com
  480. }
  481.  
  482.  
  483. #
  484. # Purge method and maximum ages specification.
  485. #
  486. # The method to determine which pages to purge, the default age, the host
  487. # specific maximum age of the pages in days, and the maximum cache size.
  488. #
  489. # Header : Purge
  490. # Options: use-mtime          = yes | no
  491. #               The decision of which pages to purge can be made on last access
  492. #               time (atime) or last modification time (mtime) (default=no).
  493. #          max-size           = <integer>
  494. #               The maximum allowed size of the cache in MB (default=0).
  495. #          default            = <integer>
  496. #               The default maximum age for pages on hosts (default=28).
  497. #          HOST-SPECIFICATION = <integer>
  498. #               The maximum age for pages on hosts that match the
  499. #               HOST-SPECIFICATION.
  500. #
  501. # Notes 1: See the bottom of this file for the description of HOST-SPECIFICATION
  502. #       2: A hostname that matches more than one entry here uses the age of the
  503. #          longest matching one (the protocol is counted in assessing length).
  504. #       3: A zero age means always delete on purge, negative means never purge.
  505. #       4: A maximum cache size of 0 means there is no limit to the size.
  506. #       5: When there is a non-zero maximum cache size it is measured excluding
  507. #          all hosts with a negative maximum age (never purged hosts).
  508. #
  509.  
  510. Purge
  511. {
  512.  use-mtime = no
  513.  
  514.  max-size  = 0
  515.  
  516.  default   = 28
  517.  
  518. #### Example ####
  519. # Expire hosts in the domain foo.com at 1 week except bar.foo.com at 2 weeks.
  520. # foo.com = 7
  521. # bar.foo.com = 14
  522. # Never keep anything in the domain bar.com except foo.bar.com is always kept.
  523. # bar.com = 0
  524. # foo.bar.com = -1
  525. #
  526. # Keep ftp files for 7 days and http for 14.
  527. # ftp/ = 7
  528. # http/ = 14
  529. #
  530. # Purge files to keep the cache below 10 MB
  531. # max-size = 10
  532. }
  533.  
  534.  
  535. #
  536. # HOST-SPECIFICATION
  537. # ------------------
  538. #
  539. # When specifying a host and protocol in many of the sections a HOST-SPECIFICATION
  540. # can be used, this is a way of recognising a URL.
  541. #
  542. # For the purposes of this explanation a URL is considered to be made up of three
  543. # parts.
  544. #
  545. # proto           The protocol that is used (e.g. http, ftp)
  546. # host            The server hostname (e.g. www.gedanken.demon.co.uk) or a domain
  547. #                 name (e.g. demon.co.uk) or an IP address (e.g. 1.2.3.4) or a
  548. #                 subnet (e.g. 1.2.3).
  549. # port            The port number on the host (e.g. default of 80 for HTTP).
  550. #
  551. #
  552. # For example the wwwoffle homepage: http://www.gedanken.demon.co.uk/wwwoffle/
  553. # The protocol is 'http', the host is 'www.gedanken.demon.co.uk', the port is the
  554. # default (in this case 80).
  555. #
  556. #
  557. # A HOST-SPECIFICATION can be any one of the following
  558. #
  559. # /                       Any protocol, Any host, Any port (same as default)
  560. #
  561. # [/]<host>               Any protocol, Named host, Default port
  562. #
  563. # [/]<host>:<port>        Any protocol, Named host, Specified port
  564. #
  565. # [/]<host>:              Any protocol, Named host, Any port
  566. #
  567. # <proto>/                Named protocol, Any host, Any port
  568. #
  569. # <proto>/<host>          Named protocol, Named host, Default port
  570. #
  571. # <proto>/<host>:<port>   Named protocol, Named host, Specified port
  572. #
  573. # <proto>/<host>:         Named protocol, Named host, Any port
  574. #
  575. #
  576. # Where [] indicates an optional feature, and <> indicate a user supplied name or
  577. # number.
  578. #
  579.  
  580. #
  581. # FILE-SPECIFICATION
  582. # ------------------
  583. #
  584. # Several of the sections allow a FILE-SPECIFICATION to be entered, this is a way
  585. # of recognising the path part of a URL.
  586. #
  587. #
  588. # A FILE-SPECIFICATION can be either of the following:
  589. #
  590. # /<path>                 Any file with a path that start with the specified one.
  591. #
  592. # .<file-ext>             Any file that ends with the specified file extension.
  593. #
  594. #
  595. # Where <> indicate a user supplied name or number.
  596. #
  597. # Note: The '/' or '.' at the start is not optional.
  598. #
  599.