# WASD Hypertext Services - Technical Overview

## 8 - Server Configuration Directives

> 8.1 - Functional Groupings
> 8.2 - Alphabetic Listing

[next] [previous] [contents] [full-page]

The example configuration file can be used as a template.

By default, the system-table logical name HTTPD$CONFIG locates a common configuration file, unless a per-server file is specified using a job-table logical name. Simple editing of the configuration file changes the rules. Alternatively the Server Administration page configuration interface may be used.

The [IncludeFile] is a directive common to all WASD configuration, allowing a separate file to be included as a part of the current configuration. See 6.12 - Include File Directive.

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.

###
8.1 - Functional Groupings

Authentication/Authorization

[AuthBasic] | enable BASIC method
| [AuthCacheEntriesMax] | maximum concurrent authentication cache entries
| [AuthCacheEntrySize] | maximum authentication cache entry size in bytes | [AuthCacheMinutes] | minutes before explicitly reauthorizing user from sources | [AuthDigest] | enable DIGEST method | [AuthDigestGetLife] | DIGEST method GET lifetime | [AuthDigestPutLife] | DIGEST method PUT lifetime | [AuthFailureLimit] | retries allowed before username is marked as intruder | [AuthRevalidateLoginCookie] | helps prevent redundant authorization requests when user revalidation is enabled | [AuthRevalidateUserMinutes] | minutes before use needs to reenter password | [AuthSysUafAcceptExpPwd] | accept expired SYSUAF passwords | [AuthSysUafPwdExpURL] | redirection URL is SYSUAF password is expired | [AuthSysUafUseAcme] | use the ACME service for all VMS SYSUAF based authentication

Buffer Sizes

[BufferSizeDclCgiPlusIn] | number of bytes allocated to scripting subprocess CGIPLUSIN mailbox
| [BufferSizeDclCommand] | bytes allocated to scripting subprocess SYS$COMMAND mailbox
| [BufferSizeDclOutput] | bytes allocated to scripting subprocess SYS$OUTPUT mailbox | [BufferSizeNetRead] | bytes allocated to client request read buffer, and to the scripting subprocess SYS$INPUT mailbox | [BufferSizeNetWrite] | bytes allocated to client output buffer

Content-Type

[AddType] | add a content-type
| [AddMimeTypesFile] | add the contents of a standard MIME.TYPES file
| [CharsetConvert] | conversion of one character set to another | [CharsetDefault] | default character set for text responses | [StreamLF] | enable and set maximum size of automatic Stream-LF conversion

Directory Listing

[AddIcon] | path to icon for a specified content-type
| [AddBlankIcon] | path to blank icon
| [AddDefaultIcon] | path to default icon | [AddDirIcon] | path to directory icon | [AddParentIcon] | path to parent icon | [AddUnknownIcon] | path to icon for unknown content-type | [DirAccess] | enable and form of listing | [DirBodyTag] | specify HTML body tag of listing pages | [DirDescriptionLines] | number of HTML file lines searched for document title | [DirLayout] | layout of the various listing components | [DirMetaInfo] | add server and VMS directory information | [DirNoImpliedWildcard] | do not add wildcards to request if not present in path | [DirNoPrivIgnore] | ignore, do not report, privilege violations on files/directories | [DirOwner] | allow owner of file to be included in layout directive | [DirPreExpired] | pre-expire listing responses | [DirReadMeFile] | specify read-me files | [DirWildcard] | allow wildcards to be specified at all

File Cache

[CacheChunkKBytes] | memory block allocation size
| [CacheEntriesMax] | maximum number of files allowed in cache
| [CacheFileKBytesMax] | maximum size of a file | [CacheFrequentIntervals] | identify active files | [CacheFrequentPeriod] | identify active file | [CacheGuardPeriod] | prevent early reloads | [CacheTotalKBytesMax] | maximum memory to be consumed by cache | [CacheValidatePeriod] | maximum period before the cache checks for file modification

Logging

[Logging] | enable logging
| [LogExcludeHosts] | hosts to be excluded from log
| [LogExtend] | default allocation/extend in blocks | [LogFile] | provides part or all of log file name | [LogFormat] | nature and layout of log contents | [LogNaming] | how the log name is be constructed | [LogPeriod] | period at which new logs are created | [LogPerInstance] | create a separate log for each instance process | [LogPerService] | create a separate log for each configured service | [LogPerServiceHostOnly] | suppress service port number as component of log name | [Track] | enable session tracking | [TrackMultiSession] | track across sessions | [TrackDomain] | host or hosts it applies to

Operator Console and Log

[OpcomAdmin] | Server Administration directives
| [OpcomAuthorization] | authentication/authorization messages, e.g. failures
| [OpcomControl] | CLI HTTPd control directives | [OpcomHTTPd] | HTTPd events (e.g. startup, exit, SSL private key password requests) | [OpcomProxyMaint] | proxy file cache maintenance | [OpcomTarget] | target operator for online messages

Miscellaneous

[Accept] | restrictive list of host from which to accept requests
| [ActivityDays] | activity graph duration
| [Busy] | number of concurrent connections allowed | [DNSLookupClient] | enable client host name lookup | [DNSLookupLifeTime] | host name lookup cache entry lifetime | [DNSLookupRetry] | number two second attempts to resolve client host name | [InstanceMax] | number of per-node server processes to maintain | [Monitor] | enable HTTPDMON data exchange | [Port] | default port | [PutMaxKBytes] | maximum size of a POST or PUT | [PutVersionLimit] | maximum RMS file versions retained in a POST or PUT | [RegEx] | enable regular expression matching | [Reject] | proscriptive list of hosts from which request will be rejected | [RequestHistory] | number of requests kept for request report | [SearchScript] | path to default search script | [SearchScriptExclude] | list of file extensions excluded from implied keyword search | [Service] | list of host names and/or port to create services for | [ServiceNotFoundURL] | redirection URL when a request service is not configured | [Welcome] | list of file names that are checked for as home pages

Proxy Serving

[ProxyCache] | enable proxy caching
| [ProxyCacheFileKBytesMax] | maximum size of response for caching
| [ProxyCacheDeviceCheckMinutes] | minutes between check of cache device usage | [ProxyCacheDeviceDirOrg] | flat 256 or 64x64 directory organization | [ProxyCacheDeviceMaxPercent] | maximum percentage of cache device used before purge | [ProxyCacheDevicePurgePercent] | during purge reduce by this many percent | [ProxyCacheNoReloadSeconds] | prevent pragma reloads for this period | [ProxyCachePurgeList] | list of file ages used during purge | [ProxyCacheReloadList] | list of file ages before realod from source | [ProxyCacheRoutineHourOfDay] | hour of day routine cache purge occurs | [ProxyForwarded] | add "Forwarded:" to requests | [ProxyHostLookupRetryCount] | DNS resolution retry count | [ProxyReportLog] | report failures to process log | [ProxyReportCacheLog] | report cache failures to process log | [ProxyServing] | enable proxy server | [ProxyXForwardedFor] | add "X-Forwarded-For:" to requests

Reports

[ErrorReportPath] | path to script, SSI or "flat" error document
| [ErrorRecommend] | for server generated error include probable cause
| [ReportBasicOnly] | only ever generate reports containing basic details | [ReportMetaInfo] | add server information to directory listings, etc. | [ServerAdmin] | email address for server-related contact | [ServerAdminBodyTag] | specify HTML body tag of Server Administration (menu) pages | [ServerReportBodyTag] | specify HTML body tag of error and other report pages | [ServerSignature] | add server information to the foot of error and other report pages

Request Timeout

[TimeoutInput] | period a connection can wait before sending request
| [TimeoutKeepAlive] | period a connection is kept active after request conclusion
| [TimeoutOutput] | period a response can continue to output | [TimeoutNoProgress] | period a response can continue without data transfer progress

Scripting

[CgiStrictOutput] | script output must be CGI compliant
| [DclBitBucketTimeout] | period a script continues after a client prematurely disconnects
| [DclCgiPlusLifeTime] | period of non-use before CGIplus subprocess is deleted | [DclCleanupScratchMinutesMax] | maximum minutes between HT_SCRATCH cleanups | [DclCleanupScratchMinutesOld] | cleanup files older than this | [DclDetachProcess] | use detached scripting processes rather than subprocesses | [DclGatewayBG] | enable raw TCP/IP socket for scripts | [DclHardLimit] | maximum number of concurrent subprocesses | [DclScriptRunTime] | script execution environment | [DclSoftLimit] | maximum number of subprocesses before proactive deletion begins | [DclSpawnAuthPriv] | spawn subprocesses with account's authorized privileges | [DclZombieLifeTime] | period of non-use before a CGI/CLI subprocess is deleted | [DECnetReuseLifeTime] | period of non-use before a DECnet process is released | [DECnetConnectListMax] | maximum number of DECnet processes | [Scripting] | enables and disables all scripting

Server Side Includes

[SSI] | enable Server Side Includes (SSI)
| [SSIaccesses] | allow access counting
| [SSIexec] | allow DCL commands | [SSIsizeMax] | maximum source file size

###
8.2 - Alphabetic Listing

1. [Accept] host/domain name (default: all)

   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 literal 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.*

2. [ActivityDays] integer (default: 0)

   Specifies the number of days to record activity statistics, available in report form from the Server Administration page (18.4 - 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.

3. [AddIcon] icon-URL ALT-text template (no default)

   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

4. [AddBlankIcon] icon-URL
   [AddDefaultIcon] icon-URL ALT-text
   [AddDirIcon] icon-URL ALT-text
   [AddParentIcon] icon-URL ALT-text
   [AddUnknownIcon] icon-URL ALT-text (no defaults)
   Specifies a directory listing icon for these non-content-type parts of the listing.
   Examples:

         [AddBlankIcon]    /icon/-/blank.gif    _____
         [AddDefaultIcon]  /icon/-/file.gif     [FIL]
         [AddDirIcon]      /icon/-/dir.gif      [DIR]
         [AddParentIcon]   /icon/-/back.gif     [<--]
         [AddUnknownIcon]  /icon/-/unknown.gif  [???]

5. [AddMimeTypesFile] file specification (no default)

   Add the content-types of a (de facto) standard MIME.TYPES file to the already configured [AddType] content-types. This binds a file suffix (extension, type) to a MIME content-type. Any specification in this file will supercede any previously defined via [AddType]. A MIME.TYPES file looks something like

         # MIME type			Extension
         application/msword            doc
         application/octet-stream      bin dms lha lzh exe class
         application/oda               oda
         application/pdf               pdf
         application/postscript        ai eps ps
         application/rtf               rtf

   The WASD server uses a number of extensions to provide additional information. See 6.6 - Content-Type Configuration.

6. [AddType] .suffix content-type [script-name] [description] (no default)

   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)

   To provide additional information for correct handling of FTP transfers the content-type may have an FTP transfer mode indicated. This is provided by appending the mode directly after the content type (allow no white-space). One of three characters is used. An "A" indicates that this file type should be FTP transfered in ASCII mode. An "I" or a "B" indicates that this file type should be FTP transfered in Image (binary) mode. The following example provides the syntax.

         [AddType]
         .ps    application/postscript(ftp:A)   Postscript document

7. [AuthBasic] `ENABLED|DISABLED` (default: DISABLED)

   Enables or disables BASIC username authentication. See 15 - Authentication and Authorization.

8. [AuthCacheEntrySize] integer (default: 768)

   Maximum size of an authentication cache entry. The only reason where this may need to be increased is where a site is using the /PROFILE functionality and one or more accounts have a particularly large number of rights identifiers.

9. [AuthCacheMinutes] integer (default: 60)

   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).

10. [AuthDigest] `ENABLED|DISABLED` (default: DISABLED)

    Enables or disables Digest username authentication. See 15 - Authentication and Authorization.

11. [AuthDigestGetLife] integer (default: 0)

    The number of seconds a digest nonce for a GET request (read) can be used before becoming stale.

12. [AuthDigestPutLife] integer (default: 0)

    The number of seconds a digest nonce for a PUT (/POST/DELETE ... write) request can be used before becoming stale.

13. [AuthFailureLimit] integer (default: 10)

    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.

14. [AuthRevalidateLoginCookie] `ENABLED|DISABLED` (default: DISABLED)

    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.

15. [AuthRevalidateUserMinutes] integer (default: 60)

    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.

16. [AuthSysUafAcceptExpPwd] `ENABLED|DISABLED` (default: DISABLED)

    If a SYSUAF authenticated password has expired (password lifetime has been reached) accept it anyway (in much the same way network logins are accepted in similar circumstances). This is very different to account expiry, after which authentication is always rejected.

17. [AuthSysUafPwdExpURL] string (default: none)

    If a SYSUAF authenticated password is/has expired the request is redirected to this URL to change the password. See 15.14 - User Password Modification

18. [AuthSysUafUseAcme] `ENABLED|DISABLED` (default: DISABLED)

    On applicable platforms (Alpha (and IA64?), OpenVMS 7.3 and later) use the ACME service to perform SYSUAF authentication and SYSUAF password change. The immediate advantage of using ACME is the processing of the (rather complex) authentication requirements by a vendor-supplied implementation. It also allows SYSUAF password change to be made subject to the full site policy (password history, dictionary checking, etc.) which WASD does not implement.

19. [BufferSizeDclCgiPlusIn] integer (default: 2048)

    The number of bytes (and hence BYTLM quota) permanently allocated to each scripting subprocess CGIPLUSIN mailbox.

20. [BufferSizeDclCommand] integer (default: 3072)

    The number of bytes (and hence BYTLM quota) permanently allocated to each scripting subprocess SYS$COMMAND mailbox.

21. [BufferSizeDclOutput] integer (default: 4096)

    The number of bytes (and hence BYTLM quota) permanently allocated to each scripting subprocess SYS$OUTPUT mailbox.

22. [BufferSizeNetRead] integer (default: 2048)

    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).

23. [BufferSizeNetWrite] integer (default: 4096)

    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.

24. [Busy] integer (default: 10)

    The maximum number of concurrent client connections before a "server too busy right now ... try again shortly" error is returned to the client.

25. [Cache] `ENABLED|DISABLED` (default: DISABLED)

    File cache control.

26. [CacheChunkKBytes] integer (default: 0)

    Granularity of memory blocks allocated to file data, in kilobytes.

27. [CacheEntriesMax] integer (default: 0)

    Maximum number of files loaded into the cache before entries are reused removing the original contents from the cache.

28. [CacheFileKBytesMax] integer (default: 0)

    Maximum size of a file before it is not a candidate for being cached, in kilobytes.

29. [CacheFrequentIntervals] integer (default: 0)

    Minimum, total number of hits an entry must sustain before being a candidate for [CacheFrequentPeriod] assessment.

30. [CacheFrequentPeriod] hh:mm:ss (default: 00:00:00)

    If a file has been hit at least [CacheFrequentIntervals] times in total and the last was within the period here specified it will not be a candidate for reuse. See 20 - Cache.

31. [CacheGuardPeriod] integer (default: 15)

    During this period subsequent reloads (no-cache) requests will not result in the entry being revalidated or reloaded. This can guard period can help prevent unnecessary file system activity.

32. [CacheHashTableEntries] integer (default: 0)

    Obsolete for WASD V8.0 and following.

33. [CacheTotalKBytesMax] integer (default: 0)

    Maximum memory allocated to the cache, in kilobytes.

34. [CacheValidatePeriod] hh:mm:ss (default: 00:00:00)

    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.

35. [CharsetConvert] string (default: none)

    Document and CGI script output can be dynamically converted from one character set to another using the standard VMS NCS conversion library. This directive provides the server with character set aliases (those that are for all requirements the same) and which NCS conversion function may be used to convert one character set into another. The general format is

          document-charset  accept-charset[,accept-charset..]  [NCS-function-name]

    When this directive is configured the server compares each text response's character set (if any) to each of the directive's document charset string. If it matches it then compares each of the accepted charset (if multiple) to the request "Accept-Charset:" list of accepted characters sets. If the same is is either accepted as-is or if a conversion function specified converted by NCS as the document is transfered.

          windows-1251 windows-1251,cp-1251
          windows-1251 koi8-r koi8r_to_windows1251_to_koi8r
          koi8-r koi8-r,koi8
          koi8-r windows-1251,cp-1251 koi8r_to_windows1251

36. [CharsetDefault] string (default: none)

    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.

37. [CgiStrictOutput] `ENABLED|DISABLED` (default: DISABLED)

    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.

38. [DclBitBucketTimeout] hh:mm:ss (default: 0)

    Period a script is allowed to continue processing before being terminated after a client prematurely disconnects. An approptiate setting allows most scripts to conclude elegantly and be available for further use. This improves scripting efficiency significantly. Setting this period to zero terminates scripts (and their associated processes) immediately a client is detected as having disconnected.

39. [DclCleanupScratchMinutesMax] integer (default: 0)

    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.

40. [DclCleanupScratchMinutesOld] integer (default: 0)

    When performing a [DclCleanupScratchMinutesMax] scan delete files that are older than this value (or the value specified by [DclCleanupScratchMinutesMax], whichever is the larger).

41. [DclCgiPlusLifeTime] hh:mm:ss (default: 0)

    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 period after it last processed a request. This helps prevent sporadically used scripts from clogging up a system.

42. [DclDetachProcess] `ENABLED|DISABLED` (default: DISABLED)

    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 (5.5 - HTTPd Command Line, User Account Scripting and in particular "Scripting Overview, Introduction".

43. [DclDetachProcessPriority] integer[,integer] (default: same as server)

    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.

44. [DclGatewayBG] `ENABLED|DISABLED` (default: DISABLED)

    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.

45. [DclHardLimit] integer (default: 0)

    The maximum number of DCL/CGI script processing subprocesses that may ever exist concurrently (works in conjunction with [DclSoftLimit].

46. [DclScriptRunTime] string (default: none)

    One or more file type (extension) specification and scripting verb pairs. See "Scripting Overview, Runtime".

47. [DclSoftLimit] integer (default: 0)

    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".

48. [DclSpawnAuthPriv] `ENABLED|DISABLED` (default: DISABLED)

    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.

49. [DclZombieLifeTime] hh:mm:ss (default: 00:00:00)

    If this value is zero the use of persistant DCL subprocesses is disabled. If non-zero the zombie subprocess is terminated the specified period after it last processed a request. This helps prevent zombie processes from clogging up a system. See "Scripting Environment" document.

50. [DECnetReuseLifeTime] hh:mm:ss (default: 00:00:00)

    Period a DECnet scripting connection is maintained with the network task. Zero disables connection reuse.

51. [DECnetConnectListMax] integer (default: 0)

    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.

52. [DirAccess] `ENABLED|DISABLED|SELECTIVE` (default: DISABLED)

    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.

53. [DirBodyTag] string (default: <BODY>)

    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.

54. [DirDescriptionLines] integer (default: 0)

    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).

55. [DirLayout] string (default: I__L__R__S__D)

    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).

      C - creation date
      D - description (generally best specified last)

        D:L - for files, make a link out of the description text
      I - icon (takes no field-width attribute)

        L - link (highlighted anchor using the name of the file)
        L:F - file-system name (for ODS-5 displays spaces, etc.)
        L:N - name-only, do not display the extension
        L:U - force name to upper-case
      N - name (no link, why bother? who knows!)
      O - owner (can be disabled)
      R - revision date
      S - size

        S:B - in bytes (comma-formatted)
        S:D - decimal kilos (see below)
        S:F - kilo and mega are displayed to one decimal place
        S:K - in kilo-bytes (and fractions thereof)
        S:M - in mega-bytes (and fractions thereof)
      U - upper-case file and directory names (must be the first character)

    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.

56. [DirMetaInfo] `ENABLED|DISABLED` (default: DISABLED)

    Includes, as <META> information, the software ID of the server and any relevant VMS file information.

57. [DirNoImpliedWildcard] `ENABLED|DISABLED` (default: DISABLED)

    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.

58. [DirNoPrivIgnore] `ENABLED|DISABLED` (default: DISABLED)

    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.

59. [DirOwner] `ENABLED|DISABLED` (default: DISABLED)

    Allows specification and display of the RMS file owner information.

60. [DirPreExpired] `ENABLED|DISABLED` (default: DISABLED)

    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

61. [DirReadme] `TOP|BOTTOM | OFF` (default: DISABLED)

    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.

62. [DirReadMeFile] `file.suffix` (no default)

    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

63. [DirWildcard] `OFF|ON` (default: DISABLED)

    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.

64. [DNSLookupClient] `ENABLED|DISABLED` (default: DISABLED)

    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 literal internet address. If not enabled any [Accept], [Reject] or conditional directive, etc., must be expressed as a literal address.

65. [DNSLookupLifetime] hh:mm:ss default 00:10:00

    The period for which a host name/address is cached (applies to both client lookup and proxy host lookup).

66. [DNSLookupRetry] integer (default: 2)

    The number of attempts, at two second intervals, made to resolve a host name/address (applies to both client lookup and proxy host lookup).

67. [ErrorReportPath] string [status...] (default: none)

    Specifies the URL-format path to an optional, error reporting SSI document or script. See 6.9 - Error Reporting. This path can subsequently be remapped during request processing. Optional, space-separated HTTP status codes restrict the path to those codes, with the remainder handled by server-internal reporting.

68. [ErrorRecommend] `ENABLED|DISABLED` (default: DISABLED)

    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)

69. [InstanceMax] integer|`CPU` (default: 1)

    Number of per-node server processes to create and maintain. If set to "CPU" once instance per CPU is created.

70. [Logging] `ENABLED|DISABLED` (default: DISABLED)

    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 (Logical Names.

71. [LogExcludeHosts] string (default: none)

    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 literal 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.*

72. [LogExtend] integer (default: 0)

    Number of blocks allocated when when a log file is opened or extended. If set to zero it uses the process default (SET RMS_DEFAULT /EXTEND_QUANTITY).

73. [LogFile] string (default: none)

    Provides some or all of the access log file name. See 6.11.2 - Log Per-Period.

74. [LogFormat] string (default: COMMON)

    Specifies one of three pre-defined formats, or a user-definable format. See 6.11.1 - Log Format.

75. [LogGlobal] integer (default: 0)

    Number of global buffers to use when multiple instances are configured. This directive improves performance (by delaying write-to-disk) of multi-instance configurations by using RMS global buffering for shared write access to log files. As each log file has a multiblock count of 127 this is probably best specified as 1 or some other small number. It consumes global sections and global pages from system-wide resources.

76. [LogNaming] string (default: none)

    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.11.5 - Log Naming.

77. [LogPeriod] string (default: none)

    Specifies a period at which the log file is changed. See 6.11.2 - Log Per-Period.

78. [LogPerInstance] `ENABLED|DISABLED` (default: DISABLED)

    When multiple instances are configured (6.2 - Server Instances) create a separate log for each. This has significant performance advantages. See 6.11.4 - Log Per-Instance.

79. [LogPerService] `ENABLED|DISABLED` (default: DISABLED)

    When multiple services are specified (6.3 - Virtual Services) a separate log file will be created for each if this is enabled. See 6.11.3 - Log Per-Service.

80. [LogPerServiceHostOnly] `ENABLED|DISABLED` (default: DISABLED)

    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.11.3 - Log Per-Service.

81. [Monitor] `ENABLED|DISABLED` (default: DISABLED)

    Allows monitoring via the HTTPDMON utility (23.8 - HTTPd Monitor. Adds slight request processing overhead.

82. [OpcomAdmin] `ENABLED|DISABLED` (default: DISABLED)

    Report to operator log and any enabled operator console (see [OpcomTarget]) server administration directives originating from the Server Administration Menu, for example path map reload, server restart, etc.

83. [OpcomAuthorization] `ENABLED|DISABLED` (default: DISABLED)

    Report events related to authentication/authorization. For example username-password validation failures.

84. [OpcomControl] `ENABLED|DISABLED` (default: DISABLED)

    Report HTTPD/DO=directive control events, both the command-line directive and the server's response.

85. [OpcomHTTPd] `ENABLED|DISABLED` (default: DISABLED)

    Report events concerning the server itself. For example, server startup and exit (either normally or with error status).

86. [OpcomProxyMaint] `ENABLED|DISABLED` (default: DISABLED)

    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.

87. [OpcomTarget] string (default: DISABLED)

    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.

88. [Port] integer (default: 80)

    IP port number for server to bind to. For anything other than a command-line server control (5.5.2 - Server Command Line Control) this parameter is overridden by anything supplied via the [Service] directive.

89. [ProxyCache] `ENABLED|DISABLED` (default: DISABLED)

    Enables or disables proxy caching on a whole-of-server basis, irrespective of any proxy services that might be configured for caching.

90. [ProxyCacheFileKBytesMax] integer (default: 256)

    Maximum size of a cache file in kilobytes before it will not be cached.

91. [ProxyCacheRoutineHourOfDay] integer (default: 0)

    Hour of day for routine cache purge (00-23).

92. [ProxyCacheDeviceCheckMinutes] integer (default: 15)

    Interval in minutes between checking space availablility on cache device. If space is not available a reactive purge is initiated.

93. [ProxyCacheDeviceDirOrg] `FLAT256|64X64` (default: FLAT256)

    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 files per directory issue.

94. [ProxyCacheDeviceMaxPercent] integer (default: 85)

    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.

95. [ProxyCacheDevicePurgePercent] integer (default: 1)

    The percentage by which the cache device usage is attempted to be reduced when a reactive purge is initiated.

96. [ProxyCacheNoReloadSeconds] integer (default: 0)

    Prevents pragma reloads actually retrieving the file from the source host again until the period expires. This is designed to limit concurrent or repeated reloads of files into the cache unecessarily. Thirty seconds is probably an adequate period balancing effect against a user legitimately needing to recache the document.

97. [ProxyCachePurgeList] string (default: 168,48,24,8,0)

    A list of comma-separated integers representing the sequence of last accessed period in hours used during a progressive reactive purge.

98. [ProxyCacheReloadList] string (default: 1,2,4,8,12,24,48,96,168)

    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.

99. [ProxyForwarded] `BY|DISABLED|FOR|ADDRESS` (default: DISABLED)

    BY enables 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://server.name.domain (HTTPd-WASD/n.n.n OpenVMS/AXP Digital-TCPIP SSL)". If the FOR variant is used the field included the host name (or ADDRESS) the request is being forwarded on behalf of, as in "Forwarded: by http://server.name.domain (HTTPd-WASD/n.n.n OpenVMS/AXP Digital-TCPIP SSL) for host.name.domain".

100. [ProxyHostLookupRetryCount] integer (default: 0)

     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.

101. [ProxyReportLog] `ENABLED|DISABLED` (default: DISABLED)

     Enables or disables the server process log reporting siginificant proxy processing events, such as cache maintenance activity.

102. [ProxyReportCacheLog] `ENABLED|DISABLED` (default: DISABLED)

     Enables or disables the server process log reporting of proxy caching activity.

103. [ProxyServing] `ENABLED|DISABLED` (default: DISABLED)

     Enables or disables proxy serving on a whole-of-server basis, irrespective of any proxy services that might be configured.

104. [ProxyXForwardedFor] `ADDRESS|DISABLED|ENABLED|UNKNOWN` (default: DISABLED)

     Enables the addition of a proxy request header line providing the host name on behalf of which the request is being proxied. The added header line would look like "X-Forwarded-For: host.name.domain". THE ADDRESS variant provides the IP address, and the UNKNOWN variant substitutes "unknown" for the host. This field is degined to be compatible with the Squid de facto standard field of the same name. Any request with an existing "X-Forwarded-For:" field has the local information appended to the existing as a comm-separated list. The first host in the field should be the original requesting client.

105. [PutMaxKBytes] integer (default: 250)

     Maximum size of an HTTP POST or PUT method request in Kilobytes.

106. [PutVersionLimit] integer (default: 3)

     File created using the POST or PUT methods have the specified version limit applied.

107. [RegEx] `ENABLED|DISABLED` (default: DISABLED)

     Enable regular expression matching. With the possibility of the reserved character "^" being used in existing mapping rules regular expression string matching (11 - String Matching) is only available after enabling this directive.

108. [Reject] host/domain name (default: none)

     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 literal 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.*

109. [ReportBasicOnly] `ENABLED|DISABLED` (default: DISABLED)

     Only ever supply basic information in a report (6.9 - Error Reporting).

110. [ReportMetaInfo] `ENABLED|DISABLED` (default: DISABLED)

     Includes in detailed reports, as <META> information, the software ID of the server and any relevant VMS file information.

111. [RequestHistory] integer (default: 0)

     The server can keep a list of the most recent requests accessable from the Server Administration page. 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.

112. [Scripting] `ENABLED|DISABLED` (default: ENABLED)

     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.

113. [SearchScript] path (no default)

     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

114. [SearchScriptExclude] list (no default)

     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

115. [ServerAdmin] string (no default)

     Specifies the contact email address for server administration issues. Included as a "mailto:" link in the server signature if [ServerSignature] is set to email.

116. [ServerAdminBodyTag] string (default: <BODY>)

     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.

117. [ServerReportBodyTag] string (default: <BODY>)

     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.

118. [ServerSignature] `ENABLED|EMAIL|DISABLED` (default: DISABLED)

     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.

119. [Service] string (no default)

     This parameter allows SSL, multi-homed hosts and multiple port serving to be specified, see 17.3 - SSL Configuration and 6.3 - Virtual Services.

120. [ServiceNotFoundURL] string (no default)

     Provides a default path for reporting a virtual host does not exist, see Unknown Virtual Server.

121. [SSI] `ENABLED|DISABLED` (default: DISABLED)

     Enables or disables Server Side Includes (HTML pre-processing).

122. [SSIaccesses] `ENABLED|DISABLED` (default: DISABLED)

     Enables or disables Server Side Includes (HTML pre-processing) file access counter.

123. [SSIexec] `ENABLED|DISABLED` (default: DISABLED)

     Enables or disables Server Side Includes (HTML pre-processing) DCL execution functionality.

124. [SSIsizeMax] integer (default: 0 (128kB))

     SSI source files a completely read into memory before processing. This allows the maximum size to be expanded beyond the default.

125. [StreamLF] integer (default: 0 (disabled))

     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.

126. [StreamLFpaths] string (no default)

     (Retired in v5.3, mapping SET rule provides this now, see 13.4.5 - SET Rule).

127. [TimeoutInput] hh:mm:ss (default: 00:01:00)

     Period allowing a connection request to be in progress without submitting a complete request header before terminating it.

128. [TimeoutKeepAlive] hh:mm:ss (default: 00:00:05)

     Period allowing 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.

129. [TimeoutNoProgress] hh:mm:ss (default: 00:02:00)

     Period allowing 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.

130. [TimeoutOutput] hh:mm:ss (default: 00:10:00)

     Period allowing a request to be output before terminating it. This directive sets an absolute maximum time a request can continue to receive output.

131. [Track] `ENABLED|DISABLED` (default: DISABLED)

     Enables session (user) tracking.

132. [TrackMultiSession] `ENABLED|DISABLED` (default: DISABLED)

     By default the tracking cookie is discarded by the browser when it is closed. This setting directs the browser to keep it between sessions.

133. [TrackDomain] file.suffix (no default)

     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).

134. [Welcome] file.suffix (no default)

     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.

           [Welcome]
           index.html
           index.htm
           home.html
           home.htm

     Dynamic home pages (script or interpreter engine driven, e.g. Perl, PHP) may be deployed using a combination of the [Welcome] and [DclScriptRunTime] directives.

           [Welcome]
           index.html
           index.htm
           index.php
           index.pl

           [DclScriptRunTime]
           .PHP $CGI-BIN:[000000]PHPWASD.EXE
           .PL $CGI-BIN:[000000]PERLRTE

[next] [previous] [contents] [full-page]