[next] [previous] [contents] [full-page]7.1 - Functional Groupings
7.2 - Alphabetic Listing
NOTE
The format of the configuration file has been changed between version 3 and version 4. This was to support on-line server configuration and administration (see 15 - Server Administration). The version 3 format will still be read by the HTTPd but the first time the configuration is updated on-line it is saved in the version 4 format, described below. The example configuration file can be used as a template.
Some directives take a single parameter, such as an integer, string or boolean value. Other directives can/must have multiple parameters. The version 4 configuration requires the directive to be placed on a line by itself and each separate parameter on a separate line following it. All parameter lines apply to the most recently encountered directive.
Note that all boolean directives are disabled (OFF)
by default. This is done so that there can be no confusion about what is
enabled and disabled by default. To use directive controlled facility it
must be explicitly enabled.
7.1 - Functional Groupings
|
|
|
|
|
|
|
|
|
|
|
|
One or more (comma-separated if on the same line) internet host/domain names, with "*" wildcarding for host/subdomain matching, to be explicitly allowed access. If DNS lookup is not enabled hosts must be expressed using numeric addresses (see [DNSLookup] directive). Also see the [Reject] directive. Reject directives have precedence over Accept directives. The Accept directive may be used multiple times.
Examples:
[Accept]
*.wasd.dsto.defence.gov.au
131.185.250.*
Specifies the number of days to record activity statistics, available in report form from the server administration menu (see 15.3 - HTTPd Server Reports). Zero disables this data collection. The maximum is 28 days. 11520 bytes per day, and 80640 per week, is required to store the per-minute data.
Specifies a directory listing icon and alternative text for the mime
content type specified in the template.
Examples:
[AddIcon]
/icon/-/doc.gif [HTM] text/html
/icon/-/text.gif [TXT] text/plain
/icon/-/image.gif [IMG] image/gif
[AddBlankIcon] /icon/-/blank.gif [AddDirIcon] /icon/-/dir.gif [DIR] [AddParentIcon] /icon/-/back.gif [<--] [AddUnknownIcon] /icon/-/unknown.gif [???]
Binds a file suffix (extension, type) to a mime content type.
The script name is used to auto-script against a specified file type. Use a
hyphen as a place-holder and to indicate no auto-script. The description is
used as documentation for directory listings.
[AddType]
.html text/html - HyperText Markup Language
.txt text/plain - plain text
.gif image/gif - image (GIF)
.hlb text/x-script /Conan VMS Help library
.decw$book text/x-script /HyperReader Bookreader book
* internal/x-unknown - application/octet-stream
#* internal/x-unknown - text/plain
The content-type string may include a specific character set. In this way
non-default sets (which is usually ISO-8859-1) can be specified for any
particular site or any particular file type. Enclose the content-type string
with double-quotation marks.
[AddType]
.html "text/html; charset=ISO-8859-1" - HTML (ISO-8859-1)
.html_5 "text/html; charset=ISO-8859-5" - Cyrillic HTML (ISO-8859-5)
.html_r "text/html; charset=KOI8-R" - Cyrillic HTML (KOI8-R)
.txt "text/plain; charset=ISO-8859-1" - plain text (ISO-8859-1)
.txt_5 "text/plain; charset=ISO-8859-5" - Cyrillic text (ISO-8859-5)
.txt_r "text/plain; charset=KOI8-R" - Cyrillic text (KOI8-R)
(Versions prior to 3.2 used this configuration directive for the MIME content-type to determine whether a file was transfered record-by-record or in binary. This is no longer required and should be removed from existing configuration files.)
Enables or disables BASIC username authentication. See 12 - Authentication and Authorization.
The number of minutes authentication information is cached before being revalidated from the authentication source. Zero disables caching (with a resultant impact on performance as each request requiring authentication is validated directly from the source).
Enables or disables Digest username authentication. See 12 - Authentication and Authorization.
The number of seconds a digest nonce for a GET request (read) can be used before becoming stale.
The number of seconds a digest nonce for a PUT (/POST/DELETE ... write) request can be used before becoming stale.
The number of unsuccessful attempts at authentication before the username is disabled. Once disabled any subsequent attempt is automatically refused without further reference to the authentication source. A disabled username can be reenabled by simply purging the cache.
When user revalidation is in effect (see immediately below), after having previously closed the browser initial authentication of a resource is immediately followed by another if a cached entry on the server indicated revalidation was required. This prevents this second request.
The number of minutes between authenticated requests that user authentication remains valid before the user is forced to reenter the authentication information (via browser dialog). Zero disables the requirement for revalidation.
The number of bytes (and hence BYTLM quota) permanently allocated to each scripting subprocess CGIPLUSIN mailbox.
The number of bytes (and hence BYTLM quota) permanently allocated to each scripting subprocess SYS$COMMAND mailbox.
The number of bytes (and hence BYTLM quota) permanently allocated to each scripting subprocess SYS$OUTPUT mailbox.
The number of bytes allocated to the network read buffer (used for request header, POST body, etc.). Also the number of bytes (and hence BYTLM quota) permanently allocated to each scripting subprocess SYS$INPUT mailbox (allowing a script to read a request body).
Number of bytes allocated to the network write buffer. This buffer is used as the basic unit when transfering file contents (from cache or the file system), as an output buffer during SSI pocessing, directory listing, etc. During many activities multiple outputs are buffered into this storage before being written to the network.
The maximum number of concurrent client connections before a "server too busy right now ... try again shortly" error is returned to the client.
File cache control.
Granularity of memory blocks allocated to file data, in kilobytes.
Maximum number of files loaded into the cache before entries are reused removing the original contents from the cache.
Maximum size of a file before it is not a candidate for being cached, in kilobytes.
Minimum, total number of hits an entry must sustain before being a candidate for [CacheFrequentSeconds] assessment.
If a file has been hit at least [CacheFrequentHits] times in total and the last was within the number of seconds here specified it will not be a candidate for reuse. See 17 - Cache.
Size of the hash table.
Maximum memory allocated to the cache, in kilobytes.
The interval after which a cache entry's original, content revision time is revalidated against the file's current revision time. If not the same the contents are declared invalid and reloaded.
The default character set sent in the response header for text documents (plain and HTML). English language sites should specify ISO-8859-1, other Latin alphabet sites, ISO-8859-2, 3, etc. Cyrillic sites might wish to specify ISO-8859-5 or KOI8-R, and so on.
A script must output a full HTTP or CGI-compliant response. If a plain-text stream is output an error is reported (being the more common behaviour for servers). Errors in output can be disagnosed using the WATCH facility.
Whenever the last scripting process is removed from the system, or this number of minutes maximum (whichever occurs first), scan the HT_SCRATCH directory (if logical defined and it exists) deleting all files that are older than [DclCleanupScratchMinutesOld] minutes. Setting to zero disables HT_SCRATCH scans.
When performing a [DclCleanupScratchMinutesMax] scan delete files that are older than this value (or the value specified by [DclCleanupScratchMinutesMax], whichever is the larger).
This value represents time in minutes. If this value is zero CGIplus subprocess may persist indefinitely (excluding explicit and proactive server purging). If non-zero the CGIplus subprocess is terminated the specified number of minutes after it last processed a request. This helps prevent sporadically used scripts from clogging up a system.
By default scripts are executed within server subprocesses. When enabled this instructs the server to create detached processes. This side-steps the issues of having pooled process quotas and also allows non-server-account scripting (see 5.3 - HTTPd Command Line, User Account Scripting and in particular "Scripting Overview, Introduction".
When detached scripting processes are created it is possible to assign them
base priorities lower that the server itself. This directive takes one or two
(comma-separated) integers that determine how many priorities lower than the
server scripting processes are created. The first integer determines server
processes. A second, if supplied, determines user scripts. User scripts may
never be a higher priority that server scripts.
[DclDetachProcessPriority] 1
[DclDetachProcessPriority] 0,1
[DclDetachProcessPriority] 1,2
The first of these examples would set both server and user script
processes one below the server process. The second, server scripts at the same
priority and user scripts one below. The last, server scripts one below, and
user scripts two below.
When enabled, non-SSL, subprocess script CGI environments have a CGI variable WWW_GATEWAY_BG created containing the device name (BGnnnn:) of the TCP/IP socket connected to the client. This socket may be accessed by the script for transmission of data directly to the script bypassing the server entirely. This is obviously much more efficient for certain classes of script. For purposes of accurate logging the server does need to be informed of the quantity of data transfered using a CGI callout. See "Scripting Environment" document.
The maximum number of DCL/CGI script processing subprocesses that may ever exist concurrently (works in conjunction with [DclSoftLimit].
One or more file type (extension) specification and scripting verb pairs. See "Scripting Overview, Runtime".
The number of DCL/CGI script processing subprocesses after which idle subprocesses are deleted to make room for new ones. The [DclHardLimit] should be approximately 25% more than the [DclSoftLimit]. The margin exists to allow for occasional slow run-down of deleted/finishing subprocesses. If these limits are not set (i.e. zero) they are calculated with [Busy] using "[DclSoftLimit] = [Busy]" and "[DclHardLimit] = [DclSoftLimit] + [DclSoftLimit] / 4".
By default, when a DCL/scripting subprocess is spawned it inherits the server's currently enabled privileges, which are none, not even TMPMBX or NETMBX. If this parameter is enabled the subprocess is created with the server account's SYSUAF-authorized privileges (which should never be other than NETMBX and TMPMBX). Use with caution.
This value represents time in minutes. If this value is zero the use of persistant DCL subprocesses is disabled. If non-zero the zombie subprocess is terminated the specified number of minutes after it last processed a request. This helps prevent zombie processes from clogging up a system. See "Scripting Environment" document.
The number of minutes a DECnet scripting connection is maintained with the network task. Zero disables connection reuse.
The size of the list used to manage connections for DECnet scripting. Zero effectively allows the server to use as many DECnet scripting connections as demanded.
Controls directory listings. SELECTIVE allows access only to those directories containing a file .WWW_BROWSABLE. The WASD HTTPd directory access facility always ignores directories containing a file named .WWW_HIDDEN. Also see the [DirWildcard] directive.
Specifies the HTML <BODY> tag for directory listing pages. This allows some measure of site "look-and-feel" in page colour, background, etc. to be employed.
Non-Zero enables HTML file descriptions during listings. Generating HTML descriptions involves opening each HTML file and searching for <TITLE>...</TITLE> and <H1>...</H1> text to generate the description. This is an obviously resource-intensive activity and on busy servers or systems may be disabled. Any non-zero number specifies the number of lines to be searched before quitting. Set to a very high number to search all of files' contents (e.g. 999999).
Allows specification of the directory listing layout. This is a short, case-insensitive string that specifies the included fields, relative placement and optionally the width of the fields in a directory listing. Each field is controlled by a single letter and optional leading decimal number specifying its width. If a width is not specified an appropriate default applies. An underscore is used to indicate a single space and is used to separate the fields (two consecutive works well).
The following shows some examples:
[DirLayout] I__L__R__S__D
[DirLayout] I__L__R__S:b__D
[DirLayout] I__15L__S__D
[DirLayout] UI__15L__S__D
[DirLayout] 15L__9R__S
[DirLayout] 15N_9C_9R_S
[DirLayout] I__L__R__S:d__D
[DirLayout] 25D:l__S:b__C__R
The size of files is displayed by default as 1024 byte kilos. When using
the "S:k", "S:m" and "S:f" size modifiers the size is
displayed as 1000 byte kilos. If it is prefered to have the default display
in 1000 byte kilos then set the directory listing layout using:
[DirLayout] I__L__R__S:d__D
If unsure of the kilo value being used check the "<META>" information in the directory listing.
Includes, as <META> information, the software ID of the server and any relevant VMS file information.
When a directory is accessed having no file or type component and there is no welcome page available a directory listing is generated. By default any other directory accessed from this listing has the implied wildcards "*.*" added, consequently forcing directory listings. If enabled, this directive ensures no wildcards are added, so subsequent directories accessed with welcome pages display the pages, not a forced listing.
To prevent browsing through directories (perhaps due to inadvertant mapping) that have file permissions allowing no WORLD access the server stops listing and reports the error the first time a protection violation occurs. This behaviour may be changed to ignore the violation, listing only those files to which it has access.
Allows specification and display of the RMS file owner information.
Directory listings and trees may be pre-expired. That is, the
listing is reloaded each time the page is referenced. This is convenient in
some environments where directory contents change frequently, but adds
considerable over-head and so is disabled by default. Individual directory
listings may have the default behaviour over-ridden using syntax similar to the
following examples:
/dir1/dir2/*.*?httpd=index?expired=yes
/dir1/dir2/*.*?httpd=index?expired=no
/tree/dir2/?httpd=index?expired=yes
/tree/dir1/dir2/?httpd=index?expired=no
If any of the files provided using the [DirReadMeFile] directive are located in the directory the contents are included at the top or bottom of the listing (or not at all). Plain-text are included as plain-text, HTML are included as HTML allowing markup tags to be employed.
Specifies the names and order in which a directory is checked for read-me files. This can be enabled or disabled using the [DirReadme] directive. Plain-text are included as plain-text, HTML are included as HTML allowing markup tags to be employed.
Examples:
[DirReadMeFile]
readme.html
readme.htm
readme.
readme.txt
readme.1st
This enables the facility to force the server to provide a directory listing by providing a wildcard file specification, even if there is a home (welcome) document in the directory. This should not be confused with the [DirAccess] directive which controls directory listing itself.
Enables or disables connection request host name resolution. This functionality may be expensive (in terms of processing overhead) and make serving granularity coarser if DNS is involved. If not enabled and logging is, the entry is logged against the numeric internet address. If not enabled any [Accept], [Reject] directive, etc., must be expressed as numeric addresses.
This functionality significantly slows request processing. See 18 - Server Performance.
Specifies the URL-format path to an optional, error reporting SSI document or script. See 6.4 - Error Reporting. This path can subsequently be remapped during request processing.
Provides a short message recommending action when reporting an error to a
client. For example, if a document cannot be found it may say:
(document, or bookmark, requires revision)
Enables or disables the request log. Logging can slow down request processing and adds overhead. The log file name must be specified using the /LOG qualifier or HTTPD$LOG logical name (see Logical Names.
One or more (comma-separated if on the same line) internet host/domain names, with "*" wildcarding for host/subdomain matching, requests from which are not placed in any log files. If DNS lookup is not enabled hosts must be expressed using numeric addresses (see [DNSLookup] directive). Use for excluding local or web-maintainer's host from logs.
Example:
[LogExcludeHosts]
*.wasd.dsto.defence.gov.au
131.185.250.*
Specifies one of three pre-defined formats, or a user-definable format. See 6.5.1 - Log Format.
When [LogPeriod] or [LogPerService] directives are used to generate multiple log files this directive may be used to modify the naming of the file. See 6.5.4 - Log Naming.
Specifies a period at which the log file is changed. See 6.5.2 - Log Period.
When multiple services are specified (see 6.3 - Virtual Services) a separate log file will be created for each if this is enabled. See 6.5.3 - Log Per-Service.
When generating a log name do not make the port number part of it. This effectively provides a single log file for all ports provided against a host name (e.g. a standard HTTP service on port 80 and an SSL service on port 443 would have entries in the one file). See 6.5.3 - Log Per-Service.
Allows monitoring via the HTTPDMON utility (see 20.6 - HTTPd Monitor. Adds slight request processing overhead.
Report to operator log and any enabled operator console (see [OpcomTarget]) server administartion directives originating from the Server Administration Menu, for example path map reload, server restart, etc.
Report events related to authentication/authorization. For example username-password validation failures.
Report HTTPD/DO=directive control events, both the command-line directive and the server's response.
Report events concerning the server itself. For example, server startup and exit (either normally or with error status).
Report events related to proxy server cache maintenance. For example, the commencement of file cache reactive and proactive purging, the conclusion of this purge, both with cache device statistics.
This enables OPCOM messaging and specifies the target for the OPCOM reports. This must be set to a target to enable OPCOM messages, irrespective of the setting of any of the other [Opcom...] directives. These messages are added to SYS$MANAGER:OPERATOR.LOG and displayed at the specified operator's console if enabled (using REPLY/ENABLE=target). The operator log provides a "permanent" record of server events. Possible settings include CENTRAL, NETWORK, SECURITY, OPER1 ... OPER12, etc.
IP port number for server to bind to. For anything other than a command-line server control (see 5.3.2 - Server Command Line Control) this parameter is overridden by anything supplied via the [Service] directive.
Enables and disables the addition of a proxy request header line providing information that the request has been forwarded by another agent. The added header line would look like "Forwarded: by http://host.name.domain (HTTPd-WASD/n.n.n OpenVMS/AXP Digital-TCPIP SSL)".
When the server is resolving the name of a remote host the request may timeout due to up-stream DNS server latencies. This parameter allows a number of retries, at five second intervals, to be enabled.
Enables or disables the server process log reporting siginificant proxy processing events, such as cache maintenance activity.
Enables or disables the server process log reporting of proxy caching activity.
Enables or disables proxy serving on a whole-of-server basis, irrespective of any proxy services that might be configured.
Enables or disables proxy caching on a whole-of-server basis, irrespective of any proxy services that might be configured for caching.
Maximum size of a cache file in kilobytes before it will not be cached.
Hour of day for routine cache purge (00-23).
Interval in minutes between checking space availablility on cache device. If space is not available a reactive purge is initiated.
Organization of directories on the proxy cache device. The first provides a single level structure with a possible 256 directories at the top level and files organized immediately below these. For versions of VMS prior to V7.2 exceeding 256 files per directory, or a total of approximately 65,000 files, incurs a significant performance penalty for some directory operations. The second organization involves two levels of directory, each with a maximum of 64 directories. This allows for approximately 1,000,000 files before encountering the 256 file per directory issue.
The maximum percentage in use on the cache device before a reactive purge is scheduled. If device usage exceeds this limit no more cache files are created.
The percentage by which the cache device usage is attempted to be reduced when a reactive purge is initiated.
A list of comma-separated integers representing the sequence of last accessed period in hours used during a progressive reactive purge.
A list of comma-separated integers representing the sequence of age in hours used when determining whether a cache file's contents should be reloaded.
The period at which the cache of host names to IP addresses is purged.
Maximum size of an HTTP POST or PUT method request in Kilobytes.
File created using the POST or PUT methods have the specified version limit applied.
One or more (comma-separated if on the same line) internet host/domain names, with "*" wildcarding for host/subdomain matching, to be explicitly denied access. If DNS lookup is not enabled hosts must be expressed using numeric addresses (see [DNSLookup] directive). Also see the [Accept] directive. Reject directives have precedence of Accept directives. The Reject directive may be used multiple times.
Example:
[Reject]
*.wasd.dsto.defence.gov.au
131.185.250.*
Only ever supply basic information in a report (see 6.4 - Error Reporting).
Includes in detailed reports, as <META> information, the software ID of the server and any relevant VMS file information.
The server can keep a list of the most recent requests accessable from the server administration menu. This value determines the number kept. Zero disables the facility. Each retained request consumes 256 bytes and adds a small amount of extra processing overhead.
Enables and disables all scripting mechanisms. This includes subprocess CGI and CGIplus, DECnet-based OSU and CGI, and SSI directives that DCL subprocesses to provide <--#dcl -->, <--#exec -->, etc.
Specifies the URL-format path to the default query-string keyword search script. This path can subsequently be remapped during request processing.
Example:
[SearchScript] /ht_root/script/query
Provides a list of file types that are excluded from an implied keyword search. This is useful for client-side (browser-side) active processing that may require a query string to pass information. This query string would normally be detected by the server and if not in a format to be meaningful to itself is then considered as an implied (HTML <ISINDEX>) keyword search, with the approriate script being activiated.
Example:
[SearchScriptExclude] .HTA,.HTL
Specifies the contact email address for server administration issues. Included as a "mailto:" link in the server signature if [ServerSignature] is set to email.
Specifies the HTML <BODY> tag for server administration and administration report pages. This allows some measure of control over the "look-and-feel" of page and link colour, etc.. for the administrator.
Specifies the HTML <BODY> tag for server error and other report pages. This allows some measure of site "look-and-feel" in page colour, background, etc. to be maintained.
The server signature is a short identifying string added to server generated error and other report pages. It includes the server software name and version, along with the host name and port of the service. Setting this to email makes the host name a mailto: link containing the address specified by the [ServerAdmin] directive.
This parameter allows SSL, multi-homed hosts and multiple port serving to be specified, see 14.1 - SSL Configuration and 6.3 - Virtual Services.
Provides a default path for reporting a virtual host does not exist, see Unknown Virtual Server.
Enables or disables Server Side Includes (HTML pre-processing).
Enables or disables Server Side Includes (HTML pre-processing) file access counter.
Enables or disables Server Side Includes (HTML pre-processing) DCL execution functionality.
Enables or disables automatic conversion of VARIABLE record format documents (files) to STREAM-LF, which are much more efficient with this server. The integer is the maximum size of a file in kilobytes that the server will attempt to convert. Zero disables any conversions. See File Record Format.
(Retired in v5.3, mapping SET rule provides this now, see 10.3.5 - SET Rule).
Number of minutes to allow a connection request to be in progress without submitting a complete request header before terminating it.
Number of seconds a "Keep-Alive:" request connection is maintained after the conclusion of a request. Keep-Alive improves the overall performance of the server by reducing the number of discrete TCP/IP connections that need to be establiched.
Number of minutes to allow request output to continue without any increase in the number of bytes transfered. This directive is targeted at identifying and eliminating requests that have stalled.
Number of minutes to allow a request to be output before terminating it. This directive sets an absolute maximum time a request can continue to receive output.
Enables session (user) tracking.
By default the tracking cookie is discarded by the browser when it is closed. This setting directs the browser to keep it between sessions.
User tracking applies only to the originating (virtual) server by default. This directive allows it to applied to all a particular domain's sites. Top-level sites (e.g. those in ".com", ".edu" etc.) would specify this as something like organization.domain (i.e. two dots), while other would use organization.group.domain (i.e. three dots).
Specifies the names and order in which a directory is checked for home page files. If no home page is found a directory listing is generated.
Examples:
[Welcome]
home.html
home.htm
home.menu
home.mnu