SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE


YUM REPOSITORY

 
 

MAN page from OpenSuSE 13.X wwwoffle-2.9i-41.1.i586.rpm

wwwoffle.conf

Section: File Formats (5)
Updated: August 26, 2008
Index

 

NAME

wwwoffle.conf - The configuration file for the proxy server for the World Wide Web Offline Explorer.

 

Introduction

The configuration file (wwwoffle.conf) specifies all of the parameters thatcontrol the operation of the proxy server. The file is split into sectionseach containing a series of parameters as described below. The fileCHANGES.CONFexplains the changes in the configuration file between thisversion of the program and previous ones.

The file is split into sections, each of which can be empty or contain one ormore lines of configuration information. The sections are named and the orderthat they appear in the file is not important.

The general format of each of the sections is the same. The name of thesection is on a line by itself to mark the start. The contents of the sectionare enclosed between a pair of lines containing only the '{' and '}'characters or the '[' and ']' characters. When the '{' and '}' characters areused the lines between contain configuration information. When the '[' and']' characters are used then there must only be a single non-empty linebetween them that contains the name of a file (in the same directory)containing the configuration information for the section.

Comments are marked by a '#' character at the start of the line and they areignored. Blank lines are also allowed and ignored.

The phrases URL-SPECIFICATION(or URL-SPECfor short) and WILDCARDhavespecific meanings in the configuration file and are described at the end. Anyitem enclosed in '(' and ')' in the descriptions means that it is a parametersupplied by the user, anything enclosed in '[' and ']' is optional, the '|'symbol is used to denote alternate choices. Some options apply to specificURLs only, this is indicated by having a URL-SPECIFICATIONenclosed between'<' & '>' in the option, the first URL-SPECIFICATIONto match is used. If noURL-SPECIFICATIONis given then it matches all URLs.

 

StartUp

This contains the parameters that are used when the program starts, changes tothese are ignored if the configuration file is re-read while the program isrunning.

bind-ipv4 = (hostname) | (ip-address) | none
Specify the hostname or IP address to bind the HTTP proxy and WWWOFFLEcontrol port sockets to using IPv4 (default='0.0.0.0'). If 'none' isspecified then no IPv4 socket is bound. If this is changed from thedefault value then the first entry in the LocalHost section may needto be changed to match.
bind-ipv6 = (hostname) | (ip-address) | none
Specify the hostname or IP address to bind the HTTP proxy and WWWOFFLEcontrol port sockets to using IPv6 (default='::'). If 'none' isspecified then no IPv6 socket is bound. This requires the IPv6compilation option. If this is changed from the default value thenthe first entry in the LocalHost section may need to be changed tomatch.
http-port = (port)
An integer specifying the port number for connections to access theinternal WWWOFFLE pages and for HTTP/HTTPS/FTP proxying(default=8080). This is the port number that must be specified in theclient to connect to the WWWOFFLE proxy for HTTP/HTTPS/FTP proxying.
https-port = (port)
An integer specifying the port number for encrypted connections toaccess the internal WWWOFFLE pages and for HTTP/FTP proxying(default=8443). Requires gnutls compilation option.
wwwoffle-port = (port)
An integer specifying the port number for the WWWOFFLE controlconnections to use (default=8081).
spool-dir = (dir)
The full pathname of the top level cache directory (spool directory)(default=/var/spool/wwwoffle or whatever was used when the program wascompiled).
run-uid = (user) | (uid)
The username or numeric uid to change to when the WWWOFFLE server isstarted (default=none). This option only works if the server isstarted by the root user on UNIX-like systems.
run-gid = (group) | (gid)
The group name or numeric gid to change to when the WWWOFFLE server isstarted (default=none). This option only works if the server isstarted by the root user on UNIX-like systems.
use-syslog = yes | no
Whether to use the syslog facility for messages or not (default=yes).
password = (word)
The password used for authentication of the control pages, fordeleting cached pages etc (default=none). For the password to besecure the configuration file must be set so that only authorisedusers can read it.
max-servers = (integer)
The maximum number of server processes that are started for online andautomatic fetching (default=8).
max-fetch-servers = (integer)
The maximum number of server processes that are started to fetch pagesthat were marked in offline mode (default=4). This value must be lessthan max-servers or you will not be able to use WWWOFFLE interactivelyonline while fetching.

 

Options

Options that control how the program works.

log-level = debug | info | important | warning | fatal
The minimum log level for messages in syslog or stderr(default=important).
socket-timeout = (time)
The time in seconds that WWWOFFLE will wait for data on a socketconnection before giving up (default=120).
dns-timeout = (time)
The time in seconds that WWWOFFLE will wait for a DNS (Domain NameService) lookup before giving up (default=60).
connect-timeout = (time)
The time in seconds that WWWOFFLE will wait for the socket connectionto be made before giving up (default=30).
connect-retry = yes | no
If a connection cannot be made to a remote server then WWWOFFLE shouldtry again after a short delay (default=no).
dir-perm = (octal int)
The directory permissions to use when creating spool directories(default=0755). This option overrides the umask of the user and mustbe in octal starting with a '0'.
file-perm = (octal int)
The file permissions to use when creating spool files (default=0644).This option overrides the umask of the user and must be in octalstarting with a '0'.
run-online = (filename)
The full pathname of a program to run when WWWOFFLE is switched toonline mode (default=none). The program is started in the backgroundwith a single parameter set to the current mode name "online".
run-offline = (filename)
The full pathname of a program to run when WWWOFFLE is switched tooffline mode (default=none). The program is started in the backgroundwith a single parameter set to the current mode name "offline".
run-autodial = (filename)
The full pathname of a program to run when WWWOFFLE is switched toautodial (default=none). The program is started in the background witha single parameter set to the current mode name "fetch".
run-fetch = (filename)
The full pathname of a program to run when a WWWOFFLE fetch starts orstops (default=none). The program is started in the background with twoparameters, the first is the word "fetch" and the second is "start" or"stop".
lock-files = yes | no
Enable the use of lock files to stop more than one WWWOFFLE process fromdownloading the same URL at the same time (default=no). Disabling thelock-files may result in incomplete pages being displayed or many copiesbeing downloaded if multiple requests are made for the same URL at thesame time.
reply-compressed-data = yes | no
If the replies that are made to the client are to contain compresseddata when requested (default=no). Requires zlib compilation option.
reply-chunked-data = yes | no
If the replies that are made to the client are to use chunked encodingwhen possible (default=yes).
exec-cgi = (pathname)
Enable the use of CGI scripts for the local pages on the WWWOFFLEserver that match the wildcard pathname (default=none).

 

OnlineOptions

Options that control how WWWOFFLE behaves when it is online.

[<URL-SPEC>] pragma-no-cache = yes | no
Whether to request a new copy of a page if the request from the clienthas 'Pragma: no-cache' (default=yes). This option takes precedenceover the request-changed and request-changed-once options.
[<URL-SPEC>] cache-control-no-cache = yes | no
Whether to request a new copy of a page if the request from the clienthas 'Cache-Control: no-cache' (default=yes). This option takesprecedence over the request-changed and request-changed-once options.
[<URL-SPEC>] cache-control-max-age-0 = yes | no
Whether to request a new copy of a page if the request from the clienthas 'Cache-Control: max-age=0' (default=yes). This option takesprecedence over the request-changed and request-changed-once options.
[<URL-SPEC>] cookies-force-refresh = yes | no
Whether to force the refresh of a page if the request from the clientcontains a cookie (default=no). This option takes precedence overthe request-changed and request-changed-once options.
[<URL-SPEC>] request-changed = (time)
While online pages will only be fetched if the cached version is olderthan this specified time in seconds (default=600). Setting this valuenegative will indicate that cached pages are always used while online.Longer times can be specified with a 'm', 'h', 'd' or 'w' suffix forminutes, hours, days or weeks (e.g. 10m=600).
[<URL-SPEC>] request-changed-once = yes | no
While online pages will only be fetched if the cached version has notalready been fetched once this session online (default=yes). Thisoption takes precedence over the request-changed option.
[<URL-SPEC>] request-expired = yes | no
While online pages that have expired will always be requested again(default=no). This option takes precedence over the request-changedand request-changed-once options.
[<URL-SPEC>] request-no-cache = yes | no
While online pages that ask not to be cached will always be requestedagain (default=no). This option takes precedence over therequest-changed and request-changed-once options.
[<URL-SPEC>] request-redirection = yes | no
While online pages that redirect the client to another URL temporarilywill be requested again. (default=no). This option takes precedenceover the request-changed and request-changed-once options.
[<URL-SPEC>] request-conditional = yes | no
While online pages that are requested from the server will beconditional requests so that the server only sends data if the pagehas changed (default=yes).
[<URL-SPEC>] validate-with-etag = yes | no
When making a conditional request to a server enable the use of theHTTP/1.1 cache validator 'Etag' as well as modification time'If-Modified-Since' (default=yes). The request-conditional optionmust also be selected for this option to take effect.
[<URL-SPEC>] try-without-password = yes | no
If a request is made for a URL that contains a username and passwordthen a request is made for the same URL without a username andpassword specified (default=yes). This allows for requests for theURL without a password to re-direct the client to the passwordedversion.
[<URL-SPEC>] intr-download-keep = yes | no
If the client closes the connection while online the currentlydownloaded incomplete page should be kept (default=no).
[<URL-SPEC>] intr-download-size = (integer)
If the client closes the connection while online the page shouldcontinue to download if it is smaller than this size in kB(default=1).
[<URL-SPEC>] intr-download-percent = (integer)
If the client closes the connection while online the page shouldcontinue to download if it is more than this percentage complete(default=80).
[<URL-SPEC>] timeout-download-keep = yes | no
If the server connection times out while reading then the currentlydownloaded incomplete page should be kept (default=no).
[<URL-SPEC>] keep-cache-if-not-found = yes | no
If the remote server replies with an error message or a redirectionwhile there is a cached version with status 200 the previously cached version should be kept (default=no).
[<URL-SPEC>] request-compressed-data = yes | no
If the requests that are made to the server are to request compresseddata (default=yes). Requires zlib compilation option.
[<URL-SPEC>] request-chunked-data = yes | no
If the requests that are made to the server are to request chunkedencoding (default=yes).

 

OfflineOptions

Options that control how WWWOFFLE behaves when it is offline.

[<URL-SPEC>] pragma-no-cache = yes | no
Whether to request a new copy of a page if the request from the clienthas 'Pragma: no-cache' (default=yes). This option should be set to'no' if when browsing offline all pages are re-requested by a 'broken'browser.
[<URL-SPEC>] cache-control-no-cache = yes | no
Whether to request a new copy of a page if the request from the clienthas 'Cache-Control: no-cache' (default=yes). This option should beset to 'no' if when browsing offline all pages are re-requested by a'broken' browser.
[<URL-SPEC>] cache-control-max-age-0 = yes | no
Whether to request a new copy of a page if the request from the clienthas 'Cache-Control: max-age=0' (default=yes). This option should beset to 'no' if when browsing offline all pages are re-requested by a'broken' browser.
[<URL-SPEC>] confirm-requests = yes | no
Whether to return a page requiring user confirmation instead ofautomatically recording requests made while offline (default=no).
[<URL-SPEC>] dont-request = yes | no
Do not request any URLs that match this when offline (default=no).

 

SSLOptions

Options that control how WWWOFFLE behaves when a connection is made to it for anhttps or Secure Sockets Layer (SSL) server. Normally only tunnelling (with nodecryption or caching of the data) is possible. When WWWOFFLE is compiled withthe gnutls library it is possible configure WWWOFFLE to decrypt, cache andre-encrypt the connections.

quick-key-gen = yes | no
Normally generation of secret keys for the SSL/https functions uses thedefault GnuTLS option for random number source. This can be slow onsome machines so this option selects a quicker but less secure randomnumber source (default = no). Requires GnuTLS compilation option.
expiration-time = (age)
The length of time after creation that each certificate will expire(default = 1y). Requires GnuTLS compilation option.
enable-caching = yes | no
If caching (involving decryption and re-encryption) of SSL/httpsserver connections is allowed (default = no). Requires GnuTLScompilation option.
allow-tunnel = (host[:port])
A hostname and port number (a WILDCARDmatch) for an https/SSL serverthat can be connected to using WWWOFFLE as a tunnelling proxy (nocaching or decryption of the data) (default is no hosts or portsallowed). This option should be set to *:443 to allow https to thedefault port number. There can be more than one option for otherports or hosts as required. This option takes precedence over theallow-cache option. The host value is matched against the URL aspresented, no hostname to IP or IP to hostname lookups are performedto find alternative equivalent names.
disallow-tunnel = (host[:port])
A hostname and port number (a WILDCARDmatch) for an https/SSL serverthat can not be connected to using WWWOFFLE as a tunnelling proxy.There can be more than one option for other ports or hosts asrequired. This option takes precedence over the allow-tunnel option.The host value is matched against the URL as presented, no hostname toIP or IP to hostname lookups are performed to find alternativeequivalent names.
allow-cache = (host[:port])
A hostname and port number (a WILDCARDmatch) for an https/SSL serverthat can be connected to using WWWOFFLE as a caching proxy (decryptionof the data) (default is no hosts or ports allowed). This optionshould be set to *:443 to allow https to the default port number.There can be more than one option for other ports or hosts asrequired. The host value is matched against the URL as presented, nohostname to IP or IP to hostname lookups are performed to findalternative equivalent names. Requires GnuTLS compilation option.
disallow-cache = (host[:port])
A hostname and port number (a WILDCARDmatch) for an https/SSL serverthat can not be connected to using WWWOFFLE as a caching proxy. Thisoption takes precedence over the allow-cache option. The host valueis matched against the URL as presented, no hostname to IP or IP tohostname lookups are performed to find alternative equivalent names.Requires GnuTLS compilation option.

 

FetchOptions

Options that control what linked elements are downloaded when fetching pagesthat were requested while offline.

[<URL-SPEC>] stylesheets = yes | no
If style sheets are to be fetched (default=no).
[<URL-SPEC>] images = yes | no
If images are to be fetched (default=no).
[<URL-SPEC>] webbug-images = yes | no
If images that are declared in the HTML to be 1 pixel square are also tobe fetched, requires the images option to also be selected(default=yes). If these images are not fetched then thereplace-webbug-images option in the ModifyHTML section can be used tostop browsers requesting them.
[<URL-SPEC>] icon-images = yes | no
If icons (also called favourite icons or shortcut icons) as used bybrowsers for bookmarks are to be fetched (default=no).
[<URL-SPEC>] only-same-host-images = yes | no
If the only images that are fetched are the ones that are on the samehost as the page that references them, requires the images option toalso be selected (default=no).
[<URL-SPEC>] frames = yes | no
If frames are to be fetched (default=no).
[<URL-SPEC>] iframes = yes | no
If inline frames (iframes) are to be fetched (default=no).
[<URL-SPEC>] scripts = yes | no
If scripts (e.g. Javascript) are to be fetched (default=no).
[<URL-SPEC>] objects = yes | no
If objects (e.g. Java class files) are to be fetched (default=no).

 

IndexOptions

Options that control what is displayed in the indexes.

create-history-indexes = yes | no
Enables creation of the lasttime/prevtime and lastout/prevout indexes(default=yes). The cycling of the indexes is always performed andthey will flush even if this option is disabled.
cycle-indexes-daily = yes | no
Cycles the lasttime/prevtime and lastout/prevout indexes daily insteadof each time online or fetching (default = no).
<URL-SPEC> list-outgoing = yes | no
Choose if the URL is to be listed in the outgoing index (default=yes).
<URL-SPEC> list-latest = yes | no
Choose if the URL is to be listed in the lasttime/prevtime andlastout/prevout indexes (default=yes).
<URL-SPEC> list-monitor = yes | no
Choose if the URL is to be listed in the monitor index (default=yes).
<URL-SPEC> list-host = yes | no
Choose if the URL is to be listed in the host indexes (default=yes).
<URL-SPEC> list-any = yes | no
Choose if the URL is to be listed in any of the indexes (default=yes).

 

ModifyHTML

Options that control how the HTML that is provided from the cache is modified.

[<URL-SPEC>] enable-modify-html = yes | no
Enable the HTML modifications in this section (default=no). With thisoption disabled the following HTML options will not have any effect.With this option enabled there is a small speed penalty.
[<URL-SPEC>] add-cache-info = yes | no
At the bottom of all of the spooled pages the date that the page wascached and some navigation buttons are to be added (default=no).
[<URL-SPEC>] anchor-cached-begin = (HTML code) |
Anchors (links) in the spooled page that are in the cache are to havethe specified HTML inserted at the beginning (default="").
[<URL-SPEC>] anchor-cached-end = (HTML code) |
Anchors (links) in the spooled page that are in the cache are to havethe specified HTML inserted at the end (default="").
[<URL-SPEC>] anchor-requested-begin = (HTML code) |
Anchors (links) in the spooled page that are not in the cache but havebeen requested for download are to have the specified HTML inserted atthe beginning (default="").
[<URL-SPEC>] anchor-requested-end = (HTML code) |
Anchors (links) in the spooled page that are not in the cache but havebeen requested for download are to have the specified HTML inserted atthe end (default="").
[<URL-SPEC>] anchor-not-cached-begin = (HTML code) |
Anchors (links) in the spooled page that are not in the cache orrequested are to have the specified HTML inserted at the beginning(default="").
[<URL-SPEC>] anchor-not-cached-end = (HTML code) |
Anchors (links) in the spooled page that are not in the cache orrequested are to have the specified HTML inserted at the end(default="").
[<URL-SPEC>] disable-script = yes | no
Removes all scripts and scripted events (default=no).
[<URL-SPEC>] disable-applet = yes | no
Removes all Java applets (default=no).
[<URL-SPEC>] disable-style = yes | no
Removes all stylesheets and style references (default=no).
[<URL-SPEC>] disable-blink = yes | no
Removes the <blink> tag from HTML but does not disable blink instylesheets (default=no).
[<URL-SPEC>] disable-marquee = yes | no
Removes the <marquee> tag from HTML to stop scrolling text(default=no).
[<URL-SPEC>] disable-flash = yes | no
Removes any Shockwave Flash animations (default=no).
[<URL-SPEC>] disable-iframe = yes | no
Removes any inline frames (the <iframe> tag) from HTML (default=no).
[<URL-SPEC>] disable-meta-refresh = yes | no
Removes any meta tags in the HTML header that re-direct the client tochange to another page after an optional delay (default=no).
[<URL-SPEC>] disable-meta-refresh-self = yes | no
Removes any meta tags in the HTML header that re-direct the client toreload the same page after a delay (default=no).
[<URL-SPEC>] disable-meta-set-cookie = yes | no
Removes any meta tags in the HTML header that cause cookies to be set(default=no).
[<URL-SPEC>] disable-dontget-links = yes | no
Disables any links to URLs that are in the DontGet section of theconfiguration file (default=no).
[<URL-SPEC>] disable-dontget-iframes = yes | no
Disables inline frame (iframe) URLs that are in the DontGet section ofthe configuration file (default=no).
[<URL-SPEC>] replace-dontget-images = yes | no
Replaces image URLs that are in the DontGet section of theconfiguration file with a static URL (default=no).
[<URL-SPEC>] replacement-dontget-image = (URL)
The replacement image to use for URLs that are in the DontGet sectionof the configuration file (default=/local/dontget/replacement.gif).
[<URL-SPEC>] replace-webbug-images = yes | no
Replaces image URLs that are 1 pixel square with a static URL(default=no). The webbug-images option in the FetchOptions sectioncan be used to stop these images from being automatically downloaded.
[<URL-SPEC>] replacement-webbug-image = (URL)
The replacement image to use for images that are 1 pixel square(default=/local/dontget/replacement.gif).
[<URL-SPEC>] demoronise-ms-chars = yes | no
Replaces strange characters that some Microsoft applications put intoHTML with character equivalents that most browsers can display(default=no). The idea for this comes from the public domainDemoroniser perl script.
[<URL-SPEC>] fix-mixed-cyrillic = yes | no
Replaces punctuation characters in cp-1251 encoding that are combinedwith text in koi-8 encoding that appears in some cyrillic web pages.
[<URL-SPEC>] disable-animated-gif = yes | no
Disables the animation in animated GIF files (default=no).

 

LocalHost

A list of hostnames that the host running the WWWOFFLE server may be known by.This is so that the proxy does not need to contact itself if the request has adifferent name for the same server.

(host)
A hostname or IP address that in connection with the port number (inthe StartUp section) specifies the WWWOFFLE proxy HTTP server. Thehostnames must match exactly, it is not a WILDCARDmatch. The firstnamed host is used as the server name for several features so must bea name that will work from any client host on the network. Theentries can be hostnames, IPv4 addresses or IPv6 addresses enclosedwithin '[...]'. None of the hosts named here are cached or fetchedvia a proxy.

 

LocalNet

A list of hostnames whose web servers are always accessible even when offlineand are not to be cached by WWWOFFLE because they are on a local network.

(host)
A hostname or IP address that is always available and is not to becached by WWWOFFLE. The host name matching uses WILDCARDs. A hostcan be excluded by appending a '!' to the start of the name. The hostvalue is matched against the URL as presented, no hostname to IP or IPto hostname lookups are performed to find alternative equivalentnames. The entries can be hostnames, IPv4 addresses or IPv6 addressesenclosed within '[...]'. All entries here are assumed to be reachableeven when offline. None of the hosts named here are cached or fetchedvia a proxy.

 

AllowedConnectHosts

A list of client hostnames that are allowed to connect to the server.

(host)
A hostname or IP address that is allowed to connect to the server.The host name matching uses WILDCARDs. A host can be excluded byappending a '!' to the start of the name. If the IP address orhostname (if available) of the machine connecting matches then it isallowed. The entries can be hostnames, IPv4 addresses or IPv6addresses enclosed within '[...]'. All of the hosts named inLocalHost are also allowed to connect.

 

AllowedConnectUsers

A list of the users that are allowed to connect to the server and theirpasswords.

(username):(password)
The username and password of the users that are allowed to connect tothe server. If this section is left empty then no user authenticationis done. The username and password are both stored in plaintextformat. This requires the use of clients that handle the HTTP/1.1proxy authentication standard.

 

DontCache

A list of URLs that are not to be cached by WWWOFFLE.

[!]URL-SPECIFICATION
Do not cache any URLs that match this. The URL-SPECIFICATIONcan benegated to allow matches to be cached. The URLs that are not cachedwill not have requests recorded if offline or fetched automatically.

 

DontGet

A list of URLs that are not to be got by WWWOFFLE when it is fetching and notto be served from the WWWOFFLE cache even if they exist.

[!]URL-SPECIFICATION
Do not get any URLs that match this. The URL-SPECIFICATIONcan benegated to allow matches to be got.
[<URL-SPEC>] replacement = (URL)
The URL to use to replace any URLs that match the URL-SPECIFICATIONsinstead of using the standard error message (default=none). The URLsin /local/dontget/ are suggested replacements (e.g. replacement.gif orreplacement.png which are 1x1 pixel transparent images orreplacement.js which is an empty javascript file).
<URL-SPEC> get-recursive = yes | no
Choose whether to get URLs that match this when doing a recursivefetch (default=yes).
<URL-SPEC> location-error = yes | no
When a URL reply contains a 'Location' header that redirects to a URLthat is not got (specified in this section) then the reply is modifiedto be an error message instead (default=no). This will stop ISPproxies from redirecting users to adverts if the advert URLs arein this section.

 

DontCompress

A list of MIME types and file extensions that are not to be compressed byWWWOFFLE (because they are already compressed or not worth compressing).Requires zlib compilation option.

mime-type = (mime-type)/(subtype)
The MIME type of a URL that is not to be compressed in the cache (whenpurging) or when providing pages to clients.
file-ext = .(file-ext)
The file extension of a URL that is not to be requested compressedfrom a server.

 

CensorHeader

A list of HTTP header lines that are to be removed from the requests sent toweb servers and the replies that come back from them.

[<URL-SPEC>] (header) = yes | no | (string)
A header field name (e.g. From, Cookie, Set-Cookie, User-Agent) andthe string to replace the header value with (default=no). The headeris case sensitive, and does not have a ':' at the end. The value of"no" means that the header is unmodified, "yes" or no string can beused to remove the header or a string can be used to replace theheader. This only replaces headers it finds, it does not add any newones. An option for Referer here will take precedence over thereferer-self and referer-self-dir options.
[<URL-SPEC>] referer-self = yes | no
Sets the Referer header to the same as the URL being requested(default=no). This will add the Referer header if none is containedin the original request.
[<URL-SPEC>] referer-self-dir = yes | no
Sets the Referer header to the directory name of the URL beingrequested (default=no). This will add the Referer header if none iscontained in the original request. This option takes precedence overreferer-self.
[<URL-SPEC>] referer-from = yes | no
Removes the Referer header based on a match of the referring URL(default=no).
[<URL-SPEC>] force-user-agent = yes | no
Forces a User-Agent header to be inserted into all requests that aremade by WWWOFFLE (default=no). This User-Agent is added only if thereis not an existing User-Agent header and is set to the valueWWWOFFLE/<version-number>. This header is inserted before censoringand may be changed by the normal header censoring method.
[<URL-SPEC>] pass-url-unchanged = yes | no
Forces WWWOFFLE to ignore the requirements on the correct formatting ofURLs and to pass through to the server the URL that was passed to it bythe browser (default=no).

 

FTPOptions

Options to use when fetching files using the ftp protocol.

anon-username = (string)
The username to use for anonymous ftp (default=anonymous).
anon-password = (string)
The password to use for anonymous ftp (default determined at runtime). If using a firewall then this may contain a value that is notvalid to the FTP server and may need to be set to a different value.
<URL-SPEC> auth-username = (string)
The username to use on a host instead of the default anonymoususername.
<URL-SPEC> auth-password = (string)
The password to use on a host instead of the default anonymouspassword.

 

MIMETypes

MIME Types to use when serving files that were not fetched using HTTP or forfiles on the built-in web-server.

default = (mime-type)/(subtype)
The default MIME type (default=text/plain).
.(file-ext) = (mime-type)/(subtype)
The MIME type to associate with a file extension. The '.' must beincluded in the file extension. If more than one extension matchesthen the longest one is used.

 

Proxy

This contains the names of the HTTP (or other) proxies to use external to theWWWOFFLE server machine.

[<URL-SPEC>] proxy = (host[:port])
The hostname and port on it to use as the proxy.
<URL-SPEC> auth-username = (string)
The username to use on a proxy host to authenticate WWWOFFLE to it.The URL-SPECin this case refers to the proxy and not the URL beingretrieved.
<URL-SPEC> auth-password = (string)
The password to use on a proxy host to authenticate WWWOFFLE to it.The URL-SPECin this case refers to the proxy and not the URL beingretrieved.
[<URL-SPEC>] ssl = (host[:port])
A proxy server that should be used for https or Secure Socket Layer(SSL) connections. Note that for the <URL-SPEC>that only the host ischecked and that the other parts must be '*' WILDCARDs.

 

Alias

A list of aliases that are used to replace the server name and path withanother server name and path.

URL-SPECIFICATION = URL-SPECIFICATION
Any requests that match the first URL-SPECIFICATIONare replaced bythe second URL-SPECIFICATION.The first URL-SPECIFICATIONis awildcard match for the protocol and host/port, the path must match thestart of the requested URL exactly and includes all subdirectories.

 

Purge

The method to determine which pages to purge, the default age the hostspecific maximum age of the pages in days, and the maximum cache size.

use-mtime = yes | no
The method to use to decide which files to purge, last access time(atime) or last modification time (mtime) (default=no).
max-size = (size)
The maximum size for the cache in MB after purging (default=-1). Amaximum cache size of -1 (or 0 for backwards compatibility) meansthere is no limit to the size. If this and the min-free options areboth used the smaller cache size is chosen. This option take intoaccount the URLs that are never purged when measuring the cache sizebut will not purge them.
min-free = (size)
The minimum amount of free disk space in MB after purging(default=-1). A minimum disk free of -1 (or 0) means there is nolimit to the free space. If this and the max-size options are bothused the smaller cache size is chosen. This option take into accountthe URLs that are never purged when measuring the cache size but willnot purge them.
use-url = yes | no
If true then use the URL to decide on the purge age, otherwise use theprotocol and host only (default=no).
del-dontget = yes | no
If true then delete the URLs that match the entries in the DontGetsection (default=no).
del-dontcache = yes | no
If true then delete the URLs that match the entries in the DontCachesection (default=no).
[<URL-SPEC>] age = (age)
The maximum age in the cache for URLs that match this (default=14).An age of zero means always to delete, negative means not to delete.The URL-SPECIFICATIONmatches only the protocol and host unlessuse-url is set to true. Longer times can be specified with a 'w', 'm'or 'y' suffix for weeks, months or years (e.g. 2w=14).
[<URL-SPEC>] compress-age = (age)
The maximum age in the cache for URLs that match this to be storeduncompressed (default=-1). Requires zlib compilation option. An ageof zero means always to compress, negative means never to compress.The URL-SPECIFICATIONmatches only the protocol and host unlessuse-url is set to true. Longer times can be specified with a 'w', 'm'or 'y' suffix for weeks, months or years (e.g. 2w=14).

 

WILDCARD

A WILDCARDmatch is one that uses the '*' character to represent any group ofcharacters.

This is basically the same as the command line file matching expressions inDOS or the UNIX shell, except that the '*' can match the '/' character.

For example

*.gif
matches foo.gif and bar.gif
*.foo.com
matches www.foo.com and ftp.foo.com
/foo/*
matches /foo/bar.html and /foo/bar/foobar.html

 

URL-SPECIFICATION

When specifying a host and protocol and pathname in many of the sections aURL-SPECIFICATIONcan be used, this is a way of recognising a URL.

For the purposes of this explanation a URL is considered to be made up of fiveparts.

proto
The protocol that is used (e.g. 'http', 'ftp')
host
The server hostname (e.g. 'www.gedanken.demon.co.uk').
port
The port number on the host (e.g. default of 80 for HTTP).
path
The pathname on the host (e.g. '/bar.html') or a directory name(e.g. '/foo/').
args
Optional arguments with the URL used for CGI scripts etc.(e.g. 'search=foo').

For example the WWWOFFLE homepage: http://www.gedanken.demon.co.uk/wwwoffle/The protocol is 'http', the host is 'www.gedanken.demon.co.uk', the port isthe default (in this case 80), and the pathname is '/wwwoffle/'.

In general this is written as (proto)://(host)[:(port)]/[(path)][?(args)]

Where [] indicates an optional feature, and () indicate a user supplied nameor number.

Some example URL-SPECIFICATIONoptions are the following:

*://*/*
Any protocol, Any host, Any port, Any path, Any args(This is the default for options that can have a <URL-SPEC>

prefix when none is specified).

*://*/(path)
Any protocol, Any host, Any port, Named path, Any args
*://*/*?
Any protocol, Any host, Any port, Any path, No args
*://*/(path)?*
Any protocol, Any host, Any port, Named path, Any args
*://(host)
Any protocol, Named host, Any port, Any path, Any args
(proto)://*/*
Named proto, Any host, Any port, Any path, Any args

(proto)://(host)/* Named proto, Named host, Any port, Any path, Any args

(proto)://(host):/* Named proto, Named host, Default port, Any path, Any args

*://(host):(port)/* Any protocol, Named host, Named port, Any path, Any args

The matching of the host, the path and the args use the WILDCARDmatching thatis described above. The matching of the path has the special condition that aWILDCARDof '/*/foo' will match '/foo' and '/any/path/foo', in other words itmatches any path prefix.

In some sections that accept URL-SPECIFICATIONs they can be negated byinserting the '!' character before it. This will mean that the comparisonof a URL with the URL-SPECIFICATIONwill return the logically opposite valueto what would be returned without the '!'. If all of the URL-SPECIFICATIONsin a section are negated and '*://*/*' is added to the end then the sense ofthe whole section is negated.

In all sections that accept URL-SPECIFICATIONs the comparison can be made caseinsensitive for the path and arguments part by inserting the '~' characterbefore it. (The host and the protocol comparisons are always caseinsensitive).

 

EXAMPLE


 StartUp
 {
  bind-ipv4         = 0.0.0.0
  bind-ipv6         = ::


  http-port         = 8080
  https-port        = 8443
  wwwoffle-port     = 8081


  spool-dir     = /var/spool/wwwoffle


  use-syslog    = yes


  password      =
 }


 Options
 {
  add-info-refresh  = no


  request-changed   = 3600
 }


 SSLOptions
 {
  enable-caching = no


  allow-tunnel   = *:443
 }


 FetchOptions
 {
  images = yes
  frames = yes
  iframes = yes
 }


 LocalHost
 {
  wwwoffle.foo.com


  localhost
  127.0.0.1


  ::ffff:127.0.0.1


  ip6-localhost
  ::1
 }


 DontGet
 [
  wwwoffle.DontGet.conf
 ]


 LocalNet
 {
  *.foo.com
 }


 AllowedConnectHosts
 {
  *.foo.com
 }


 Proxy
 {
  <http://foo.com/*> proxy = www-cache.foo.com:8080
 }


 Purge
 {
  max-size = 10
  age = 28
  <http://*.bar.com/*> age  = 7
 }

 

FILES

/etc/wwwoffle/wwwoffle.conf The wwwoffled(8) configuration file.

/var/spool/wwwoffle The WWWOFFLE spool directory.

 

SEE ALSO

wwwoffle(1), wwwoffled(8).

 

AUTHOR

Andrew M. Bishop 1996-2007 (ambAATTgedanken.demon.co.uk)

 

Index

NAME
Introduction
StartUp
Options
OnlineOptions
OfflineOptions
SSLOptions
FetchOptions
IndexOptions
ModifyHTML
LocalHost
LocalNet
AllowedConnectHosts
AllowedConnectUsers
DontCache
DontGet
DontCompress
CensorHeader
FTPOptions
MIMETypes
Proxy
Alias
Purge
WILDCARD
URL-SPECIFICATION
EXAMPLE
FILES
SEE ALSO
AUTHOR
This document was created byman2html,using the manual pages.