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
Default: %INSTALLDIR%
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
Default: htdocs
File path to the root of the document tree. Web requests for documents will be served from here. For example, the URL http://www.example.com/info/details.txt would be served from the file info/details.txt in the DocumentRoot directory. ServerRoot-relative.

ScriptRoot filepath
Default: [Texis] Script Root value or texis/scripts
File path to root directory of Vortex script tree. Overrides 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
Default: [Texis] Log Dir value from conf/texis.ini or /var/log/texis in version 8 and later; logs in version 7 and earlier
Directory for log files; ServerRoot-relative. Also sets %LOGDIR%. TransferLog, ErrorLog, VortexLog 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.

RunDir dir
Default: [Texis] Run Dir value from conf/texis.ini or /run/texis
Directory for run-time files, e.g. PID files. ServerRoot-relative. Added in version 8.

TransferLog filepath
Default: transfer.log
File path to transfer log. Each web hit will be logged to this file, which is in Common Log Format (CLF) unless modified by LogFormat. Depending on LogFormat and/or 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.

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 ...]
Default: Combined
Logging options. Each option can be one 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.

  • pid to log the server subprocess PID.

  • A getrusage() value: utime, stime, rtime, maxrss, ixrss, idrss, isrss, minflt, nswap, inblock, oublock, msgsnd, msgrcv, nsignals, nvcsw, nivcsw; printed in order

  • Label Label the getrusage() values

  • NoLocal Do not label the getrusage() values (default)
Note that LogFormat, if specified, overrides LogOptions.

LogFormat format
Default: Common Log Format, modified by LogOption
Specifies the format of transfer log entries. The format is the same printf()-like syntax used by Apache 2.4 in its LogFormat directive, with some codes added and some Apache codes unimplemented. See the Texis Monitor web server setting [Httpd] Log Format for details. Added in version 7.01.1384230000 20131111.

ErrorLog filepath
Default: error.log
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.

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
Default: vortex.log
File path to Vortex log. Vortex errors from server-run (via VortexPath) scripts are logged here. Overrides 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, e.g. under Apache or the Monitor Web Server. That is only controlled by the texis.ini setting.)

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

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

PidFile filepath
Default: vhttpd.pid
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 RunDir (version 8 and later) or LogDir (version 7 and earlier).

If PidFile path contains a relative dir, it is then ServerRoot-relative.

TypesConfig filepath
Default: conf/mime.types
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. 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
Default: conf/mime.encodings
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. 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.


Copyright © Thunderstone Software     Last updated: Jul 17 2021
Copyright © 2021 Thunderstone Software LLC. All rights reserved.