These vhttpd.conf config file settings modify how the vhttpd web server responds to various URLs.
Add the given extension(s) to the list of allowed file
extensions. Only files with these extensions are accessible to
users. The first
AllowExt setting sets the list;
later settings append to previous setting(s). By default, Vortex scripts
(no extension) and object files (.vsc extension) may not be
downloaded by users, in version 2.6.928300000 19990602 and later,
AllowExt was added. A value of * (asterisk) will
allow any extension. An empty string ("") will allow files
with no extension, such as Vortex script source files.
AllowExt, but does not clear default list when used for the first time, i.e. always adds to existing list. Added in version 5.01.1205376000 20080312.
AllowExtallow list. Added in version 5.01.1205376000 20080312. In version 6.00.1276567000 20100614 and later, ExcludeExt none will clear the list.
ExcludeExt. Added in version 5.01.1205376000 20080312.
DocumentRootwith at least one of these permission bits set. Note that files must still be accessible by User. See
AllowDirMaskfor directories. Added in version 5.01.1147373000 20060511.
<vxcp>(here). Can be set false to debug complex
<vxcp>log file redirection issues. Added in version 5.01.1170123063 20070129.
AllAll options except for
MultiViews. Added in version 5.01.1251269000 20090826.
IndexesGemerate an automatic directory listing if no
DirectoryIndexfile exists for a directory.
IndexesRobotsIndexAllow robots to index automatic directory listings, via <meta name="robots"> tag.
IndexesRobotsFollowAllow robots to follow links from automatic directory listings, via <meta name="robots"> tag.
LabelArgsLabel processes' args with remote IP address of client. This can help in determining which server sub-process is serving which client.
MultiViewsAllow content-negotiated variant files to be served. With this option enabled, if a requested file is not found as named, files with the same name but additional recognized file extensions (for MIME types and/or encodings) will be searched for. The files will be ranked according to the client's Accept-... header preferences, and the highest-ranked file will be served. Applies to implicit
DirectoryIndexfiles too. For example, a request for "/dir/file" might return "/dir/file.html", "/dir/file.txt.gz" etc. If variant(s) are found but are not deemed acceptable according to the client's Accept-... headers, a 406 Not Acceptable response may result. Disabled by default. Added in version 5.01.1251269000 20090826. Currently, only the Accept-Encoding client header is respected.
extto the MIME Content-Type
mime/typefor file downloads and
VortexPathscripts. Overrides/adds to mapping list from
TypesConfigfile (here). Added in version 3.0.949000000 20000127.
extto the MIME Content-Encoding
mime/encodingfor file downloads. Overrides/adds to mapping list from
EncodingsConfigfile (here). Added in version 3.0.949000000 20000127.
urlpathas a server-run Vortex URL. Any URL request in this tree will be treated as a Vortex script and run by the server as such. For example, if VortexPath /texis is set, then a request for the URL http://www.example.com/texis/mydir/search will run the Vortex script mydir/search in the
ScriptRootdirectory. (Each matching path component must match fully however; e.g. the URL http://www.example.com/texisation/mydir/search would not run a script, given the same
To replace an existing Apache web server's CGI-run Vortex with
Texis Web Server-run Vortex, replace a config file entry such as this:
ScriptAlias /cgi-bin /usr2/pub/httpd/cgi-bin
with an entry like this:
script argument (
was added in version 2.6.930850000 19990701. If it is given,
then the script is
script plus the remainder of the URL
urlpath). For example, if
VortexPath /texis/special /usr/local/specialscript/main.html/+
is set, then http://www.example.com/texis/special/extra will
map to the script /usr/local/specialscript, function
main, with $userpath of "/extra".
VortexPath may be given multiple times to map different URL
paths. Depending on the current license, the word texis
may be required in the URL path, to identify the URL as Vortex.
Note that giving a
script argument can result in
non-standard behavior of $url and other variables, since
part of the script path is not in the URL.
ServerRoot-relative. In version 2.6.929600000 19990617 and later, if this script returns a non-zero exit code via
<exit>, the actual request URL is not served and the transaction is abandoned. See also the
ENTRYFUNCdirective (here) which is often more useful.
ServerRoot-relative. See also the
EXITFUNCdirective (here) which is often more useful.
ServerRoot-relative. This script can process errors for nonexistent scripts, compile problems, etc. Overrides texis.ini setting (see here). It is generally preferable to set this in texis.ini rather than vhttpd.conf so that it will take effect for CGI Vortex scripts as well. However, it can be set in vhttpd.conf if a different value is desired for different servers. Added in version 4.00.1018000000 20020405.
ErrorScriptfor certain server errors, such as 404 Not Found; normally it is invoked only for Vortex errors. If enabled, the function status$NNN$.html in
ErrorScriptis called, where $NNN$ is the HTTP response code. The following variables are also set:
STATUS_CODEThe HTTP response code, e.g. 404
STATUS_REASONThe HTTP status line reason, e.g. Not Found
STATUS_MSGA verbose text error message
ErrorScript can use these variables to distinguish
Vortex script errors (where the variables are not set) from web
server errors (where they are set), as well as issue the proper
HTTP response. See the default
ErrorScript for example
usage. Added in version 5.01.1206660000 20080327.
ErrorScriptis to be invoked but cannot be started.
ServerRoot-relative. This is a plain file "fallback" for
ErrorScriptfailure. Overrides texis.ini setting (see here). It is generally preferable to set this in texis.ini rather than vhttpd.conf so that it will take effect for CGI Vortex scripts as well. However, it can be set in vhttpd.conf if a different value is desired for different servers. Added in version 4.00.1018000000 20020405.
ServerRoot-relative. Setting this script enables the web server to be a proxy server. This script is then responsible for fetching and serving all such proxy requests (whether Vortex scripts or file requests). Added in version 4.00.994800000 20010710.
urlpathto CGI directory or program
filepath. A web request in the
urlpathURL tree will cause the CGI program
filepathto be run, if it is an executable file. If
filepathis a directory, the CGI program in it is named by the next component in the URL. The
ScriptAliasmay be used multiple times. In version 2.6.930850000 19990701 and earlier, the
filepathcould only be a directory.
For example, given ScriptAlias /cgi-bin cgidir and the directory cgidir in ServerRoot, a URL such as http://www.example.com/cgi-bin/prog will execute the CGI program cgidir/prog.