vhttpd Log and Path Settings

These vhttpd.conf config file settings affect files used by the vhttpd server, such as where transactions are logged.

• ServerRoot filepath File path to the root of the server tree. DocumentRoot, the logs files, etc. are in subdirectories of this by default. Environment variables may be referenced in the path with $, and home directories with ~ (tilde). ServerRoot may be set to %INSTALLDIR% (the default) for the Texis installation directory.. The server config file is by default conf/vhttpd.conf in this directory.

• DocumentRoot filepath File path to the root of the document tree. Web requests for documents will be served from here. For example, the URL http://www.mysite.com/info/details.txt would be served from the file info/details.txt in the DocumentRoot directory. ServerRoot-relative. The default is htdocs.

• ScriptRoot filepath   File path to root directory of Vortex script tree. Overrides conf/texis.ini value (see here), which overrides default of texis/scripts in the install dir. ServerRoot-relative. This allows Vortex scripts to be stored in a location other than the server's document tree, e.g. for security or permission reasons. Added in version 4.00.1017300000 20020327.

  In version 5 and later, ScriptRoot can also be set to the special value "%DOCUMENT_ROOT%" (no prefixes/suffixes) to use the current document root as the script root. This may be for back compatibility with a version 4 installation.

• LogDir dir Directory for log and pid files; ServerRoot-relative. TransferLog, ErrorLog, VortexLog and PidFile are placed in here by default. If these are files with no dirs (the default), then a parallel web server can be set up with identical configuration, but logging elsewhere, by just giving a new -logdir on the command line. This eases setting up a quick test server - without mucking up the live server's logs, or having to write a new vhttpd.conf file.

  Note that log file locations can be overridden per-transaction in directly-run Vortex scripts, via <vxcp> (here), if the AllowLogFileOverride setting is true (the default); see here.

• TransferLog filepath File path to transfer log. Each web hit will be logged to this file, which is in Common Log Format (CLF). Depending on LogOptions settings, the User-Agent and Referer may be logged with each entry as well. If TransferLog is a file (no dir in its value), it is placed in LogDir. If a dir is given in the TransferLog path, it is then ServerRoot-relative. The default is transfer.log.

  Note that log file locations can be overridden per-transaction in directly-run Vortex scripts, via <vxcp> (here), if the AllowLogFileOverride setting is true (the default); see here.

• LogOptions option [option ...] Logging options. The option can be one or more of:

  • Referer to log Referer in the transfer log.

  • UserAgent to log User-Agent in the transfer log.

  • Combined to log both User-Agent and Referer in the transfer log.
  The following options log resource usage statistics about the process that served the transaction, obtained from a getrusage() call, in the order given to LogOptions:

  • utime User time

  • stime System time

  • rtime Real time

  • maxrss Maximum resident set size

  • ixrss Integral shared memory size

  • idrss Integral unshared data size

  • isrss Integral unshared stack size

  • minflt Page reclaims

  • majflt Page faults

  • nswap Swaps

  • inblock Block input operations

  • oublock Block output operations

  • msgsnd Messages sent

  • msgrcv Messages received

  • nsignals Signals received

  • nvcsw Voluntary context switches

  • nivcsw Involuntary context switches
  Additionally, Label or NoLabel can be given to label (or not) the above statistics. Not all statistics are supported on all platforms. Added in version 3.0.949200000 20000129.

• ErrorLog filepath File path to server error log. Server errors are logged here; these are distinct from Vortex errors which are logged to the VortexLog. If ErrorLog is a file (no dir in its value), it is placed in LogDir. If a dir is given in the ErrorLog path, it is then ServerRoot-relative. The default is error.log.

  Note that log file locations can be overridden per-transaction in directly-run Vortex scripts, via <vxcp> (here), if the AllowLogFileOverride setting is true (the default); see here.

• VortexLog filepath   File path to Vortex log. Vortex errors from server-run (via VortexPath) scripts are logged here. Overrides conf/texis.ini value, if any (here. Note that general non-Vortex server errors are logged to the ErrorLog instead. (This config setting also does not affect where Vortex errors are logged for CGI-run Vortex scripts, which are run by the Vortex executable texis. That is only controlled by the conf/texis.ini setting.)

  If VortexLog is a file (no dir in its value), it is placed in LogDir. If a dir is given in the VortexLog path, it is then ServerRoot-relative. The default is vortex.log.

  Note that log file locations can be overridden per-transaction in directly-run Vortex scripts, via <vxcp> (here), if the AllowLogFileOverride setting is true (the default); see here.

• PidFile filepath File where the process ID of the web server is written at startup. This can be killed by a server-shutdown script. If PidFile is a file (no dir in its value), it is placed in LogDir. If a dir is given in the PidFile path, it is then ServerRoot-relative. The default is vhttpd.pid.

• TypesConfig filepath   File containing extension to MIME Content-Type mappings. This is a text file, commentable like the config file, with each line of the form:

    mime/type  ext [ext ...]

  where mime/type is a MIME Content-Type and ext is one or more filename extensions (no dot) to associate with the MIME type. This list is used to assign Content-Types for file downloads, based on the outermost file extension. It also sets the Content-Types for built-in VortexPath scripts, overriding the default list. The AddType config setting can also modify the MIME type list. TypesConfig is ServerRoot-relative; the default is conf/mime.types. If the file is missing, a default list is used, based on the default list for AllowExt. Extensions are case-insensitive. Added in version 3.0.949000000 20000127.

• EncodingsConfig filepath   File containing extension to MIME Content-Encoding mappings. This is a text file, commentable like the config file, with each line of the form:

    mime/encoding  ext [ext ...]

  where mime/encoding is a MIME Content-Encoding and ext is one or more filename extensions (no dot) to associate with the encoding. This list is used to assign one or more Content-Encodings for each file download, based on non-outermost file extensions. The AddEncoding config setting can also modify this list. EncodingsConfig is ServerRoot-relative; the default is conf/mime.encodings. If the file is missing, a default list for the extensions gz, uu, and Z is used. Extensions are case-insensitive. Added in version 3.0.949000000 20000127.