Appendix B. Configuration File Format

Abyss Web Server configuration file is usually located in the same directory as the Abyss Web Server executable. This location can be changed by adding the -c switch in the command line (See the "Command line parameters" appendix.)

The configuration file is a text file. Lines which begin with the # character are ignored and considered as comments. Each line contains only a unique option and one or more parameters. Option names are not case sensitive. For example, ServerRoot is the same as SERVERROOT and seRverROoT. Boolean parameters can be either Yes or No.

Available options are described below:

Version <Abyss Web Server version>

The version of the software that generated the configuration file. Appeared in version 1.0.3.

ServerRoot <real path>

The Root path for the web server. It is the base path for all relative real paths. It must occur before any other option that have a relative path as a parameter.

Path <real path>

The path of the directory that contains the hosted web site.

Port <integer>

The number of the port on which the web server listens to incoming connections. It must be between 1 and 65534.

KeepAlive <integer>

The number of requests allowed to be served over the same connection when communicating with HTTP/1.1 and some HTTP/1.0 clients.

TimeOut <integer>

How long (in seconds) the server waits for an inactive connection before closing it.

AdvertiseServer <boolean>

Include the server software identity in each response.

MaxConnections <integer>

The maximum number of requests served simultaneously.

LogFile <real file>

The file where the server logs accesses.

ExtendedLog <boolean>

Add the referrer and the user agent to each log line.

SysUser <string> or SysUser #<integer>

The name or the numerical ID of the operating system user under whom privileges the server runs if launched as root.

PIDFile <real file>

The file where the server's process ID is written at each startup.

AutoIndex <boolean>

Enable automatic generation of a directory listing if no index file is found.

IndexFile <string>

Add an index filename. This option can occur more than once.

MIMEFile <real file>

Name of an external MIME types file. Each of its lines must contain a MIME type and one or more of its associated extensions separated by spaces.

MIMEType <string>/<string> <extension> [ <extension> …]

Associate the extension(s) with the MIME type. This option can occur more than once.

Alias <virtual path> <real path>

Map the virtual path to the real one. This option can occur more than once.

CGIEnabled <boolean>

Enable CGI scripts execution.

CGITimeOut <integer>

How long (in seconds) the server waits for a CGI script to deliver content before aborting it. Appeared in version 1.0.3.

CGIErrorFile <real file>

The file where the CGI scripts write error messages.

CGIInterpreter <real file> <extension> [ <extension> …]

Declare an interpreter that runs CGI scripts which extensions are in the list of extensions given as parameters. This option can occur more than once.

CGIPath <virtual path>

Allow CGI scripts execution if they belong to the given virtual path or its subpaths. This option can occur more than once.

CGIEnv <string>=<string>

Add a user variable to the CGI scripts' environment. This option can occur more than once.

ConsolePort <integer>

The number of the port on which the console listens to incoming connections.

Login <string>

The console access login.

Password <string>

The encrypted console access password. Encryption of the password appeared in version 1.0.3.

SSIEnabled <boolean>

Enable SSI processing. Appeared in version 1.0.7.

SSIExtension <extension>

Enable SSI processing for files with the given extension. Appeared in version 1.0.7.

SSISizeAbbrev <boolean>

Define the default way to display file sizes in SSI. If set to true, it is in Kb or Mb. Otherwise, it is in bytes. Appeared in version 1.0.7.

SSITimeFmt <string>

Define the default displaying format of dates in SSI. Appeared in version 1.0.7.

SSIErrMsg <string>

Define the default error message displayed when an SSI error occurs. Appeared in version 1.0.7.

CustomError <status-code> <url>

Define a custom error page. Appeared in version 1.0.7.

CustomErrorDefault <url>

Define the default custom error page. Appeared in version 1.0.7.

User <user name> <encrypted password>

Declares a user. Appeared in version X1.

Group <group name> [ <member> …]

Declares a group. Members are users or groups already declared. Appeared in version X1.

AccessControl <virtual path> <realm string> +|- [ <user/group> …] +|- [ <user/group> …]

Adds a path access rule. Users and groups preceded by + are those for whom access is allowed. The allow/deny order is deduced from the + and - order. Appeared in version X1.


Copyright © 2001-2003 by Aprelium Technologies