Total Network Tools 2002

home *** CD-ROM | disk | FTP | other *** search

/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Web Server / Apache Configuration Editor.EXE / setup.txt < prev next >

Wrap

Text File | 1998-11-24 | 291.9 KB | 9,901 lines

// // Basic Setup info: // Program Name // Program Executable // Where the install path is saved in the registry // The key name for the above // Default install path // Check the Add to Startup Group option // Check the Uninstall option // Check the Launch it option // Check the Add Program Group option // Name to use on the program's icon // Dialog title string for installation // Dialog title string for uninstallation // Completed installation message // Completed uninstallatino message // Required free space for installation, in KB // // Note: These entries cannot have any spaces or comments between them/ // DSTSetup:SetupInfo Apache Configuration Editor ApacehConfig.exe HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Config ProgramPath C:\Program Files\DST-ACE 0 1 0 1 Apache Configuration Editor Setup DST-ACE... Uninstall DST-ACE... Congratulations, setup is now complete, please enjoy Apache Configuration Editor... This phase of uninstall is now finished, to completely uninstall you will need to restart your computer. This will remove all remaining files from your system, however it is not necessary to restart immediately. 1000 // // Add this program to the start menu, only one item can follow this entry // // executable name (install path perpended to it) // command line args ( can use %InstallDir% ) // description // DSTSetup:StartMenu ApacheConfig.exe Apache Configuration Editor // // Add a program to the program group that the user specifies. // // executable name (install path perpended to it) // command line args ( can use %InstallDir% ) // description // DSTSetup:AddProgram apacheconfig.exe Apache Configuration Editor DSTSetup:AddProgram HelpFile\index.html Apache Configuration Editor Manual DSTSetup:AddProgram setup.exe %InstallDir%\setup.txt Uninstall Apache Configuration Editor // // Add keys to the registry // DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\Config HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\QuickConfig HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\Templates HKEY_CURRENT_USER\Software\DarkStar\ApacheConfig HKEY_CURRENT_USER\Software\DarkStar\ApacheConfig\Config // // Add values to the registry // Where to put it. // Value name // Type of value: REG_SZ or REG_DWORD // Setting for the value // // Note: the Value location must exist prior to setting the value. // Note: you can use %InstallDir% inside the setting to insert the installation // directory as specified by the user (including trailing \) // // Start populating HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\Config DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\Config ConfirmDelete REG_DWORD 1 HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\Config DefaultConfigFilePath REG_SZ %InstallDir%Default HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\Config DefaultConfigPath REG_SZ %InstallDir%Config HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\Config HelpPath REG_SZ %InstallDir%HelpFile // Start populating HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\QuickConfig DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\QuickConfig DocumentRoot REG_SZ /Apache/htdocs HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\QuickConfig Group REG_SZ #-1 HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\QuickConfig Port REG_SZ 80 HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\QuickConfig ServerAdmin REG_SZ you@your.domain HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\QuickConfig ServerRoot REG_SZ /Apache HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\QuickConfig ServerType REG_SZ Windows HKEY_LOCAL_MACHINE\Software\DarkStar\ApacheConfig\QuickConfig User REG_SZ nobody // Start populating HKEY_CURRENT_USER\Software\DarkStar\ApacheConfig\Config DSTSetup:RegistryValue HKEY_CURRENT_USER\Software\DarkStar\ApacheConfig\Config ConfirmDelete REG_DWORD 1 HKEY_CURRENT_USER\Software\DarkStar\ApacheConfig\Config DefaultConfigPath REG_SZ %InstallDir%Config HKEY_CURRENT_USER\Software\DarkStar\ApacheConfig\Config SaveConfigPath REG_DWORD 1 HKEY_CURRENT_USER\Software\DarkStar\ApacheConfig\Config SaveOnExit REG_DWORD 1 HKEY_CURRENT_USER\Software\DarkStar\ApacheConfig\Config SaveWindowPos REG_DWORD 1 HKEY_CURRENT_USER\Software\DarkStar\ApacheConfig\Config ToolBarDesc REG_DWORD 0 HKEY_CURRENT_USER\Software\DarkStar\ApacheConfig\Config WindowDivider REG_DWORD 200 // // Create a directory under the install directory. // Multiple lines can be used to specify multiple dirs. // DSTSetup:AddDirectory Config Default HelpFile // // Copy a file from the temp directory to the installation directory. // Path to copy to // File to copy // Multiple lines can be used to specify multiple dirs. // DSTSetup:CopyFile .\ ApacheConfig.exe .\ setup.exe .\ readme.txt .\ ureadme.txt .\ legal.txt Default access.conf-dist Default access.conf-dist-win Default httpd.conf-dist Default httpd.conf-dist-win Default srm.conf-dist Default srm.conf-dist-win HelpFile ApacheConfigHelp.chm // // Build the templates registry structure // DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\access.conf DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\access.conf Description REG_SZ This file defines server settings which affect which types of services are allowed, and in what circumstances. Each directory to which Apache has access, can be configured with respect to which services and features are allowed and/or disabled in that directory (and its subdirectories).). DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\access.conf Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\access.conf Parent REG_DWORD 2 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AccessConfig DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AccessConfig Description Syntax: AccessConfig filename Default: AccessConfig conf/access.conf Context: server config, virtual host Status: core The server will read this file for more directives after reading the ResourceConfig file. Filename is relative to the ServerRoot. This feature can be disabled using: AccessConfig /dev/null Historically, this file only contained <Directory> sections; in fact it can now contain any server directive allowed in the server config context. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AccessConfig Default REG_SZ conf/access.conf DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AccessConfig Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AccessFileName DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AccessFileName Description Syntax: AccessFileName filename filename ... Default: AccessFileName .htaccess Context: server config, virtual host Status: core Compatibility: AccessFileName can accept more than one filename only in Apache 1.3 and later When returning a document to the client the server looks for the first existing access control file from this list of names in every directory of the path to the document, if access control files are enabled for that directory. For example: AccessFileName .acl before returning the document /usr/local/web/index.html, the server will read /.acl, /usr/.acl, /usr/local/.acl and /usr/local/web/.acl for directives, unless they have been disabled with <Directory /> AllowOverride None </Directory> DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AccessFileName Default REG_SZ .htaccess DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AccessFileName Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Action DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Action Description Syntax: Action MIME-type cgi-script Context: server config, virtual host, directory, .htaccess Override: FileInfo Status: Base Module: mod_actions Compatibility: Action is only available in Apache 1.1 and later This directive adds an action, which will activate cgi-script when a file of content type MIME-type is requested. It sends the URL and file path of the requested document using the standard CGI PATH_INFO and PATH_TRANSLATED environment variables. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Action Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Action Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddAlt DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddAlt Description Syntax: AddAlt string file file... Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_autoindex This sets the alternate text to display for a file, instead of an icon, for FancyIndexing. File is a file extension, partial filename, wild-card expression or full filename for files to describe. String is enclosed in double quotes ("). This alternate text is displayed if the client is image-incapable or has image loading disabled. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddAlt Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddAlt Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddAltByEncoding DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddAltByEncoding Description Syntax: AddAltByEncoding string MIME-encoding MIME-encoding... Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_autoindex This sets the alternate text to display for a file, instead of an icon, for FancyIndexing. MIME-encoding is a valid content-encoding, such as x-compress. String is enclosed in double quotes ("). This alternate text is displayed if the client is image-incapable or has image loading disabled. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddAltByEncoding Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddAltByEncoding Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddAltByType DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddAltByType Description Syntax: AddAltByType string MIME-type MIME-type ... Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_autoindex This sets the alternate text to display for a file, instead of an icon, for FancyIndexing. MIME-type is a valid content-type, such as text/html. String is enclosed in double quotes ("). This alternate text is displayed if the client is image-incapable or has image loading disabled. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddAltByType Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddAltByType Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddDescription DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddDescription Description Syntax: AddDescription string file file... Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_autoindex This sets the description to display for a file, for FancyIndexing. File is a file extension, partial filename, wild-card expression or full filename for files to describe. String is enclosed in double quotes ("). Example: AddDescription "The planet Mars" /web/pics/mars.gif DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddDescription Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddDescription Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddEncoding DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddEncoding Description Syntax: AddEncoding MIME-enc extension extension... Context: server config, virtual host, directory, .htaccess Override: FileInfo Status: Base Module: mod_mime The AddEncoding directive adds to the list of filename extensions which filenames may end in for the specified encoding type. Mime-enc is the mime encoding to use for documents ending in extension. Example: AddEncoding x-gzip gz AddEncoding x-compress Z This will cause files ending in .gz to be marked as encoded using the x-gzip encoding, and .Z files to be marked as encoded with x-compress. Old clients expect x-gzip and x-compress, however the standard dictates that they're equivalent to gzip and compress respectively. Apache does content encoding comparisons by ignoring any leading x-. When responding with an encoding Apache will use whatever form (i.e., x-foo or foo) the client requested. If the client didn't specifically request a particular form Apache will use the form given by the AddEncoding directive. To make this long story short, you should always use x-gzip and x-compress for these two specific encodings. More recent encodings, such as deflate should be specified without the x-. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddEncoding Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddEncoding Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddHandler DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddHandler Description Syntax: AddHandler handler-name extension extension... Context: server config, virtual host, directory, .htaccess Override: FileInfo Status: Base Module: mod_mime Compatibility: AddHandler is only available in Apache 1.1 and later AddHandler maps the filename extensions extension to the handler handler-name. For example, to activate CGI scripts with the file extension ".cgi", you might use: AddHandler cgi-script cgi Once that has been put into your srm.conf or httpd.conf file, any file ending with ".cgi" will be treated as a CGI program. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddHandler Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddHandler Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddIcon DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddIcon Description Syntax: AddIcon icon name name ... Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_autoindex This sets the icon to display next to a file ending in name for FancyIndexing. Icon is either a (%-escaped) relative URL to the icon, or of the format (alttext,url) where alttext is the text tag given for an icon for non-graphical browsers. Name is either ^^DIRECTORY^^ for directories, ^^BLANKICON^^ for blank lines (to format the list correctly), a file extension, a wildcard expression, a partial filename or a complete filename. Examples: AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm AddIcon /icons/dir.xbm ^^DIRECTORY^^ AddIcon /icons/backup.xbm *~ AddIconByType should be used in preference to AddIcon, when possible. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddIcon Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddIcon Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddIconByEncoding DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddIconByEncoding Description Syntax: AddIconByEncoding icon MIME-encoding MIME-encoding ... Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_autoindex This sets the icon to display next to files with MIME-encoding for FancyIndexing. Icon is either a (%-escaped) relative URL to the icon, or of the format (alttext,url) where alttext is the text tag given for an icon for non-graphical browsers. Mime-encoding is a wildcard expression matching required the content-encoding. Examples: AddIconByEncoding /icons/compress.xbm x-compress DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddIconByEncoding Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddIconByEncoding Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddIconByType DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddIconByType Description Syntax: AddIconByType icon MIME-type MIME-type ... Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_autoindex This sets the icon to display next to files of type MIME-type for FancyIndexing. Icon is either a (%-escaped) relative URL to the icon, or of the format (alttext,url) where alttext is the text tag given for an icon for non-graphical browsers. Mime-type is a wildcard expression matching required the mime types. Examples: AddIconByType (IMG,/icons/image.xbm) image/* DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddIconByType Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddIconByType Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddLanguage DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddLanguage Description Syntax: AddLanguage MIME-lang extension extension... Context: server config, virtual host, directory, .htaccess Override: FileInfo Status: Base Module: mod_mime The AddLanguage directive adds to the list of filename extensions which filenames may end in for the specified content language. Mime-lang is the mime language of files with names ending extension, after any content encoding extensions have been removed. Example: AddEncoding x-compress Z AddLanguage en .en AddLanguage fr .fr Then the document xxxx.en.Z will be treated as being a compressed English document. Although the content language is reported to the client, the browser is unlikely to use this information. The AddLanguage directive is more useful for content negotiation, where the server returns one from several documents based on the client's language preference. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddLanguage Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddLanguage Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddModule DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddModule Description Syntax: AddModule module module ... Context: server config Status: core Compatibility: AddModule is only available in Apache 1.2 and later The server can have modules compiled in which are not actively in use. This directive can be used to enable the use of those modules. The server comes with a pre-loaded list of active modules; this list can be cleared with the ClearModuleList directive. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddModule Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddModule Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddModuleInfo DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddModuleInfo Description Syntax: AddModuleInfo module-name string Context: server config, virtual host Status: base Module: mod_browser Compatibility: Apache 1.3 and above This allows the content of string to be shown as HTML interpreted, Additional Information for the module module-name. Example: AddModuleInfo mod_auth.c 'See <A HREF="http://www.apache.org/docs/mod/mod_auth.html">http://www.apache.org/docs/mod/mod_auth.html</A>' DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddModuleInfo Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddModuleInfo Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddType DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddType Description Syntax: AddType MIME-type extension extension... Context: server config, virtual host, directory, .htaccess Override: FileInfo Status: Base Module: mod_mime The AddType directive adds to the list of filename extensions which filenames may end in for the specified content type. Mime-enc is the mime type to use for documents ending in extension. after content-encoding and language extensions have been removed. Example: AddType image/gif GIF It is recommended that new mime types be added using the AddType directive rather than changing the TypesConfig file. Note that, unlike the NCSA httpd, this directive cannot be used to set the type of particular files. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddType Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AddType Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AgentLog DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AgentLog Description Syntax: AgentLog file-pipe Default: AgentLog logs/agent_log Context: server config, virtual host Status: Extension Module: mod_log_agent The AgentLog directive sets the name of the file to which the server will log the UserAgent header of incoming requests. File-pipe is one of A filename A filename relative to the ServerRoot. `|' followed by a command A program to receive the agent log information on its standard input. Note the a new program will not be started for a VirtualHost if it inherits the AgentLog from the main server. Security: if a program is used, then it will be run under the user who started httpd. This will be root if the server was started by root; be sure that the program is secure. Security: See the security tips document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server. This directive is provided for compatibility with NCSA 1.4. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AgentLog Default REG_SZ logs/agent_log DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AgentLog Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Alias DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Alias Description Syntax: Alias url-path directory-filename Context: server config, virtual host Status: Base Module: mod_alias The Alias directive allows documents to be stored in the local filesystem other than under the DocumentRoot. URLs with a (%-decoded) path beginning with url-path will be mapped to local files beginning with directory-filename. Example: Alias /image /ftp/pub/image A request for http://myserver/image/foo.gif would cause the server to return the file /ftp/pub/image/foo.gif. Note that if you include a trailing / on the url-path then the server will require a trailing / in order to expand the alias. That is, if you use Alias /icons/ /usr/local/apache/icons/ then the url /icons will not be aliased. Note that you may need to specify additional <Directory> sections which cover the destination of aliases. Aliasing occurs before <Directory> sections are checked, so only the destination of aliases are affected. (Note however <Location> sections are run through once before aliases are performed, so they will apply.) See also ScriptAlias. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Alias Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Alias Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AliasMatch DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AliasMatch Description Syntax: AliasMatch regex directory-filename Context: server config, virtual host Status: Base Module: mod_alias Compatibility: Available in Apache 1.3 and later This directive is equivalent to Alias, but makes use of standard regular expressions, instead of simple prefix matching. The supplied regular expression is matched against the URL, and if it matches, the server will substitute any parenthesized matches into the given string and use it as a filename. For example, to activate the /icons directory, one might use: AliasMatch ^/icons(.*) /usr/local/apache/icons$1 DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AliasMatch Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AliasMatch Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\allow DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\allow Description Syntax: allow from host host ... Context: directory, .htaccess Override: Limit Status: Base Module: mod_access The allow directive affects which hosts can access a given directory. Host is one of the following: all All hosts are allowed access A (partial) domain-name Hosts whose names match, or end in, this string are allowed access. A full IP address An IP address of a host allowed access A partial IP address The first 1 to 3 bytes of an IP address, for subnet restriction. A network/netmask pair (Apache 1.3 and later) A network a.b.c.d, and a netmask w.x.y.z. For more fine-grained subnet restriction. (i.e., 10.1.0.0/255.255.0.0) A network/nnn CIDR specification (Apache 1.3 and later) Similar to the previous case, except the netmask consists of nnn high-order 1 bits. (i.e., 10.1.0.0/16 is the same as 10.1.0.0/255.255.0.0) Example: allow from .ncsa.uiuc.edu All hosts in the specified domain are allowed access. Note that this compares whole components; bar.edu would not match foobar.edu. See also deny, order, and BrowserMatch. Syntax: allow from env=variablename Context: directory, .htaccess Override: Limit Status: Base Module: mod_access Compatibility: Apache 1.2 and above The allow from env directive controls access to a directory by the existence (or non-existence) of an environment variable. Example: BrowserMatch ^KnockKnock/2.0 let_me_in <Directory /docroot> order deny,allow deny from all allow from env=let_me_in </Directory> In this case browsers with the user-agent string KnockKnock/2.0 will be allowed access, and all others will be denied. See also deny from env and order. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\allow Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\allow Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AllowCONNECT DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AllowCONNECT Description Syntax: AllowCONNECT <port list> Default: AllowCONNECT 443 563 Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: AllowCONNECT is only available in Apache 1.3.2 and later. The AllowCONNECT directive specifies a list of port numbers to which the proxy CONNECT method may connect. Today's browsers use this method when a https connection is requested and proxy tunneling over http is in effect. By default, only the default https port (443) and the default snews port (563) are enabled. Use the AllowCONNECT directive to overrride this default and allow connections to the listed ports only. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AllowCONNECT Default REG_SZ 443 563 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AllowCONNECT Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AllowOverride DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AllowOverride Description Syntax: AllowOverride override override ... Default: AllowOverride All Context: directory Status: core When the server finds an .htaccess file (as specified by AccessFileName) it needs to know which directives declared in that file can override earlier access information. Override can be set to None, in which case the server will not read the file, All in which case the server will allow all the directives, or one or more of the following: AuthConfig Allow use of the authorization directives (AuthDBMGroupFile, AuthDBMUserFile, AuthGroupFile, AuthName, AuthType, AuthUserFile, require, etc.). FileInfo Allow use of the directives controlling document types (AddEncoding, AddLanguage, AddType, DefaultType, ErrorDocument, LanguagePriority, etc.). Indexes Allow use of the directives controlling directory indexing (AddDescription, AddIcon, AddIconByEncoding, AddIconByType, DefaultIcon, DirectoryIndex, FancyIndexing, HeaderName, IndexIgnore, IndexOptions, ReadmeName, etc.). Limit Allow use of the directives controlling host access (allow, deny and order). Options Allow use of the directives controlling specific directory features (Options and XBitHack). DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AllowOverride Default REG_SZ All DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AllowOverride Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Alternate DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Alternate Description The ExpiresDefault and ExpiresByType directives can also be defined in a more readable syntax of the form: ExpiresDefault "<base> [plus] {<num> <type>}*" ExpiresByType type/encoding "<base> [plus] {<num> <type>}*" where <base> is one of: * access * now (equivalent to 'access') * modification The 'plus' keyword is optional. <num> should be an integer value [acceptable to atoi()], and <type> is one of: * years * months * weeks * days * hours * minutes * seconds For example, any of the following directives can be used to make documents expire 1 month after being accessed, by default: ExpiresDefault "access plus 1 month" ExpiresDefault "access plus 4 weeks" ExpiresDefault "access plus 30 days" The expiry time can be fine-tuned by adding several '<num> <type>' clauses: ExpiresByType text/html "access plus 1 month 15 days 2 hours" ExpiresByType image/gif "modification plus 5 hours 3 minutes" Note that if you use a modification date based setting, the Expires header will not be added to content that does not come from a file on disk. This is due to the fact that there is no modification time for such content. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Alternate Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Alternate Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous Description Syntax: Anonymous user user ... Default: none Context: directory, .htaccess Override: AuthConfig Status: Extension Module: mod_auth_anon A list of one or more 'magic' userIDs which are allowed access without password verification. The userIDs are space separated. It is possible to use the ' and " quotes to allow a space in a userID as well as the \ escape character. Please note that the comparison is case-IN-sensitive. I strongly suggest that the magic username 'anonymous' is always one of the allowed userIDs. Example: Anonymous anonymous "Not Registered" 'I don\'t know' This would allow the user to enter without password verification by using the userId's 'anonymous', 'AnonyMous','Not Registered' and 'I Don't Know'. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_Authoritative DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_Authoritative Description Syntax: Anonymous_Authoritative on | off Default: Anonymous_Authoritative off Context: directory, .htaccess Override: AuthConfig Status: Extension Module: mod_auth_anon When set 'on', there is no fall-through to other authorization methods. So if a userID does not match the values specified in the Anonymous directive, access is denied. Be sure you know what you are doing when you decide to switch it on. And remember that it is the linking order of the modules (in the Configuration / Make file) which details the order in which the Authorization modules are queried. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_Authoritative Default REG_SZ off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_Authoritative Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_LogEmail DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_LogEmail Description Syntax: Anonymous_LogEmail on | off Default: Anonymous_LogEmail on Context: directory, .htaccess Override: AuthConfig Status: Extension Module: mod_auth_anon When set 'on', the default, the 'password' entered (which hopefully contains a sensible email address) is logged in the error log. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_LogEmail Default REG_SZ on DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_LogEmail Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_MustGiveEmail DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_MustGiveEmail Description Syntax: Anonymous_MustGiveEmail on | off Default: Anonymous_MustGiveEmail on Context: directory, .htaccess Override: AuthConfig Status: Extension Module: mod_auth_anon Specifies whether the user must specify an email address as the password. This prohibits blank passwords. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_MustGiveEmail Default REG_SZ on DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_MustGiveEmail Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_NoUserID DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_NoUserID Description Syntax: Anonymous_NoUserID on | off Default: Anonymous_NoUserID off Context: directory, .htaccess Override: AuthConfig Status: Extension Module: mod_auth_anon When set 'on', users can leave the userID (and perhaps the password field) empty. This can be very convenient for MS-Explorer users who can just hit return or click directly on the OK button; which seems a natural reaction. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_NoUserID Default REG_SZ off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_NoUserID Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_VerifyEmail DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_VerifyEmail Description Syntax: Anonymous_VerifyEmail on | off Default: Anonymous_VerifyEmail off Context: directory, .htaccess Override: AuthConfig Status: Extension Module: mod_auth_anon When set 'on' the 'password' entered is checked for at least one '@' and a '.' to encourage users to enter valid email addresses (see the above Auth_LogEmail). DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_VerifyEmail Default REG_SZ off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_VerifyEmail Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthAuthoritative DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthAuthoritative Description Syntax: AuthAuthoritative < on(default) | off > Context: directory, .htaccess Override: AuthConfig Status: Base Module: mod_auth Setting the AuthAuthoritative directive explicitly to 'off' allows for both authentication and authorization to be passed on to lower level modules (as defined in the Configuration and modules.c files) if there is no userID or rule matching the supplied userID. If there is a userID and/or rule specified; the usual password and access checks will be applied and a failure will give an Authorization Required reply. So if a userID appears in the database of more than one module; or if a valid require directive applies to more than one module; then the first module will verify the credentials; and no access is passed on; regardless of the AuthAuthoritative setting. A common use for this is in conjunction with one of the database modules; such as mod_auth_db.c, mod_auth_dbm.c, mod_auth_msql.c, and mod_auth_anon.c. These modules supply the bulk of the user credential checking; but a few (administrator) related accesses fall through to a lower level with a well protected AuthUserFile. Default: By default; control is not passed on; and an unknown userID or rule will result in an Authorization Required reply. Not setting it thus keeps the system secure; and forces an NCSA compliant behaviour. Security: Do consider the implications of allowing a user to allow fall-through in his .htaccess file; and verify that this is really what you want; Generally it is easier to just secure a single .htpasswd file, than it is to secure a database such as mSQL. Make sure that the AuthUserFile is stored outside the document tree of the web-server; do not put it in the directory that it protects. Otherwise, clients will be able to download the AuthUserFile. See also AuthName, AuthType and AuthGroupFile. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthAuthoritative Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthAuthoritative Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBAuthoritative DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBAuthoritative Description Syntax: AuthDBAuthoritative < on(default) | off > Context: directory, .htaccess Override: AuthConfig Status: Base Module: mod_auth Setting the AuthDBAuthoritative directive explicitly to 'off' allows for both authentication and authorization to be passed on to lower level modules (as defined in the Configuration and modules.c file if there is no userID or rule matching the supplied userID. If there is a userID and/or rule specified; the usual password and access checks will be applied and a failure will give an Authorization Required reply. So if a userID appears in the database of more than one module; or if a valid require directive applies to more than one module; then the first module will verify the credentials; and no access is passed on; regardless of the AuthAuthoritative setting. A common use for this is in conjunction with one of the basic auth modules; such as mod_auth.c. Whereas this DB module supplies the bulk of the user credential checking; a few (administrator) related accesses fall through to a lower level with a well protected .htpasswd file. Default: By default; control is not passed on; and an unknown userID or rule will result in an Authorization Required reply. Not setting it thus keeps the system secure; and forces an NCSA compliant behaviour. Security: Do consider the implications of allowing a user to allow fall-through in his .htaccess file; and verify that this is really what you want; Generally it is easier to just secure a single .htpasswd file, than it is to secure a database which might have more access interfaces. See also AuthName, AuthType and AuthDBGroupFile. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBAuthoritative Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBAuthoritative Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBGroupFile DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBGroupFile Description Syntax: AuthDBGroupFile filename Context: directory, .htaccess Override: AuthConfig Status: Extension Module: mod_auth_db The AuthDBGroupFile directive sets the name of a DB file containing the list of user groups for user authentication. Filename is the absolute path to the group file. The group file is keyed on the username. The value for a user is a comma-separated list of the groups to which the users belongs. There must be no whitespace within the value, and it must never contain any colons. Security: make sure that the AuthDBGroupFile is stored outside the document tree of the web-server; do not put it in the directory that it protects. Otherwise, clients will be able to download the AuthDBGroupFile unless otherwise protected. Combining Group and Password DB files: In some cases it is easier to manage a single database which contains both the password and group details for each user. This simplifies any support programs that need to be written: they now only have to deal with writing to and locking a single DBM file. This can be accomplished by first setting the group and password files to point to the same DB file: AuthDBGroupFile /www/userbase AuthDBUserFile /www/userbase The key for the single DB record is the username. The value consists of Unix Crypt-ed Password : List of Groups [ : (ignored) ] The password section contains the Unix crypt() password as before. This is followed by a colon and the comma separated list of groups. Other data may optionally be left in the DB file after another colon; it is ignored by the authentication module. See also AuthName, AuthType and AuthDBUserFile. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBGroupFile Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBGroupFile Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBMAuthoritative DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBMAuthoritative Description Syntax: AuthDBMAuthoritative < on(default) | off > Context: directory, .htaccess Override: AuthConfig Status: Base Module: mod_auth Setting the AuthDBMAuthoritative directive explicitly to 'off' allows for both authentication and authorization to be passed on to lower level modules (as defined in the Configuration and modules.c file if there is no userID or rule matching the supplied userID. If there is a userID and/or rule specified; the usual password and access checks will be applied and a failure will give an Authorization Required reply. So if a userID appears in the database of more than one module; or if a valid require directive applies to more than one module; then the first module will verify the credentials; and no access is passed on; regardless of the AuthAuthoritative setting. A common use for this is in conjunction with one of the basic auth modules; such as mod_auth.c. Whereas this DBM module supplies the bulk of the user credential checking; a few (administrator) related accesses fall through to a lower level with a well protected .htpasswd file. Default: By default; control is not passed on; and an unknown userID or rule will result in an Authorization Required reply. Not setting it thus keeps the system secure; and forces an NCSA compliant behaviour. Security: Do consider the implications of allowing a user to allow fall-through in his .htaccess file; and verify that this is really what you want; Generally it is easier to just secure a single .htpasswd file, than it is to secure a database which might have more access interfaces. See also AuthName, AuthType and AuthDBMGroupFile. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBMAuthoritative Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBMAuthoritative Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBMGroupFile DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBMGroupFile Description Syntax: AuthDBMGroupFile filename Context: directory, .htaccess Override: AuthConfig Status: Extension Module: mod_auth_dbm The AuthDBMGroupFile directive sets the name of a DBM file containing the list of user groups for user authentication. Filename is the absolute path to the group file. The group file is keyed on the username. The value for a user is a comma-separated list of the groups to which the users belongs. There must be no whitespace within the value, and it must never contain any colons. Security: make sure that the AuthDBMGroupFile is stored outside the document tree of the web-server; do not put it in the directory that it protects. Otherwise, clients will be able to download the AuthDBMGroupFile unless otherwise protected. Combining Group and Password DBM files: In some cases it is easier to manage a single database which contains both the password and group details for each user. This simplifies any support programs that need to be written: they now only have to deal with writing to and locking a single DBM file. This can be accomplished by first setting the group and password files to point to the same DBM: AuthDBMGroupFile /www/userbase AuthDBMUserFile /www/userbase The key for the single DBM is the username. The value consists of Unix Crypt-ed Password : List of Groups [ : (ignored) ] The password section contains the Unix crypt() password as before. This is followed by a colon and the comma separated list of groups. Other data may optionally be left in the DBM file after another colon; it is ignored by the authentication module. This is what www.telescope.org uses for its combined password and group database. See also AuthName, AuthType and AuthDBMUserFile. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBMGroupFile Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBMGroupFile Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBMUserFile DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBMUserFile Description Syntax: AuthDBMUserFile filename Context: directory, .htaccess Override: AuthConfig Status: Extension Module: mod_auth_dbm The AuthDBMUserFile directive sets the name of a DBM file containing the list of users and passwords for user authentication. Filename is the absolute path to the user file. The user file is keyed on the username. The value for a user is the crypt() encrypted password, optionally followed by a colon and arbitrary data. The colon and the data following it will be ignored by the server. Security: make sure that the AuthDBMUserFile is stored outside the document tree of the web-server; do not put it in the directory that it protects. Otherwise, clients will be able to download the AuthDBMUserFile. Important compatibility note: The implementation of "dbmopen" in the apache modules reads the string length of the hashed values from the DBM data structures, rather than relying upon the string being NULL-appended. Some applications, such as the Netscape web server, rely upon the string being NULL-appended, so if you are having trouble using DBM files interchangeably between applications this may be a part of the problem. See also AuthName, AuthType and AuthDBMGroupFile. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBMUserFile Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBMUserFile Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBUserFile DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBUserFile Description Syntax: AuthDBUserFile filename Context: directory, .htaccess Override: AuthConfig Status: Extension Module: mod_auth_db The AuthDBUserFile directive sets the name of a DB file containing the list of users and passwords for user authentication. Filename is the absolute path to the user file. The user file is keyed on the username. The value for a user is the crypt() encrypted password, optionally followed by a colon and arbitrary data. The colon and the data following it will be ignored by the server. Security: make sure that the AuthDBUserFile is stored outside the document tree of the web-server; do not put it in the directory that it protects. Otherwise, clients will be able to download the AuthDBUserFile. Important compatibility note: The implementation of "dbmopen" in the apache modules reads the string length of the hashed values from the DB data structures, rather than relying upon the string being NULL-appended. Some applications, such as the Netscape web server, rely upon the string being NULL-appended, so if you are having trouble using DB files interchangeably between applications this may be a part of the problem. See also AuthName, AuthType and AuthDBGroupFile. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBUserFile Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBUserFile Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDigestFile DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDigestFile Description Syntax: AuthDigestFile filename Context: directory, .htaccess Override: AuthConfig Status: Base Module: mod_digest The AuthDigestFile directive sets the name of a textual file containing the list of users and encoded passwords for digest authentication. Filename is the absolute path to the user file. The digest file uses a special format. Files in this format can be created using the "htdigest" utility found in the support/ subdirectory of the Apache distribution. Using Digest Authentication Using MD5 Digest authentication is very simple. Simply set up authentication normally. However, use "AuthType Digest" and "AuthDigestFile" instead of the normal "AuthType Basic" and "AuthUserFile". Everything else should remain the same. MD5 authentication provides a more secure password system, but only works with supporting browsers. As of this writing (July 1996), the majority of browsers do not support digest authentication. Therefore, we do not recommend using this feature on a large Internet site. However, for personal and intra-net use, where browser users can be controlled, it is ideal. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDigestFile Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDigestFile Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthGroupFile DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthGroupFile Description Syntax: AuthGroupFile filename Context: directory, .htaccess Override: AuthConfig Status: Base Module: mod_auth The AuthGroupFile directive sets the name of a textual file containing the list of user groups for user authentication. Filename is the path to the group file. If it is not absolute (i.e., if it doesn't begin with a slash), it is treated as relative to the ServerRoot. Each line of the group file contains a groupname followed by a colon, followed by the member usernames separated by spaces. Example: mygroup: bob joe anne Note that searching large text files is very inefficient; AuthDBMGroupFile should be used instead. Security: make sure that the AuthGroupFile is stored outside the document tree of the web-server; do not put it in the directory that it protects. Otherwise, clients will be able to download the AuthGroupFile. See also AuthName, AuthType and AuthUserFile. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthGroupFile Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthGroupFile Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthName DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthName Description Syntax: AuthName auth-domain Context: directory, .htaccess Override: AuthConfig Status: core This directive sets the name of the authorization realm for a directory. This realm is given to the client so that the user knows which username and password to send. It must be accompanied by AuthType and require directives, and directives such as AuthUserFile and AuthGroupFile to work. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthName Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthName Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthType DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthType Description Syntax: AuthType type Context: directory, .htaccess Override: AuthConfig Status: core This directive selects the type of user authentication for a directory. Only Basic and Digest are currently implemented. It must be accompanied by AuthName and require directives, and directives such as AuthUserFile and AuthGroupFile to work. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthType Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthType Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthUserFile DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthUserFile Description Syntax: AuthUserFile filename Context: directory, .htaccess Override: AuthConfig Status: Base Module: mod_auth The AuthUserFile directive sets the name of a textual file containing the list of users and passwords for user authentication. Filename is the path to the user file. If it is not absolute (i.e., if it doesn't begin with a slash), it is treated as relative to the ServerRoot. Each line of the user file file contains a username followed by a colon, followed by the crypt() encrypted password. The behavior of multiple occurrences of the same user is undefined. Note that searching large text files is very inefficient; AuthDBMUserFile should be used instead. Security: make sure that the AuthUserFile is stored outside the document tree of the web-server; do not put it in the directory that it protects. Otherwise, clients will be able to download the AuthUserFile. See also AuthName, AuthType and AuthGroupFile. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthUserFile Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthUserFile Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BindAddress DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BindAddress Description Syntax: BindAddress saddr Default: BindAddress * Context: server config Status: core A Unix« http server can either listen for connections to every IP address of the server machine, or just one IP address of the server machine. Saddr can be * * An IP address * A fully-qualified Internet domain name * If the value is *, then the server will listen for connections on every IP address, otherwise it will only listen on the IP address specified. Only one BindAddress directive can be used. For more control over which address and ports Apache listens to, use the Listen directive instead of BindAddress. BindAddress can be used as an alternative method for supporting virtual hosts using multiple independent servers, instead of using <VirtualHost> sections. See Also: DNS Issues See Also: Setting which addresses and ports Apache uses DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BindAddress Default REG_SZ * DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BindAddress Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BrowserMatch DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BrowserMatch Description Syntax: BrowserMatch regex envar[=value] [...] Default: none Context: server config Override: none Status: Base Module: mod_setenvif Compatibility: Apache 1.2 and above (in Apache 1.2 this directive was found in the now-obsolete mod_browser module) The BrowserMatch directive defines environment variables based on the User-Agent HTTP request header field. The first argument should be a POSIX.2 extended regular expression (similar to an egrep-style regex). The rest of the arguments give the names of variables to set, and optionally values to which they should be set. These take the form of 1. varname, or 2. !varname, or 3. varname=value In the first form, the value will be set to "1". The second will remove the given variable if already defined, and the third will set the variable to the value given by value. If a User-Agent string matches more than one entry, they will be merged. Entries are processed in the order in which they appear, and later entries can override earlier ones. For example: BrowserMatch ^Mozilla forms jpeg=yes browser=netscape BrowserMatch "^Mozilla/[2-3]" tables agif frames javascript BrowserMatch MSIE !javascript Note that the regular expression string is case-sensitive. For cane-INsensitive matching, see the BrowserMatchNoCase directive. The BrowserMatch and BrowserMatchNoCase directives are special cases of the SetEnvIf and SetEnvIfNoCase directives. The following two lines have the same effect: BrowserMatchNoCase Robot is_a_robot SetEnvIfNoCase User-Agent Robot is_a_robot DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BrowserMatch Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BrowserMatch Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BrowserMatchNoCase DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BrowserMatchNoCase Description Syntax: BrowserMatchNoCase regex envar[=value] [...] Default: none Context: server config Override: none Status: Base Module: mod_setenvif Compatibility: Apache 1.2 and above (in Apache 1.2 this directive was found in the now-obsolete mod_browser module) The BrowserMatchNoCase directive is semantically identical to the BrowserMatch directive. However, it provides for case-insensitive matching. For example: BrowserMatchNoCase mac platform=macintosh BrowserMatchNoCase win platform=windows The BrowserMatch and BrowserMatchNoCase directives are special cases of the SetEnvIf and SetEnvIfNoCase directives. The following two lines have the same effect: BrowserMatchNoCase Robot is_a_robot SetEnvIfNoCase User-Agent Robot is_a_robot DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BrowserMatchNoCase Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BrowserMatchNoCase Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BS2000Account DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BS2000Account Description Syntax: BS2000Account account Default: none Context: server config Status: core Compatibility: BS2000Account is only available for BS2000 machines, as of Apache 1.3 and later. The BS2000Account directive is available for BS2000 hosts only. It must be used to define the account number for the non-privileged apache server user (which was configured using the User directive). This is required by the BS2000 POSIX subsystem (to change the underlying BS2000 task environment by performing a sub-LOGON) to prevent CGI scripts from accessing resources of the privileged account which started the server, usually SYSROOT. Only one BS2000Account directive can be used. See Also: Apache EBCDIC port DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BS2000Account Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\BS2000Account Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheDefaultExpire DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheDefaultExpire Description Syntax: CacheDefaultExpire <time> Default: CacheDefaultExpire 1 Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: CacheDefaultExpire is only available in Apache 1.1 and later. If the document is fetched via a protocol that does not support expiry times, then use <time> hours as the expiry time. CacheMaxExpire does not override this setting. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheDefaultExpire Default REG_SZ 1 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheDefaultExpire Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheDirLength DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheDirLength Description Syntax: CacheDirLength <length> Default: CacheDirLength 1 Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: CacheDirLength is only available in Apache 1.1 and later. CacheDirLength sets the number of characters in proxy cache subdirectory names. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheDirLength Default REG_SZ 1 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheDirLength Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheDirLevels DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheDirLevels Description Syntax: CacheDirLevels <levels> Default: CacheDirLevels 3 Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: CacheDirLevels is only available in Apache 1.1 and later. CacheDirLevels sets the number of levels of subdirectories in the cache. Cached data will be saved this many directory levels below CacheRoot. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheDirLevels Default REG_SZ 3 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheDirLevels Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheForceCompletion DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheForceCompletion Description Syntax: CacheForceCompletion <percentage> Default: 90 Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: CacheForceCompletion is only available in Apache 1.3.1 and later. If an http transfer that is being cached is cancelled, the proxy module will complete the transfer to cache if more than the percentage specified has already been transferred. This is a percentage, and must be a number between 1 and 100, or 0 to use the default. 100 will cause a document to be cached only if the transfer was allowed to complete. A number between 60 and 90 is recommended. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheForceCompletion Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheForceCompletion Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheGcInterval DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheGcInterval Description Syntax: CacheGcInterval <time> Default: None Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: CacheGcinterval is only available in Apache 1.1 and later. Check the cache every <time> hours, and delete files if the space usage is greater than that set by CacheSize. Note that <time> accepts a float value, you could for example use CacheGcInterval 1.5 to check the cache every 90 minutes. (If unset, no garbage collection will be performed, and the cache will grow indefinitely.) Note also that the larger the CacheGcInterval, the more extra space beyond the configured CacheSize will be needed for the cache between garbage collections. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheGcInterval Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheGcInterval Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheLastModifiedFactor DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheLastModifiedFactor Description Syntax: CacheLastModifiedFactor <factor> Default: CacheLastModifiedFactor 0.1 Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: CacheLastModifiedFactor is only available in Apache 1.1 and later. If the origin HTTP server did not supply an expiry date for the document, then estimate one using the formula expiry-period = time-since-last-modification * <factor> For example, if the document was last modified 10 hours ago, and <factor> is 0.1, then the expiry period will be set to 10*0.1 = 1 hour. If the expiry-period would be longer than that set by CacheMaxExpire, then the latter takes precedence. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheLastModifiedFactor Default REG_SZ 0.1 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheLastModifiedFactor Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheMaxExpire DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheMaxExpire Description Syntax: CacheMaxExpire <time> Default: CacheMaxExpire 24 Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: CacheMaxExpire is only available in Apache 1.1 and later. Cachable HTTP documents will be retained for at most <time> hours without checking the origin server. Thus documents can be at most <time> hours out of date. This restriction is enforced even if an expiry date was supplied with the document. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheMaxExpire Default REG_SZ 24 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheMaxExpire Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheNegotiatedDocs DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheNegotiatedDocs Description Syntax: CacheNegotiatedDocs Context: server config Status: Base Module: mod_negotiation Compatibility: CacheNegotiatedDocs is only available in Apache 1.1 and later. If set, this directive allows content-negotiated documents to be cached by proxy servers. This could mean that clients behind those proxys could retrieve versions of the documents that are not the best match for their abilities, but it will make caching more efficient. This directive only applies to requests which come from HTTP/1.0 browsers. HTTP/1.1 provides much better control over the caching of negotiated documents, and this directive has no effect in responses to HTTP/1.1 requests. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheNegotiatedDocs Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheNegotiatedDocs Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheRoot DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheRoot Description Syntax: CacheRoot <directory> Default: None Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: CacheRoot is only available in Apache 1.1 and later. Sets the name of the directory to contain cache files; this must be writable by the httpd server. (see the User directive). Setting CacheRoot enables proxy cacheing; without defining a CacheRoot, proxy functionality will be available if ProxyRequests are set to On, but no cacheing will be available. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheRoot Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheRoot Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheSize DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheSize Description Syntax: CacheSize <size> Default: CacheSize 5 Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: CacheSize is only available in Apache 1.1 and later. Sets the desired space usage of the cache, in KB (1024-byte units). Although usage may grow above this setting, the garbage collection will delete files until the usage is at or below this setting. Depending on the expected proxy traffic volume and CacheGcInterval, use a value which is at least 20 to 40 % lower than the available space. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheSize Default REG_SZ 5 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheSize Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CheckSpelling DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CheckSpelling Description Syntax: CheckSpelling on/off Default: CheckSpelling Off Context: server config, virtual host, directory, .htaccess Override: Options Status: Base Module: mod_speling Compatibility: CheckSpelling was available as a separately available module for Apache 1.1, but was limited to miscapitalizations. As of Apache 1.3, it is part of the Apache distribution. Prior to Apache 1.3.2, the CheckSpelling directive was only available in the "server" and "virtual host" contexts. This directive enables or disables the spelling module. When enabled, keep in mind that * the directory scan which is necessary for the spelling correction will have an impact on the server's performance when many spelling corrections have to be performed at the same time. * the document trees should not contain sensitive files which could be matched inadvertently by a spelling "correction". * the module is unable to correct misspelled user names (as in http://my.host/~apahce/), just file names or directory names. * spelling corrections apply strictly to existing files, so a request for the <Location /status> may get incorrectly treated as the negotiated file "/stats.html". DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CheckSpelling Default REG_SZ Off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CheckSpelling Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ClearModuleList DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ClearModuleList Description Syntax: ClearModuleList Context: server config Status: core Compatibility: ClearModuleList is only available in Apache 1.2 and later The server comes with a built-in list of active modules. This directive clears the list. It is assumed that the list will then be re-populated using the AddModule directive. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ClearModuleList Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ClearModuleList Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ContentDigest DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ContentDigest Description Syntax: ContentDigest on|off Default: ContentDigest off Context: server config, virtual host, directory, .htaccess Override: AuthConfig Status: experimental Compatibility: ContentDigest is only available in Apache 1.1 and later This directive enables the generation of Content-MD5 headers as defined in RFC1864 respectively RFC2068. MD5 is an algorithm for computing a "message digest" (sometimes called "fingerprint") of arbitrary-length data, with a high degree of confidence that any alterations in the data will be reflected in alterations in the message digest. The Content-MD5 header provides an end-to-end message integrity check (MIC) of the entity-body. A proxy or client may check this header for detecting accidental modification of the entity-body in transit. Example header: Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA== Note that this can cause performance problems on your server since the message digest is computed on every request (the values are not cached). Content-MD5 is only sent for documents served by the core, and not by any module. For example, SSI documents, output from CGI scripts, and byte range responses do not have this header. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ContentDigest Default REG_SZ off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ContentDigest Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CookieExpires DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CookieExpires Description Syntax: CookieExpires expiry-period Context: server config, virtual host Status: optional Module: mod_usertrack When used, this directive sets an expiry time on the cookie generated by the usertrack module. The expiry-period can be given either as a number of seconds, or in the format such as "2 weeks 3 days 7 hours". Valid denominations are: years, months, weeks, hours, minutes and seconds. If the expiry time is in any format other than one number indicating the number of seconds, it must be enclosed by double quotes. If this directive is not used, cookies last only for the current browser session. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CookieExpires Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CookieExpires Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CookieLog DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CookieLog Description Syntax: CookieLog filename Context: server config, virtual host Module: mod_cookies Compatibility: Only available in Apache 1.2 and above The CookieLog directive sets the filename for logging of cookies. The filename is relative to the ServerRoot. This directive is included only for compatibility with mod_cookies, and is deprecated. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CookieLog Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CookieLog Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CookieTracking DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CookieTracking Description Syntax: CookieTracking on | off Context: server config, virtual host, directory, .htaccess Override: FileInfo Status: optional Module: mod_usertrack When the user track module is compiled in, and "CookieTracking on" is set, Apache will start sending a user-tracking cookie for all new requests. This directive can be used to turn this behavior on or off on a per-server or per-directory basis. By default, compiling mod_usertrack will not activate cookies. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CookieTracking Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CookieTracking Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CoreDumpDirectory DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CoreDumpDirectory Description Syntax: CoreDumpDirectory directory Default: the same location as ServerRoot Context: server config Status: core This controls the directory to which Apache attempts to switch before dumping core. The default is in the ServerRoot directory, however since this should not be writable by the user the server runs as, core dumps won't normally get written. If you want a core dump for debugging, you can use this directive to place it in a different location. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CoreDumpDirectory Default REG_SZ same location as ServerRoot DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CoreDumpDirectory Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CustomLog DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CustomLog Description Syntax: CustomLog file-pipe format-or-nickname Context: server config, virtual host Status: Base Compatibility: Nickname only available in Apache 1.3 or later Module: mod_log_config The first argument is the filename to which log records should be written. This is used exactly like the argument to TransferLog; that is, it is either a full path or relative to the current server root. The format argument specifies a format for each line of the log file. The options available for the format are exactly the same as for the argument of the LogFormat directive. If the format includes any spaces (which it will do in almost all cases) it should be enclosed in double quotes. Instead of an actual format string, you can use a format nickname defined with the LogFormat directive. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CustomLog Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CustomLog Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DefaultIcon DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DefaultIcon Description Syntax: DefaultIcon url Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_autoindex The DefaultIcon directive sets the icon to display for files when no specific icon is known, for FancyIndexing. Url is a (%-escaped) relative URL to the icon. Examples: DefaultIcon /icon/unknown.xbm DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DefaultIcon Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DefaultIcon Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DefaultType DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DefaultType Description Syntax: DefaultType MIME-type Default: DefaultType text/html Context: server config, virtual host, directory, .htaccess Override: FileInfo Status: core There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server must inform the client of the content-type of the document, so in the event of an unknown type it uses the DefaultType. For example: DefaultType image/gif would be appropriate for a directory which contained many gif images with filenames missing the .gif extension. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DefaultType Default REG_SZ text/html DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DefaultType Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\deny DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\deny Description Syntax: deny from host host ... Context: directory, .htaccess Override: Limit Status: Base Module: mod_access The deny directive affects which hosts can access a given directory. Host is one of the following: all all hosts are denied access A (partial) domain-name host whose name is, or ends in, this string are denied access. A full IP address An IP address of a host denied access A partial IP address The first 1 to 3 bytes of an IP address, for subnet restriction. A network/netmask pair (Apache 1.3 and later) A network a.b.c.d, and a netmask w.x.y.z. For more fine-grained subnet restriction. (i.e., 10.1.0.0/255.255.0.0) A network/nnn CIDR specification (Apache 1.3 and later) Similar to the previous case, except the netmask consists of nnn high-order 1 bits. (i.e., 10.1.0.0/16 is the same as 10.1.0.0/255.255.0.0) Example: deny from 16 All hosts in the specified network are denied access. Note that this compares whole components; bar.edu would not match foobar.edu. See also allow and order. Syntax: deny from env=variablename Context: directory, .htaccess Override: Limit Status: Base Module: mod_access Compatibility: Apache 1.2 and above The deny from env directive controls access to a directory by the existence (or non-existence) of an environment variable. Example: BrowserMatch ^BadRobot/0.9 go_away <Directory /docroot> order allow,deny allow from all deny from env=go_away </Directory> In this case browsers with the user-agent string BadRobot/0.9 will be denied access, and all others will be allowed. See also allow from env and order. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\deny Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\deny Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Directory DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Directory Description Syntax: <Directory directory> ... </Directory> Context: server config, virtual host Status: Core. <Directory> and </Directory> are used to enclose a group of directives which will apply only to the named directory and sub-directories of that directory. Any directive which is allowed in a directory context may be used. Directory is either the full path to a directory, or a wild-card string. In a wild-card string, `?' matches any single character, and `*' matches any sequences of characters. As of Apache 1.3, you may also use `[]' character ranges like in the shell. Also as of Apache 1.3 none of the wildcards match a `/' character, which more closely mimics the behaviour of Unix shells. Example: <Directory /usr/local/httpd/htdocs> Options Indexes FollowSymLinks </Directory> Apache 1.2 and above: Extended regular expressions can also be used, with the addition of the ~ character. For example: <Directory ~ "^/www/.*/[0-9]{3}"> would match directories in /www/ that consisted of three numbers. If multiple (non-regular expression) directory sections match the directory (or its parents) containing a document, then the directives are applied in the order of shortest match first, interspersed with the directives from the .htaccess files. For example, with <Directory /> AllowOverride None </Directory> <Directory /home/*> AllowOverride FileInfo </Directory> for access to the document /home/web/dir/doc.html the steps are: * Apply directive AllowOverride None (disabling .htaccess files). * Apply directive AllowOverride FileInfo (for directory /home/web). * Apply any FileInfo directives in /home/web/.htaccess Regular expression directory sections are handled slightly differently by Apache 1.2 and 1.3. In Apache 1.2 they are interspersed with the normal directory sections and applied in the order they appear in the configuration file. They are applied only once, and apply when the shortest match possible occurs. In Apache 1.3 regular expressions are not considered until after all of the normal sections have been applied. Then all of the regular expressions are tested in the order they appeared in the configuration file. For example, with <Directory ~ abc$> ... directives here ... </Directory> Suppose that the filename being accessed is /home/abc/public_html/abc/index.html. The server considers each of /, /home, /home/abc, /home/abc/public_html, and /home/abc/public_html/abc in that order. In Apache 1.2, when /home/abc is considered, the regular expression will match and be applied. In Apache 1.3 the regular expression isn't considered at all at that point in the tree. It won't be considered until after all normal <Directory>s and .htaccess files have been applied. Then the regular expression will match on /home/abc/public_html/abc and be applied. Note that the default Apache access for <Directory /> is Allow from All. This means that Apache will serve any file mapped from an URL. It is recommended that you change this with a block such as <Directory /> Order Deny,Allow Deny from All </Directory> and then override this for directories you want accessible. See the Security Tips page for more details. The directory sections typically occur in the access.conf file, but they may appear in any configuration file. <Directory> directives cannot nest, and cannot appear in a <Limit> section. See also: How Directory, Location and Files sections work for an explanation of how these different sections are combined when a request is received DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Directory Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Directory Parent REG_DWORD 1 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DirectoryIndex DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DirectoryIndex Description Syntax: DirectoryIndex local-url local-url ... Default: DirectoryIndex index.html Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_dir The DirectoryIndex directive sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the a directory name. Local-url is the (%-encoded) URL of a document on the server relative to the requested directory; it is usually the name of a file in the directory. Several URLs may be given, in which case the server will return the first one that it finds. If none of the resources exist and the Indexes option is set, the server will generate its own listing of the directory. Example: DirectoryIndex index.html then a request for http://myserver/docs/ would return http://myserver/docs/index.html if it exists, or would list the directory if it did not. Note that the documents do not need to be relative to the directory; DirectoryIndex index.html index.txt /cgi-bin/index.pl would cause the CGI script /cgi-bin/index.pl to be executed if neither index.html or index.txt existed in a directory. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DirectoryIndex Default REG_SZ index.html DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DirectoryIndex Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DirectoryMatch DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DirectoryMatch Description Syntax: <DirectoryMatch regex> ... </DirectoryMatch> Context: server config, virtual host Status: Core. Compatibility: Available in Apache 1.3 and later <DirectoryMatch> and </DirectoryMatch> are used to enclose a group of directives which will apply only to the named directory and sub-directories of that directory, the same as <Directory>. However, it takes as an argument a regular expression. For example: <DirectoryMatch "^/www/.*/[0-9]{3}"> would match directories in /www/ that consisted of three numbers. See Also: <Directory> for a description of how regular expressions are mixed in with normal <Directory>s. See also: How Directory, Location and Files sections work for an explanation of how these different sections are combined when a request is received DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DirectoryMatch Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DirectoryMatch Parent REG_DWORD 1 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DocumentRoot DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DocumentRoot Description Syntax: DocumentRoot directory-filename Default: DocumentRoot /usr/local/apache/htdocs Context: server config, virtual host Status: core This directive sets the directory from which httpd will serve files. Unless matched by a directive like Alias, the server appends the path from the requested URL to the document root to make the path to the document. Example: DocumentRoot /usr/web then an access to http://www.my.host.com/index.html refers to /usr/web/index.html. There appears to be a bug in mod_dir which causes problems when the DocumentRoot has a trailing slash (i.e., "DocumentRoot /usr/web/") so please avoid that. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DocumentRoot Default REG_SZ /usr/local/apache/htdocs DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DocumentRoot Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ErrorDocument DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ErrorDocument Description Syntax: ErrorDocument error-code document Context: server config, virtual host, directory, .htaccess Status: core Override: FileInfo Compatibility: The directory and .htaccess contexts are only available in Apache 1.1 and later. In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message 2. output a customized message 3. redirect to a local URL to handle the problem/error 4. redirect to an external URL to handle the problem/error The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a message or URL. Messages in this context begin with a single quote ("), which does not form part of the message itself. Apache will sometimes offer additional information regarding the problem/error. URLs can begin with a slash (/) for local URLs, or be a full URL which the client can resolve. Examples: ErrorDocument 500 http://foo.example.com/cgi-bin/tester ErrorDocument 404 /cgi-bin/bad_urls.pl ErrorDocument 401 /subscription_info.html ErrorDocument 403 "Sorry can't allow you access today Note that when you specify an ErrorDocument that points to a remote URL (ie. anything with a method such as "http" in front of it) Apache will send a redirect to the client to tell it where to find the document, even if the document ends up being on the same server.. This has several implications, the most important being that if you use an "ErrorDocument 401" directive then it must refer to a local document. This results from the nature of the HTTP basic authentication scheme. See Also: documentation of customizable responses. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ErrorDocument Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ErrorDocument Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ErrorLog DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ErrorLog Description Syntax: ErrorLog >filename|syslog[:facility] Default: ErrorLog logs/error_log Context: server config, virtual host Status: core The error log directive sets the name of the file to which the server will log any errors it encounters. If the filename does not begin with a slash (/) then it is assumed to be relative to the ServerRoot. If the filename begins with a pipe (|) then it is assumed to be a command to spawn to handle the error log. Apache 1.3 and above: Using syslog instead of a filename enables logging via syslogd(8) if the system supports it. The default is to use syslog facility local7, but you can override this by using the syslog:facility syntax where facility can be one of the names usually documented in syslog(1). SECURITY: See the security tips document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server. See also: LogLevel DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ErrorLog Default REG_SZ logs/error_log DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ErrorLog Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Example DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Example Description REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Example Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Example Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExpiresActive DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExpiresActive Description Syntax: ExpiresActive boolean Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Extension Module: mod_expires This directive enables or disables the generation of the Expires header for the document realm in question. (That is, if found in an .htaccess file, for instance, it applies only to documents generated from that directory.) If set to Off, no Expires header will be generated for any document in the realm (unless overridden at a lower level, such as an .htaccess file overriding a server config file). If set to On, the header will be added to served documents according to the criteria defined by the ExpiresByType and ExpiresDefault directives (q.v.). Note that this directive does not guarantee that an Expires header will be generated. If the criteria aren't met, no header will be sent, and the effect will be as though this directive wasn't even specified. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExpiresActive Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExpiresActive Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExpiresByType DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExpiresByType Description Syntax: ExpiresByType MIME-type <code>seconds Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Extension Module: mod_expires This directive defines the value of the Expires header generated for documents of the specified type (e.g., text/html). The second argument sets the number of seconds that will be added to a base time to construct the expiration date. The base time is either the last modification time of the file, or the time of the client's access to the document. Which should be used is specified by the <code> field; M means that the file's last modification time should be used as the base time, and A means the client's access time should be used. The difference in effect is subtle. If M is used, all current copies of the document in all caches will expire at the same time, which can be good for something like a weekly notice that's always found at the same URL. If A is used, the date of expiration is different for each client; this can be good for image files that don't change very often, particularly for a set of related documents that all refer to the same images (i.e., the images will be accessed repeatedly within a relatively short timespan). Example: ExpiresActive On # enable expirations ExpiresByType image/gif A2592000 # expire GIF images after a month # in the client's cache ExpiresByType text/html M604800 # HTML documents are good for a # week from the time they were # changed, period Note that this directive only has effect if ExpiresActive On has been specified. It overrides, for the specified MIME type only, any expiration date set by the ExpiresDefault directive. You can also specify the expiration time calculation using an alternate syntax, described later in this document. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExpiresByType Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExpiresByType Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExpiresDefault DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExpiresDefault Description Syntax: ExpiresDefault <code>seconds Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Extension Module: mod_expires This directive sets the default algorithm for calculating the expiration time for all documents in the affected realm. It can be overridden on a type-by-type basis by the ExpiresByType directive. See the description of that directive for details about the syntax of the argument, and the alternate syntax description as well. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExpiresDefault Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExpiresDefault Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExtendedStatus DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExtendedStatus Description Syntax: ExtendedStatus On|Off Default: ExtendedStatus Off Context: server config Status: Base Module: mod_status Compatibility: ExtendedStatus is only available in Apache 1.3.2 and later. This directive controls whether the server keeps track of extended status information for each request. This is only useful if the status module is enabled on the server. This setting applies to the entire server, and cannot be enabled or disabled on a virtualhost-by-virtualhost basis. Enabling Status Support To enable status reports only for browsers from the foo.com domain add this code to your access.conf configuration file <Location /server-status> SetHandler server-status order deny,allow deny from all allow from .foo.com </Location> You can now access server statistics by using a Web browser to access the page http://your.server.name/server-status Note that mod_status will only work when you are running Apache in standalone mode and not inetd mode. Automatic Updates You can get the status page to update itself automatically if you have a browser that supports "refresh". Access the page http://your.server.name/server-status?refresh=N to refresh the page every N seconds. Machine Readable Status File A machine-readable version of the status file is available by accessing the page http://your.server.name/server-status?auto. This is useful when automatically run, see the Perl program in the /support directory of Apache, log_server_status. It should be noted that if mod_status is compiled into the server, its handler capability is available in all configuration files, including per-directory files (e.g., .htaccess). This may have security-related ramifications for your site. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExtendedStatus Default REG_SZ Off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExtendedStatus Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\FancyIndexing DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\FancyIndexing Description Syntax: FancyIndexing boolean Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_autoindex The FancyIndexing directive sets the FancyIndexing option for a directory. Boolean can be on or off. The IndexOptions directive should be used in preference. Note that in versions of Apache prior to 1.3.2, the FancyIndexing and IndexOptions directives will override each other. You should use IndexOptions FancyIndexing in preference to the standalone FancyIndexing directive. As of Apache 1.3.2, a standalone FancyIndexing directive is combined with any IndexOptions directive already specified for the current scope. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\FancyIndexing Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\FancyIndexing Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Files DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Files Description Syntax: <Files filename> ... </Files> Context: server config, virtual host, .htaccess Status: core Compatibility: only available in Apache 1.2 and above. The <Files> directive provides for access control by filename. It is comparable to the <Directory> directive and <Location> directives. It should be matched with a </Files> directive. The directives given within this section will be applied to any object with a basename (last component of filename) matching the specified filename. <Files> sections are processed in the order they appear in the configuration file, after the <Directory> sections and .htaccess files are read, but before <Location> sections. Note that <Files> can be nested inside <Directory> sections to restrict the portion of the filesystem they apply to. The filename argument should include a filename, or a wild-card string, where `?' matches any single character, and `*' matches any sequences of characters. Extended regular expressions can also be used, with the addition of the ~ character. For example: <Files ~ "\.(gif|jpe?g|png)$"> would match most common Internet graphics formats. In Apache 1.3 and later, <FilesMatch> is preferred, however. Note that unlike <Directory> and <Location> sections, <Files> sections can be used inside .htaccess files. This allows users to control access to their own files, at a file-by-file level. See also: How Directory, Location and Files sections work for an explanation of how these different sections are combined when a request is received DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Files Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Files Parent REG_DWORD 1 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\FilesMatch DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\FilesMatch Description Syntax: <FilesMatch regex> ... </FilesMatch> Context: server config, virtual host, .htaccess Status: core Compatibility: only available in Apache 1.3 and above. The <FilesMatch> directive provides for access control by filename, just as the <Files> directive does. However, it accepts a regular expression. For example: <FilesMatch "\.(gif|jpe?g|png)$"> would match most common Internet graphics formats. See also: How Directory, Location and Files sections work for an explanation of how these different sections are combined when a request is received DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\FilesMatch Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\FilesMatch Parent REG_DWORD 1 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ForceType DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ForceType Description Syntax: ForceType media type Context: directory, .htaccess Status: Base Module: mod_mime Compatibility: ForceType is only available in Apache 1.1 and later. When placed into an .htaccess file or a <Directory> or <Location> section, this directive forces all matching files to be served as the content type given by media type. For example, if you had a directory full of GIF files, but did not want to label them all with ".gif", you might want to use: ForceType image/gif Note that this will override any filename extensions that might determine the media type. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ForceType Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ForceType Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Group DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Group Description Syntax: Group unix-group Default: Group #-1 Context: server config, virtual host Status: core The Group directive sets the group under which the server will answer requests. In order to use this directive, the stand-alone server must be run initially as root. Unix-group is one of: A group name Refers to the given group by name. # followed by a group number. Refers to a group by its number. It is recommended that you set up a new group specifically for running the server. Some admins use user nobody, but this is not always possible or desirable. Note: if you start the server as a non-root user, it will fail to change to the specified group, and will instead continue to run as the group of the original user. Special note: Use of this directive in <VirtualHost> requires a properly configured suEXEC wrapper. When used inside a <VirtualHost> in this manner, only the group that CGIs are run as is affected. Non-CGI requests are still processed as the group specified in the main Group directive. SECURITY: See User for a discussion of the security considerations. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Group Default REG_SZ #-1 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Group Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Header DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Header Description Syntax: Header [ set | append | add ] header value Syntax: Header unset header Context: server config, virtual host, access.conf, .htaccess Status: optional Module: mod_header This directive can replace, merge or remove HTTP response headers. The action it performs is determined by the first argument. This can be one of the following values: * set The response header is set, replacing any previous header with this name * append The response header is appended to any existing header of the same name. When a new value is merged onto an existing header it is separated from the existing header with a comma. This is the HTTP standard way of giving a header multiple values. * add The response header is added to the existing set of headers, even if this header already exists. This can result in two (or more) headers having the same name. This can lead to unforeseen consequences, and in general "append" should be used instead. * unset The response header of this name is removed, if it exists. If there are multiple headers of the same name, only the first one set will be removed. This argument is followed by a header name, which can include the final colon, but it is not required. Case is ignored. For add, append and set a value is given as the third argument. If this value contains spaces, it should be surrounded by double quotes. For unset, no value should be given. Order of Processing The Header directive can occur almost anywhere within the server configuration. It is valid in the main server config and virtual host sections, inside <Directory>, <Location> and <Files> sections, and within .htaccess files. The Header directives are processed in the following order: 1. main server 2. virtual host 3. <Directory> sections and .htaccess 4. <Location> 5. <Files> Order is important. These two headers have a different effect if reversed: Header append Author "John P. Doe" Header unset Author This way round, the Author header is not set. If reversed, the Author header is set to "John P. Doe". The Header directives are processed just before the response is sent by its handler. These means that some headers that are added just before the response is sent cannot be unset or overridden. This includes headers such as "Date" and "Server". DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Header Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Header Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\HeaderName DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\HeaderName Description Syntax: HeaderName filename Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_autoindex The HeaderName directive sets the name of the file that will be inserted at the top of the index listing. Filename is the name of the file to include, and is taken to be relative to the directory being indexed. The server first attempts to include filename.html as an HTML document, otherwise it will include filename as plain text. Example: HeaderName HEADER when indexing the directory /web, the server will first look for the HTML file /web/HEADER.html and include it if found, otherwise it will include the plain text file /web/HEADER, if it exists. See also ReadmeName. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\HeaderName Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\HeaderName Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\HostNameLookups DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\HostNameLookups Description Syntax: HostNameLookups on | off | double Default: HostNameLookups off Context: server config, virtual host, directory Status: core Compatibility: double available only in Apache 1.3 and above. Compatibility: Default was on prior to Apache 1.3. This directive enables DNS lookups so that host names can be logged (and passed to CGIs/SSIs in REMOTE_HOST). The value double refers to doing double-reverse DNS. That is, after a reverse lookup is performed, a forward lookup is then performed on that result. At least one of the ip addresses in the forward lookup must match the original address. (In "tcpwrappers" terminology this is called PARANOID.) Regardless of the setting, when mod_access is used for controlling access by hostname, a double reverse lookup will be performed. This is necessary for security. Note that the result of this double-reverse isn't generally available unless you set HostnameLookups double. For example, if only HostnameLookups on and a request is made to an object that is protected by hostname restrictions, regardless of whether the double-reverse fails or not, CGIs will still be passed the single-reverse result in REMOTE_HOST. The default for this directive was previously on in versions of Apache prior to 1.3. It was changed to off in order to save the network traffic for those sites that don't truly need the reverse lookups done. It is also better for the end users because they don't have to suffer the extra latency that a lookup entails. Heavily loaded sites should leave this directive off, since DNS lookups can take considerable amounts of time. The utility logresolve, provided in the /support directory, can be used to look up host names from logged IP addresses offline. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\HostNameLookups Default REG_SZ off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\HostNameLookups Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\httpd.conf DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\httpd.conf Description This is the main server configuration file. See URL http://www.apache.org/ for instructions.s. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\httpd.conf Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\httpd.conf Parent REG_DWORD 2 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IdentityCheck DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IdentityCheck Description Syntax: IdentityCheck boolean Default: IdentityCheck off Context: server config, virtual host, directory Status: core This directive enables RFC1413-compliant logging of the remote user name for each connection, where the client machine runs identd or something similar. This information is logged in the access log. Boolean is either on or off. The information should not be trusted in any way except for rudimentary usage tracking. Note that this can cause serious latency problems accessing your server since every request requires one of these lookups to be performed. When firewalls are involved each lookup might possibly fail and add 30 seconds of latency to each hit. So in general this is not very useful on public servers accessible from the Internet. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IdentityCheck Default REG_SZ off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IdentityCheck Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IfDefine DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IfDefine Description Syntax: <IfDefine [!]parameter-name> ... </IfDefine> Default: None Context: all Status: Core Compatibility: <IfDefine> is only available in 1.3.1 and later. The <IfDefine test>...</IfDefine> section is used to mark directives that are conditional. The directives within an IfDefine section are only processed if the test is true. If test is false, everything between the start and end markers is ignored. The test in the <IfDefine> section directive can be one of two forms: * parameter-name * !parameter-name In the former case, the directives between the start and end markers are only processed if the parameter named parameter-name is defined. The second format reverses the test, and only processes the directives if parameter-name is not defined. The parameter-name argument is a define as given on the httpd command line via -Dparameter-, at the time the server was started. <IfDefine> sections are nest-able, which can be used to implement simple multiple-parameter tests. Example: $ httpd -DReverseProxy ... # httpd.conf <IfDefine ReverseProxy> LoadModule rewrite_module libexec/mod_rewrite.so LoadModule proxy_module libexec/libproxy.so </IfDefine> DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IfDefine Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IfDefine Parent REG_DWORD 1 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IfModule DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IfModule Description Syntax: <IfModule [!]module-name> ... </IfModule> Default: None Context: all Status: Core Compatibility: IfModule is only available in 1.2 and later. The <IfModule test>...</IfModule> section is used to mark directives that are conditional. The directives within an IfModule section are only processed if the test is true. If test is false, everything between the start and end markers is ignored. The test in the <IfModule> section directive can be one of two forms: * module name * !module name In the former case, the directives between the start and end markers are only processed if the module named module name is compiled in to Apache. The second format reverses the test, and only processes the directives if module name is not compiled in. The module name argument is a module name as given as the file name of the module, at the time it was compiled. For example, mod_rewrite.c. <IfModule> sections are nest-able, which can be used to implement simple multiple-module tests. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IfModule Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IfModule Parent REG_DWORD 1 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Imagemap DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Imagemap Description The lines in the imagemap files can have one of several formats: directive value [x,y ...] directive value "Menu text" [x,y ...] directive value x,y ... "Menu text" The directive is one of base, default, poly, circle, rect, or point. The value is an absolute or relative URL, or one of the special values listed below. The coordinates are x,y pairs separated by whitespace. The quoted text is used as the text of the link if a imagemap menu is generated. Lines beginning with '#' are comments. Imagemap File Directives There are six directives allowed in the imagemap file. The directives can come in any order, but are processed in the order they are found in the imagemap file. base Directive Has the effect of <BASE HREF="value">. The non-absolute URLs of the map-file are taken relative to this value. The base directive overrides ImapBase as set in a .htaccess file or in the server configuration files. In the absence of an ImapBase configuration directive, base defaults to http://server_name/. base_uri is synonymous with base. Note that a trailing slash on the URL is significant. default Directive The action taken if the coordinates given do not fit any of the poly, circle or rect directives, and there are no point directives. Defaults to nocontent in the absence of an ImapDefault configuration setting, causing a status code of 204 No Content to be returned. The client should keep the same page displayed. poly Directive Takes three to one-hundred points, and is obeyed if the user selected coordinates fall within the polygon defined by these points. circle Takes the center coordinates of a circle and a point on the circle. Is obeyed if the user selected point is with the circle. rect Directive Takes the coordinates of two opposing corners of a rectangle. Obeyed if the point selected is within this rectangle. point Directive Takes a single point. The point directive closest to the user selected point is obeyed if no other directives are satisfied. Note that default will not be followed if a point directive is present and valid coordinates are given. Values The values for each of the directives can any of the following: a URL The URL can be relative or absolute URL. Relative URLs can contain '..' syntax and will be resolved relative to the base value. base itself will not resolved according to the current value. A statement base mailto: will work properly, though. map Equivalent to the URL of the imagemap file itself. No coordinates are sent with this, so a menu will be generated unless ImapMenu is set to 'none'. menu Synonymous with map. referer Equivalent to the URL of the referring document. Defaults to http://servername/ if no Referer: header was present. nocontent Sends a status code of 204 No Content, telling the client to keep the same page displayed. Valid for all but base. error Fails with a 500 Server Error. Valid for all but base, but sort of silly for anything but default. Coordinates 0,0 200,200 A coordinate consists of an x and a y value separated by a comma. The coordinates are separated from each other by whitespace. To accommodate the way Lynx handles imagemaps, should a user select the coordinate 0,0, it is as if no coordinate had been selected. Quoted Text "Menu Text" After the value or after the coordinates, the line optionally may contain text within double quotes. This string is used as the text for the link if a menu is generated: <a HREF="http://foo.com/">Menu text</a> If no quoted text is present, the name of the link will be used as the text: <a HREF="http://foo.com/">http://foo.com</a> It is impossible to escape double quotes within this text. . DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Imagemap Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Imagemap Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Include DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Include Description Syntax: Include filename Context: server config Status: Core Compatibility: Include is only available in Apache 1.3 and later. This directive allows inclusion of other configuration files from within the server configuration files. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Include Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Include Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IndexIgnore DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IndexIgnore Description Syntax: IndexIgnore file file ... Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_autoindex The IndexIgnore directive adds to the list of files to hide when listing a directory. File is a file extension, partial filename, wildcard expression or full filename for files to ignore. Multiple IndexIgnore directives add to the list, rather than the replacing the list of ignored files. By default, the list contains `.'. Example: IndexIgnore README .htaccess *~ DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IndexIgnore Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IndexIgnore Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IndexOptions DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IndexOptions Description Syntax: IndexOptions option option ... (Apache 1.3.2 and earlier) Syntax: IndexOptions [+|-]option [+|-]option ... (Apache 1.3.3 and later) Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_autoindex Compatibility: '+/-' syntax and merging of multiple IndexOptions directives is only available with Apache 1.3.3 and later The IndexOptions directive specifies the behavior of the directory indexing. Option can be one of FancyIndexing This turns on fancy indexing of directories. Note that in versions of Apache prior to 1.3.2, the FancyIndexing and IndexOptions directives will override each other. You should use IndexOptions FancyIndexing in preference to the standalone FancyIndexing directive. As of Apache 1.3.2, a standalone FancyIndexing directive is combined with any IndexOptions directive already specified for the current scope. IconHeight[=pixels] (Apache 1.3 and later) Presence of this option, when used with IconWidth, will cause the server to include HEIGHT and WIDTH attributes in the IMG tag for the file icon. This allows browser to precalculate the page layout without having to wait until all the images have been loaded. If no value is given for the option, it defaults to the standard height of the icons supplied with the Apache software. IconsAreLinks This makes the icons part of the anchor for the filename, for fancy indexing. IconWidth[=pixels] (Apache 1.3 and later) Presence of this option, when used with IconHeight, will cause the server to include HEIGHT and WIDTH attributes in the IMG tag for the file icon. This allows browser to precalculate the page layout without having to wait until all the images have been loaded. If no value is given for the option, it defaults to the standard width of the icons supplied with the Apache software. NameWidth=[n | *] (Apache 1.3.2 and later) The NameWidth keyword allows you to specify the width of the filename column in bytes. If the keyword value is '*', then the column is automatically sized to the length of the longest filename in the display. ScanHTMLTitles This enables the extraction of the title from HTML documents for fancy indexing. If the file does not have a description given by AddDescription then httpd will read the document for the value of the TITLE tag. This is CPU and disk intensive. SuppressColumnSorting If specified, Apache will not make the column headings in a FancyIndexed directory listing into links for sorting. The default behaviour is for them to be links; selecting the column heading will sort the directory listing by the values in that column. Only available in Apache 1.3 and later. SuppressDescription This will suppress the file description in fancy indexing listings. SuppressHTMLPreamble If the directory actually contains a file specified by the HeaderName directive, the module usually includes the contents of the file after a standard HTML preamble (<HTML>, <HEAD>, et cetera). The SuppressHTMLPreamble option disables this behaviour, causing the module to start the display with the header file contents. The header file must contain appropriate HTML instructions in this case. If there is no header file, the preamble is generated as usual. SuppressLastModified This will suppress the display of the last modification date, in fancy indexing listings. SuppressSize This will suppress the file size in fancy indexing listings. There are some noticeable differences in the behaviour of this directive in recent (post-1.3.0) versions of Apache. Apache 1.3.2 and earlier: The default is that no options are enabled. If multiple IndexOptions could apply to a directory, then the most specific one is taken complete; the options are not merged. For example: <Directory /web/docs> IndexOptions FancyIndexing </Directory> <Directory /web/docs/spec> IndexOptions ScanHTMLTitles </Directory> then only ScanHTMLTitles will be set for the /web/docs/spec directory. Apache 1.3.3 and later: Apache 1.3.3 introduced some significant changes in the handling of IndexOptions directives. In particular, * Multiple IndexOptions directives for a single directory are now merged together. The result of the example above will now be the equivalent of IndexOptions FancyIndexing ScanHTMLTitles. * The addition of the incremental syntax (i.e., prefixing keywords with '+' or '-'). Whenever a '+' or '-' prefixed keyword is encountered, it is applied to the current IndexOptions settings (which may have been inherited from an upper-level directory). However, whenever an unprefixed keyword is processed, it clears all inherited options and any incremental settings encountered so far. Consider the following example: IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing IndexOptions +SuppressSize The net effect is equivalent to IndexOptions FancyIndexing +SuppressSize, because the unprefixed FancyIndexing discarded the incremental keywords before it, but allowed them to start accumulating again afterward. To unconditionally set the IndexOptions for a particular directory, clearing the inherited settings, specify keywords without either '+' or '-' prefixes. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IndexOptions Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IndexOptions Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\KeepAlive DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\KeepAlive Description Syntax: (Apache 1.1) KeepAlive max-requests Default: (Apache 1.1) KeepAlive 5 Syntax: (Apache 1.2) KeepAlive on/off Default: (Apache 1.2) KeepAlive On Context: server config Status: Core Compatibility: KeepAlive is only available in Apache 1.1 and later. This directive enables Keep-Alive support. Apache 1.1: Set max-requests to the maximum number of requests you want Apache to entertain per request. A limit is imposed to prevent a client from hogging your server resources. Set this to 0 to disable support. Apache 1.2 and later: Set to "On" to enable persistent connections, "Off" to disable. See also the MaxKeepAliveRequests directive. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\KeepAlive Default REG_SZ 1.2) KeepAlive On DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\KeepAlive Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\KeepAliveTimeout DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\KeepAliveTimeout Description Syntax: KeepAliveTimeout seconds Default: KeepAliveTimeout 15 Context: server config Status: Core Compatibility: KeepAliveTimeout is only available in Apache 1.1 and later. The number of seconds Apache will wait for a subsequent request before closing the connection. Once a request has been received, the timeout value specified by the Timeout directive applies. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\KeepAliveTimeout Default REG_SZ 15 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\KeepAliveTimeout Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LanguagePriority DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LanguagePriority Description Syntax: LanguagePriority MIME-lang MIME-lang... Context: server config, virtual host, directory, .htaccess Override: FileInfo Status: Base Module: mod_negotiation The LanguagePriority sets the precedence of language variants for the case where the client does not express a preference, when handling a MultiViews request. The list of MIME-lang are in order of decreasing preference. Example: LanguagePriority en fr de For a request for foo.html, where foo.html.fr and foo.html.de both existed, but the browser did not express a language preference, then foo.html.fr would be returned. Note that this directive only has an effect if a 'best' language cannot be determined by other any other means. Correctly implemented HTTP/1.1 requests will mean this directive has no effect. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LanguagePriority Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LanguagePriority Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Limit DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Limit Description Syntax: <Limit method method ... > ... </Limit> Context: any Status: core <Limit> and </Limit> are used to enclose a group of access control directives which will then apply only to the specified access methods, where method is any valid HTTP method. Any directive except another <Limit> or <Directory> may be used; the majority will be unaffected by the <Limit>. Example: <Limit GET POST> require valid-user </Limit> If an access control directive appears outside a <Limit> directive, then it applies to all access methods. The method names listed can be one or more of: GET, POST, PUT, DELETE, CONNECT or OPTIONS. The method name is case-sensitive. If GET is used it will also restrict HEAD requests. If you wish to limit all methods, do not include any <Limit> directive at all. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Limit Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Limit Parent REG_DWORD 1 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestBody DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestBody Description Syntax: LimitRequestBody number Default: LimitRequestBody 0 Context: server config, virtual host, directory, .htaccess Status: core Compatibility: LimitRequestBody is only available in Apache 1.3.2 and later. Number is a long integer from 0 (meaning unlimited) to 2147483647 (2GB). The default value is defined by the compile-time constant DEFAULT_LIMIT_REQUEST_BODY (0 as distributed). The LimitRequestBody directive allows the user to set a limit on the allowed size of an HTTP request message body within the context in which the directive is given (server, per-directory, per-file or per-location). If the client request exceeds that limit, the server will return an error response instead of servicing the request. The size of a normal request message body will vary greatly depending on the nature of the resource and the methods allowed on that resource. CGI scripts typically use the message body for passing form information to the server. Implementations of the PUT method will require a value at least as large as any representation that the server wishes to accept for that resource. This directive gives the server administrator greater control over abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestBody Default REG_SZ 0 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestBody Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestFields DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestFields Description Syntax: LimitRequestFields number Default: LimitRequestFields 100 Context: server config Status: core Compatibility: LimitRequestFields is only available in Apache 1.3.2 and later. Number is an integer from 0 (meaning unlimited) to 32767. The default value is defined by the compile-time constant DEFAULT_LIMIT_REQUEST_FIELDS (100 as distributed). The LimitRequestFields directive allows the server administrator to modify the limit on the number of request header fields allowed in an HTTP request. A server needs this value to be larger than the number of fields that a normal client request might include. The number of request header fields used by a client rarely exceeds 20, but this may vary among different client implementations, often depending upon the extent to which a user has configured their browser to support detailed content negotiation. Optional HTTP extensions are often expressed using request header fields. This directive gives the server administrator greater control over abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks. The value should be increased if normal clients see an error response from the server that indicates too many fields were sent in the request. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestFields Default REG_SZ 100 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestFields Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestFieldsize DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestFieldsize Description Syntax: LimitRequestFieldsize number Default: LimitRequestFieldsize 8190 Context: server config Status: core Compatibility: LimitRequestFieldsize is only available in Apache 1.3.2 and later. Number is an integer size in bytes from 0 to the value of the compile-time constant DEFAULT_LIMIT_REQUEST_FIELDSIZE (8190 as distributed). The LimitRequestFieldsize directive allows the server administrator to reduce the limit on the allowed size of an HTTP request header field below the normal input buffer size compiled with the server. A server needs this value to be large enough to hold any one header field from a normal client request. The size of a normal request header field will vary greatly among different client implementations, often depending upon the extent to which a user has configured their browser to support detailed content negotiation. This directive gives the server administrator greater control over abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks. Under normal conditions, the value should not be changed from the default. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestFieldsize Default REG_SZ 8190 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestFieldsize Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestLine DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestLine Description Syntax: LimitRequestLine number Default: LimitRequestLine 8190 Context: server config Status: core Compatibility: LimitRequestLine is only available in Apache 1.3.2 and later. Number is an integer size in bytes from 0 to the value of the compile-time constant DEFAULT_LIMIT_REQUEST_LINE (8190 as distributed). The LimitRequestLine directive allows the server administrator to reduce the limit on the allowed size of a client's HTTP request-line below the normal input buffer size compiled with the server. Since the request-line consists of the HTTP method, URI, and protocol version, the LimitRequestLine directive places a restriction on the length of a request-URI allowed for a request on the server. A server needs this value to be large enough to hold any of its resource names, including any information that might be passed in the query part of a GET request. This directive gives the server administrator greater control over abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks. Under normal conditions, the value should not be changed from the default. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestLine Default REG_SZ 8190 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LimitRequestLine Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Listen DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Listen Description Syntax: Listen [IP address:]port number Context: server config Status: core Compatibility: Listen is only available in Apache 1.1 and later. The Listen directive instructs Apache to listen to more than one IP address or port; by default it responds to requests on all IP interfaces, but only on the port given by the Port directive. Listen can be used instead of BindAddress and Port. It tells the server to accept incoming requests on the specified port or address-and-port combination. If the first format is used, with a port number only, the server listens to the given port on all interfaces, instead of the port given by the Port directive. If an IP address is given as well as a port, the server will listen on the given port and interface. Note that you may still require a Port directive so that URLs that Apache generates that point to your server still work. Multiple Listen directives may be used to specify a number of addresses and ports to listen to. The server will respond to requests from any of the listed addresses and ports. For example, to make the server accept connections on both port 80 and port 8000, use: Listen 80 Listen 8000 To make the server accept connections on two specified interfaces and port numbers, use Listen 192.170.2.1:80 Listen 192.170.2.5:8000 See Also: DNS Issues See Also: Setting which addresses and ports Apache uses See Also: Known Bugs DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Listen Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Listen Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ListenBacklog DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ListenBacklog Description Syntax: ListenBacklog backlog Default: ListenBacklog 511 Context: server config Status: Core Compatibility: ListenBacklog is only available in Apache versions after 1.2.0. The maximum length of the queue of pending connections. Generally no tuning is needed or desired, however on some systems it is desirable to increase this when under a TCP SYN flood attack. See the backlog parameter to the listen(2) system call. This will often be limited to a smaller number by the operating system. This varies from OS to OS. Also note that many OSes do not use exactly what is specified as the backlog, but use a number based on (but normally larger than) what is set. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ListenBacklog Default REG_SZ 511 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ListenBacklog Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LoadFile DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LoadFile Description Syntax: LoadFile filename filename ... Context: server config Status: Experimental Module: mod_so The LoadFile directive links in the named object files or libraries when the server is started or restarted; this is used to load additional code which may be required for some module to work. Filename is either and absolute path or relative to ServerRoot. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LoadFile Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LoadFile Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LoadModule DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LoadModule Description Syntax: LoadModule module filename Context: server config Status: Experimental Module: mod_so The LoadModule directive links in the object file or library filename and adds the module structure named module to the list of active modules. Module is the name of the external variable of type module in the file. Example (Unix): LoadModule status_module modules/mod_status.so Example (Windows): LoadModule status_module modules/ApacheModuleStatus.dll loads the named module from the modules subdirectory of the ServerRoot. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LoadModule Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LoadModule Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Location DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Location Description Syntax: <Location URL> ... </Location> Context: server config, virtual host Status: core Compatibility: Location is only available in Apache 1.1 and later. The <Location> directive provides for access control by URL. It is similar to the <Directory> directive, and starts a subsection which is terminated with a </Location> directive. <Location> sections are processed in the order they appear in the configuration file, after the <Directory> sections and .htaccess files are read, and after the <Files> sections. Note that URLs do not have to line up with the filesystem at all, it should be emphasized that <Location> operates completely outside the filesystem. For all origin (non-proxy) requests, the URL to be matched is of the form /path/, and you should not include any http://servername prefix. For proxy requests, the URL to be matched is of the form scheme://servername/path, and you must include the prefix. The URL may use wildcards In a wild-card string, `?' matches any single character, and `*' matches any sequences of characters. Apache 1.2 and above: Extended regular expressions can also be used, with the addition of the ~ character. For example: <Location ~ "/(extra|special)/data"> would match URLs that contained the substring "/extra/data" or "/special/data". In Apache 1.3 and above, a new directive <LocationMatch> exists which behaves identical to the regex version of <Location>. The Location functionality is especially useful when combined with the SetHandler directive. For example, to enable status requests, but allow them only from browsers at foo.com, you might use: <Location /status> SetHandler server-status order deny,allow deny from all allow from .foo.com </Location> Apache 1.3 and above note about / (slash): The slash character has special meaning depending on where in a URL it appears. People may be used to its behaviour in the filesystem where multiple adjacent slashes are frequently collapsed to a single slash (i.e., /home///foo is the same as /home/foo). In URL-space this is not necessarily true. The <LocationMatch> directive and the regex version of <Location> require you to explicitly specify multiple slashes if that is your intention. For example, <LocationMatch ^/abc> would match the request URL /abc but not the request URL //abc. The (non-regex) <Location> directive behaves similarly when used for proxy requests. But when (non-regex) <Location> is used for non-proxy requests it will implicitly match multiple slashes with a single slash. For example, if you specify <Location /abc/def> and the request is to /abc//def then it will match. See also: How Directory, Location and Files sections work for an explanation of how these different sections are combined when a request is received DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Location Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Location Parent REG_DWORD 1 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LocationMatch DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LocationMatch Description Syntax: <LocationMatch regex> ... </LocationMatch> Context: server config, virtual host Status: core Compatibility: LocationMatch is only available in Apache 1.3 and later. The <LocationMatch> directive provides for access control by URL, in an identical manner to <Location>. However, it takes a regular expression as an argument instead of a simple string. For example: <LocationMatch "/(extra|special)/data"> would match URLs that contained the substring "/extra/data" or "/special/data". See also: How Directory, Location and Files sections work for an explanation of how these different sections are combined when a request is received DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LocationMatch Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LocationMatch Parent REG_DWORD 1 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LockFile DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LockFile Description Syntax: LockFile filename Default: LockFile logs/accept.lock Context: server config Status: core The LockFile directive sets the path to the lockfile used when Apache is compiled with either USE_FCNTL_SERIALIZED_ACCEPT or USE_FLOCK_SERIALIZED_ACCEPT. This directive should normally be left at its default value. The main reason for changing it is if the logs directory is NFS mounted, since the lockfile must be stored on a local disk. The PID of the main server process is automatically appended to the filename. SECURITY: It is best to avoid putting this file in a world writable directory such as /var/tmp because someone could create a denial of service attack and prevent the server from starting by creating a lockfile with the same name as the one the server will try to create. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LockFile Default REG_SZ logs/accept.lock DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LockFile Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LogFormat DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LogFormat Description Syntax: LogFormat format [nickname] Default: LogFormat "%h %l %u %t \"%r\" %s %b" Context: server config, virtual host Status: Base Compatibility: Nickname only available in Apache 1.3 or later Module: mod_log_config This sets the format of the default logfile named by the TransferLog directive . See the section on Custom Log Formats for details on the format arguments. If you include a nickname for the format on the directive line, you can use it in other LogFormat and CustomLog directives rather than repeating the entire format string. A LogFormat directive which defines a nickname does nothing else -- that is, it only defines the nickname, it doesn't actually apply the format and make it the default. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LogFormat Default REG_SZ "%h %l %u %t \"%r\" %s %b" DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LogFormat Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LogLevel DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LogLevel Description Syntax: LogLevel level Default: LogLevel error Context: server config, virtual host Status: core Compatibility: LogLevel is only available in 1.3 or later. LogLevel adjusts the verbosity of the messages recorded in the error logs (see ErrorLog directive). The following levels are available, in order of decreasing significance: Level Description Example emerg Emergencies - system is unusable. "Child cannot open lock file. Exiting" alert Action must be taken immediately. "getpwuid: couldn't determine user name from uid" crit Critical Conditions. "socket: Failed to get a socket, exiting child" error Error conditions. "Premature end of script headers" warn Warning conditions. "child process 1234 did not exit, sending another SIGHUP" noticeNormal but significant condition. "httpd: caught SIGBUS, attempting to dump core in ..." info Informational. "Server seems busy, (you may need to increase StartServers, or Min/MaxSpareServers)..." debug Debug-level messages "Opening config file ..." When a particular level is specified, messages from all other levels of higher significance will be reported as well. E.g., when LogLevel info is specified, then messages with log levels of notice and warn will also be posted. Using a level of at least crit is recommended. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LogLevel Default REG_SZ error DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\LogLevel Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxClients DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxClients Description Syntax: MaxClients number Default: MaxClients 256 Context: server config Status: core The MaxClients directive sets the limit on the number of simultaneous requests that can be supported; not more than this number of child server processes will be created. To configure more than 256 clients, you must edit the HARD_SERVER_LIMIT entry in httpd.h and recompile. Any connection attempts over the MaxClients limit will normally be queued, up to a number based on the ListenBacklog directive. Once a child process is freed at the end of a different request, the connection will then be serviced. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxClients Default REG_SZ 256 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxClients Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxKeepAliveRequests DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxKeepAliveRequests Description Syntax: MaxKeepAliveRequests number Default: MaxKeepAliveRequests 100 Context: server config Status: core Compatibility: Only available in Apache 1.2 and later. The MaxKeepAliveRequests directive limits the number of requests allowed per connection when KeepAlive is on. If it is set to "0", unlimited requests will be allowed. We recommend that this setting be kept to a high value for maximum server performance. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxKeepAliveRequests Default REG_SZ 100 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxKeepAliveRequests Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxRequestsPerChild DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxRequestsPerChild Description Syntax: MaxRequestsPerChild number Default: MaxRequestsPerChild 0 Context: server config Status: core The MaxRequestsPerChild directive sets the limit on the number of requests that an individual child server process will handle. After MaxRequestsPerChild requests, the child process will die. If MaxRequestsPerChild is 0, then the process will never expire. Setting MaxRequestsPerChild to a non-zero limit has two beneficial effects: * it limits the amount of memory that process can consume by (accidental) memory leakage; * by giving processes a finite lifetime, it helps reduce the number of processes when the server load reduces. This directive has no effect on Win32. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxRequestsPerChild Default REG_SZ 0 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxRequestsPerChild Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxSpareServers DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxSpareServers Description Syntax: MaxSpareServers number Default: MaxSpareServers 10 Context: server config Status: core The MaxSpareServers directive sets the desired maximum number of idle child server processes. An idle process is one which is not handling a request. If there are more than MaxSpareServers idle, then the parent process will kill off the excess processes. Tuning of this parameter should only be necessary on very busy sites. Setting this parameter to a large number is almost always a bad idea. This directive has no effect when used with the Apache Web server on a Microsoft Windows platform. See also MinSpareServers and StartServers. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxSpareServers Default REG_SZ 10 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxSpareServers Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MetaDir DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MetaDir Description Syntax: MetaDir directory name Default: MetaDir .web Context: (Apache prior to 1.3) server config Context: (Apache 1.3) per-directory config Status: Base Module: mod_cern_meta Compatibility: MetaDir is only available in Apache 1.1 and later. Specifies the name of the directory in which Apache can find meta information files. The directory is usually a 'hidden' subdirectory of the directory that contains the file being accessed. Set to "." to look in the same directory as the file. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MetaDir Default REG_SZ .web DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MetaDir Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MetaFiles DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MetaFiles Description Syntax: MetaFiles on/off Default: MetaFiles off Context: per-directory config Status: Base Module: mod_cern_meta Compatibility: MetaFiles is only available in Apache 1.3 and later. Turns on/off Meta file processing on a per-directory basis. This option was introduced in Apache 1.3. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MetaFiles Default REG_SZ off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MetaFiles Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MetaSuffix DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MetaSuffix Description Syntax: MetaSuffix suffix Default: MetaSuffix .meta Context: (Apache prior to 1.3) server config Context: (Apache 1.3) per-directory config Status: Base Module: mod_cern_meta Compatibility: MetaSuffix is only available in Apache 1.1 and later. Specifies the file name suffix for the file containing the meta information. For example, the default values for the two directives will cause a request to DOCUMENT_ROOT/somedir/index.html to look in DOCUMENT_ROOT/somedir/.web/index.html.meta and will use its contents to generate additional MIME header information. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MetaSuffix Default REG_SZ .meta DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MetaSuffix Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MimeMagicFile DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MimeMagicFile Description Syntax: MimeMagicFile magic-file-name Default: none Context: server config, virtual host Status: Extension Module: mod_mime_magic The MimeMagicFile directive can be used to enable this module, the default file is distributed at conf/magic. Non-rooted paths are relative to the ServerRoot. Virtual hosts will use the same file as the main server unless a more specific setting is used, in which case the more specific setting overrides the main server's file. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MimeMagicFile Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MimeMagicFile Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MinSpareServers DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MinSpareServers Description Syntax: MinSpareServers number Default: MinSpareServers 5 Context: server config Status: core The MinSpareServers directive sets the desired minimum number of idle child server processes. An idle process is one which is not handling a request. If there are fewer than MinSpareServers idle, then the parent process creates new children at a maximum rate of 1 per second. Tuning of this parameter should only be necessary on very busy sites. Setting this parameter to a large number is almost always a bad idea. This directive has no effect on Microsoft Windows. See also MaxSpareServers and StartServers. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MinSpareServers Default REG_SZ 5 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MinSpareServers Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MMapFile DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MMapFile Description Syntax: MMapFile filename ... Default: None Context: server-config Override: Not applicable Status: Experimental Module: mod_mmap_static Compatibility: Only available in Apache 1.3 or later The MMapFile directive maps one or more files (given as whitespace separated arguments) into memory at server startup time. They are automatically unmapped on a server shutdown. When the files have changed on the filesystem at least a HUP or USR1 signal should be send to the server to re-mmap them. Be careful with the filename arguments: They have to literally match the filesystem path Apache's URL-to-filename translation handlers create. We cannot compare inodes or other stuff to match paths through symbolic links etc. because that again would cost extra stat() system calls which is not acceptable. This module may or may not work with filenames rewritten by mod_alias or mod_rewrite... it is an experiment after all. Notice: You cannot use this for speeding up CGI programs or other files which are served by special content handlers. It can only be used for regular files which are usually served by the Apache core content handler. Example: MMapFile /usr/local/apache/htdocs/index.html Note: don't bother asking for a for a MMapDir directive which recursively maps all the files in a directory. Use Unix the way it was meant to be used. For example, see the Include directive, and consider this command: find /www/htdocs -type f -print \ | sed -e 's/.*/mmapfile &/' > /www/conf/mmap.conf DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MMapFile Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MMapFile Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\NameVirtualHost DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\NameVirtualHost Description Syntax: NameVirtualHost addr[:port] Context: server config Status: core Compatibility: NameVirtualHost is only available in Apache 1.3 and later The NameVirtualHost directive is a required directive if you want to configure name-based virtual hosts. Although addr can be hostname it is recommended that you always use an IP address, e.g. NameVirtualHost 111.22.33.44 With the NameVirtualHost directive you specify the address to which your name-based virtual host names resolve. If you have multiple name-based hosts on multiple addresses, repeat the directive for each address. Note: the "main server" and any _default_ servers will never be served for a request to a NameVirtualHost IP Address (unless for some reason you specify NameVirtualHost but then don't define any VirtualHosts for that address). Optionally you can specify a port number on which the name-based virtual hosts should be used, e.g. NameVirtualHost 111.22.33.44:8080 See also: Apache Virtual Host documentation DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\NameVirtualHost Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\NameVirtualHost Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\NoCache DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\NoCache Description Syntax: NoCache <word/host/domain list> Default: None Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: NoCache is only available in Apache 1.1 and later. The NoCache directive specifies a list of words, hosts and/or domains, separated by spaces. HTTP and non-passworded FTP documents from matched words, hosts or domains are not cached by the proxy server. The proxy module will also attempt to determine IP addresses of list items which may be hostnames during startup, and cache them for match test as well. Example: NoCache joes-garage.com some-host.co.uk bullwinkle.wotsamattau.edu 'bullwinkle.wotsamattau.edu' would also be matched if referenced by IP address. Note that 'wotsamattau' would also be sufficient to match 'wotsamattau.edu'. Note also that NoCache * disables caching completely. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\NoCache Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\NoCache Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\NoProxy DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\NoProxy Description Syntax: NoProxy { <Domain> | <SubNet> | <IpAddr> | <Hostname> } Default: None Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: NoProxy is only available in Apache 1.3 and later. This directive is only useful for Apache proxy servers within intranets. The NoProxy directive specifies a list of subnets, IP addresses, hosts and/or domains, separated by spaces. A request to a host which matches one or more of these is always served directly, without forwarding to the configured ProxyRemote proxy server(s). Example: ProxyRemote * http://firewall.mycompany.com:81 NoProxy .mycompany.com 192.168.112.0/21 The arguments to the NoProxy directive are one of the following type list: Domain A Domain is a partially qualified DNS domain name, preceded by a period. It represents a list of hosts which logically belong to the same DNS domain or zone (i.e., the suffixes of the hostnames are all ending in Domain). Examples: .com .apache.org. To distinguish Domains from Hostnames (both syntactically and semantically; a DNS domain can have a DNS A record, too!), Domains are always written with a leading period. Note: Domain name comparisons are done without regard to the case, and Domains are always assumed to be anchored in the root of the DNS tree, therefore two domains .MyDomain.com and .mydomain.com. (note the trailing period) are considered equal. Since a domain comparison does not involve a DNS lookup, it is much more efficient than subnet comparison. SubNet A SubNet is a partially qualified internet address in numeric (dotted quad) form, optionally followed by a slash and the netmask, specified as the number of significant bits in the SubNet. It is used to represent a subnet of hosts which can be reached over a common network interface. In the absence of the explicit net mask it is assumed that omitted (or zero valued) trailing digits specify the mask. (In this case, the netmask can only be multiples of 8 bits wide.) Examples: 192.168 or 192.168.0.0 the subnet 192.168.0.0 with an implied netmask of 16 valid bits (sometimes used in the netmask form 255.255.0.0) 192.168.112.0/21 the subnet 192.168.112.0/21 with a netmask of 21 valid bits (also used in the form 255.255.248.0) As a degenerate case, a SubNet with 32 valid bits is the equivalent to an IPAddr, while a SubNet with zero valid bits (e.g., 0.0.0.0/0) is the same as the constant _Default_, matching any IP address. IPAddr A IPAddr represents a fully qualified internet address in numeric (dotted quad) form. Usually, this address represents a host, but there need not necessarily be a DNS domain name connected with the address. Example: 192.168.123.7 Note: An IPAddr does not need to be resolved by the DNS system, so it can result in more effective apache performance. See Also: DNS Issues Hostname A Hostname is a fully qualified DNS domain name which can be resolved to one or more IPAddrs via the DNS domain name service. It represents a logical host (in contrast to Domains, see above) and must be resolvable to at least one IPAddr (or often to a list of hosts with different IPAddr's). Examples: prep.ai.mit.edu www.apache.org. Note: In many situations, it is more effective to specify an IPAddr in place of a Hostname since a DNS lookup can be avoided. Name resolution in Apache can take a remarkable deal of time when the connection to the name server uses a slow PPP link. Note: Hostname comparisons are done without regard to the case, and Hostnames are always assumed to be anchored in the root of the DNS tree, therefore two hosts WWW.MyDomain.com and www.mydomain.com. (note the trailing period) are considered equal. See Also: DNS Issues DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\NoProxy Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\NoProxy Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Options DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Options Description Syntax: Options [+|-]option [+|-]option ... Context: server config, virtual host, directory, .htaccess Override: Options Status: core The Options directive controls which server features are available in a particular directory. option can be set to None, in which case none of the extra features are enabled, or one or more of the following: All All options except for MultiViews. This is the default setting. ExecCGI Execution of CGI scripts is permitted. FollowSymLinks The server will follow symbolic links in this directory. Note: even though the server follows the symlink it does not change the pathname used to match against <Directory> sections. Note: this option gets ignored if set inside a <Location> section. Includes Server-side includes are permitted. IncludesNOEXEC Server-side includes are permitted, but the #exec command and #include of CGI scripts are disabled. Indexes If a URL which maps to a directory is requested, and the there is no DirectoryIndex (e.g., index.html) in that directory, then the server will return a formatted listing of the directory. MultiViews Content negotiated MultiViews are allowed. SymLinksIfOwnerMatch The server will only follow symbolic links for which the target file or directory is owned by the same user id as the link. Note: this option gets ignored if set inside a <Location> section. Normally, if multiple Options could apply to a directory, then the most specific one is taken complete; the options are not merged. However if all the options on the Options directive are preceded by a + or - symbol, the options are merged. Any options preceded by a + are added to the options currently in force, and any options preceded by a - are removed from the options currently in force. For example, without any + and - symbols: <Directory /web/docs> Options Indexes FollowSymLinks </Directory> <Directory /web/docs/spec> Options Includes </Directory> then only Includes will be set for the /web/docs/spec directory. However if the second Options directive uses the + and - symbols: <Directory /web/docs> Options Indexes FollowSymLinks </Directory> <Directory /web/docs/spec> Options +Includes -Indexes </Directory> then the options FollowSymLinks and Includes are set for the /web/docs/spec directory. Note: Using -IncludesNOEXEC or -Includes disables server-side includes completely regardless of the previous setting. The default in the absence of any other settings is All. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Options Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Options Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\order DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\order Description Syntax: order ordering Default: order deny,allow Context: directory, .htaccess Override: Limit Status: Base Module: mod_access The order directive controls the order in which allow and deny directives are evaluated. Ordering is one of deny,allow the deny directives are evaluated before the allow directives. (The initial state is OK.) allow,deny the allow directives are evaluated before the deny directives. (The initial state is FORBIDDEN.) mutual-failure Only those hosts which appear on the allow list and do not appear on the deny list are granted access. (The initial state is irrelevant.) Note that in all cases every allow and deny statement is evaluated, there is no "short-circuiting". Example: order deny,allow deny from all allow from .ncsa.uiuc.edu Hosts in the ncsa.uiuc.edu domain are allowed access; all other hosts are denied access. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\order Default REG_SZ deny,allow DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\order Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\PassEnv DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\PassEnv Description Syntax: PassEnv variable variable ... Context: server config, virtual host Status: Base Module: mod_env Compatibility: PassEnv is only available in Apache 1.1 and later. Specifies one or more environment variables to pass to CGI scripts from the server's own environment. Example: PassEnv LD_LIBRARY_PATH DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\PassEnv Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\PassEnv Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\PidFile DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\PidFile Description Syntax: PidFile filename Default: PidFile logs/httpd.pid Context: server config Status: core The PidFile directive sets the file to which the server records the process id of the daemon. If the filename does not begin with a slash (/) then it is assumed to be relative to the ServerRoot. The PidFile is only used in standalone mode. It is often useful to be able to send the server a signal, so that it closes and then reopens its ErrorLog and TransferLog, and re-reads its configuration files. This is done by sending a SIGHUP (kill -1) signal to the process id listed in the PidFile. The PidFile is subject to the same warnings about log file placement and security. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\PidFile Default REG_SZ logs/httpd.pid DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\PidFile Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Port DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Port Description Syntax: Port number Default: Port 80 Context: server config Status: core Number is a number from 0 to 65535; some port numbers (especially below 1024) are reserved for particular protocols. See /etc/services for a list of some defined ports; the standard port for the http protocol is 80. The Port directive has two behaviors, the first of which is necessary for NCSA backwards compatibility (and which is confusing in the context of Apache). * In the absence of any Listen or BindAddress directives specifying a port number, a Port directive given in the "main server" (i.e., outside any <VirtualHost> section) sets the network port on which the server listens. If there are any Listen or BindAddress directives specifying :number then Port has no effect on what address the server listens at. * The Port directive sets the SERVER_PORT environment variable (for CGI and SSI), and is used when the server must generate a URL that refers to itself (for example when creating an external redirect to itself). This behaviour is modified by UseCanonicalName. In no event does a Port setting affect what ports a VirtualHost responds on, the VirtualHost directive itself is used for that. The primary behaviour of Port should be considered to be similar to that of the ServerName directive. The ServerName and Port together specify what you consider to be the canonical address of the server. (See also UseCanonicalName.) Port 80 is one of Unix's special ports. All ports numbered below 1024 are reserved for system use, i.e., regular (non-root) users cannot make use of them; instead they can only use higher port numbers. To use port 80, you must start the server from the root account. After binding to the port and before accepting requests, Apache will change to a low privileged user as set by the User directive. If you cannot use port 80, choose any other unused port. Non-root users will have to choose a port number higher than 1023, such as 8000. SECURITY: if you do start the server as root, be sure not to set User to root. If you run the server as root whilst handling connections, your site may be open to a major security attack. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Port Default REG_SZ 80 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Port Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyBlock DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyBlock Description Syntax: ProxyBlock <word/host/domain list> Default: None Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: ProxyBlock is only available in Apache 1.2 and later. The ProxyBlock directive specifies a list of words, hosts and/or domains, separated by spaces. HTTP, HTTPS, and FTP document requests to matched words, hosts or domains are blocked by the proxy server. The proxy module will also attempt to determine IP addresses of list items which may be hostnames during startup, and cache them for match test as well. Example: ProxyBlock joes-garage.com some-host.co.uk rocky.wotsamattau.edu 'rocky.wotsamattau.edu' would also be matched if referenced by IP address. Note that 'wotsamattau' would also be sufficient to match 'wotsamattau.edu'. Note also that ProxyBlock * blocks connections to all sites. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyBlock Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyBlock Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyDomain DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyDomain Description Syntax: ProxyDomain <Domain> Default: None Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: ProxyDomain is only available in Apache 1.3 and later. This directive is only useful for Apache proxy servers within intranets. The ProxyDomain directive specifies the default domain which the apache proxy server will belong to. If a request to a host without a domain name is encountered, a redirection response to the same host with the configured Domain appended will be generated. Example: ProxyRemote * http://firewall.mycompany.com:81 NoProxy .mycompany.com 192.168.112.0/21 ProxyDomain .mycompany.com DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyDomain Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyDomain Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyPass DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyPass Description Syntax: ProxyPass <path> <url> Default: None Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: ProxyPass is only available in Apache 1.1 and later. This directive allows remote servers to be mapped into the space of the local server; the local server does not act as a proxy in the conventional sense, but appears to be a mirror of the remote server. <path> is the name of a local virtual path; <url> is a partial URL for the remote server. Suppose the local server has address http://wibble.org/; then ProxyPass /mirror/foo/ http://foo.com/ will cause a local request for the <http://wibble.org/mirror/foo/bar> to be internally converted into a proxy request to <http://foo.com/bar>. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyPass Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyPass Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyPassReverse DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyPassReverse Description Syntax: ProxyPassReverse <path> <url> Default: None Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: ProxyPassReverse is only available in Apache 1.3b6 and later. This directive lets Apache adjust the URL in the Location header on HTTP redirect responses. For instance this is essential when Apache is used as a reverse proxy to avoid by-passing the reverse proxy because of HTTP redirects on the backend servers which stay behind the reverse proxy. <path> is the name of a local virtual path. <url> is a partial URL for the remote server - the same way they are used for the ProxyPass directive. Example: Suppose the local server has address http://wibble.org/; then ProxyPass /mirror/foo/ http://foo.com/ ProxyPassReverse /mirror/foo/ http://foo.com/ will not only cause a local request for the <http://wibble.org/mirror/foo/bar> to be internally converted into a proxy request to <http://foo.com/bar> (the functionality ProxyPass provides here). It also takes care of redirects the server foo.com sends: when http://foo.com/bar is redirected by him to http://foo.com/quux Apache adjusts this to http://wibble.org/mirror/foo/quux before forwarding the HTTP redirect response to the client. Note that this ProxyPassReverse directive can also by used in conjunction with the proxy pass-through feature ("RewriteRule ... [P]") from mod_rewrite because its doesn't depend on a corresponding ProxyPass directive. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyPassReverse Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyPassReverse Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyReceiveBufferSize DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyReceiveBufferSize Description Syntax: ProxyReceiveBufferSize <bytes> Default: None Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: ProxyReceiveBufferSize is only available in Apache 1.3 and later. The ProxyReceiveBufferSize directive specifies an explicit network buffer size for outgoing HTTP and FTP connections, for increased throughput. It has to be greater than 512 or set to 0 to indicate that the system's default buffer size should be used. Example: ProxyReceiveBufferSize 2048 DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyReceiveBufferSize Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyReceiveBufferSize Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyRemote DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyRemote Description Syntax: ProxyRemote <match> <remote-server> Default: None Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: ProxyRemote is only available in Apache 1.1 and later. This defines remote proxies to this proxy. <match> is either the name of a URL-scheme that the remote server supports, or a partial URL for which the remote server should be used, or '*' to indicate the server should be contacted for all requests. <remote-server> is a partial URL for the remote server. Syntax: <remote-server> = <protocol>://<hostname>[:port] <protocol> is the protocol that should be used to communicate with the remote server; only "http" is supported by this module. Example: ProxyRemote http://goodguys.com/ http://mirrorguys.com:8000 ProxyRemote * http://cleversite.com ProxyRemote ftp http://ftpproxy.mydomain.com:8080 In the last example, the proxy will forward FTP requests, encapsulated as yet another HTTP proxy request, to another proxy which can handle them. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyRemote Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyRemote Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyRequests DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyRequests Description Syntax: ProxyRequests on/off Default: ProxyRequests Off Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: ProxyRequests is only available in Apache 1.1 and later. This allows or prevents Apache from functioning as a proxy server. Setting ProxyRequests to 'off' does not disable use of the ProxyPass directive. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyRequests Default REG_SZ Off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyRequests Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyVia DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyVia Description Syntax: ProxyVia { off | on | full | block } Default: ProxyVia off Context: server config, virtual host Override: Not applicable Status: Base Module: mod_proxy Compatibility: ProxyVia is only available in Apache 1.3.2 and later. This directive controls the use of the Via: HTTP header by the proxy. Its intended use is to control the flow of of proxy requests along a chain of proxy servers. See RFC2068 (HTTP/1.1) for an explanation of Via: header lines. * If set to off, which is the default, no special processing is performed. If a request or reply contains a Via: header, it is passed through unchanged. * If set to on, each request and reply will get a Via: header line added for the current host. * If set to full, each generated Via: header line will additionally have the Apache server version shown as a Via: comment field. * If set to block, every proxy request will have all its Via: header lines removed. No new Via: header will be generated. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyVia Default REG_SZ off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyVia Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ReadmeName DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ReadmeName Description Syntax: ReadmeName filename Context: server config, virtual host, directory, .htaccess Override: Indexes Status: Base Module: mod_autoindex The ReadmeName directive sets the name of the file that will be appended to the end of the index listing. Filename is the name of the file to include, and is taken to be relative to the directory being indexed. The server first attempts to include filename.html as an HTML document, otherwise it will include filename as plain text. Example: ReadmeName README when indexing the directory /web, the server will first look for the HTML file /web/README.html and include it if found, otherwise it will include the plain text file /web/README, if it exists. See also HeaderName. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ReadmeName Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ReadmeName Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Redirect DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Redirect Description Syntax: Redirect [ status ] url-path url Context: server config, virtual host, directory, .htaccess Status: Base Module: mod_alias Compatibility: The directory and .htaccess context's are only available in versions 1.1 and later. The status argument is only available in Apache 1.2 or later. The Redirect directive maps an old URL into a new one. The new URL is returned to the client which attempts to fetch it again with the new address. Url-path a (%-decoded) path; any requests for documents beginning with this path will be returned a redirect error to a new (%-encoded) url beginning with url. Example: Redirect /service http://foo2.bar.com/service If the client requests http://myserver/service/foo.txt, it will be told to access http://foo2.bar.com/service/foo.txt instead. Note: Redirect directives take precedence over Alias and ScriptAlias directives, irrespective of their ordering in the configuration file. Also, Url-path must be an absolute path, not a relative path, even when used with .htaccess files or inside of <Directory> sections. If no status argument is given, the redirect will be "temporary" (HTTP status 302). This indicates to the client that the resources is has moved temporarily. The status argument can be used to return other HTTP status codes: permanent Returns a permanent redirect status (301) indicating that the resource has moved permanently. temp Returns a temporary redirect status (302). This is the default. seeother Returns a "See Other" status (303) indicating that the resource has been replaced. gone Returns a "Gone" status (410) indicating that the resource has been permanently removed. When this status is used the url argument should be omitted. Other status codes can be returned by giving the numeric status code as the value of status. If the status is between 300 and 399, the url argument must be present, otherwise it must be omitted. Note that the status must be known to the Apache code (see the function send_error_response in http_protocol.c). DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Redirect Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Redirect Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RedirectMatch DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RedirectMatch Description Syntax: RedirectMatch [status] regex url Context: server config, virtual host Status: Base Module: mod_alias Compatibility: Available in Apache 1.3 and later This directive is equivalent to Redirect, but makes use of standard regular expressions, instead of simple prefix matching. The supplied regular expression is matched against the URL, and if it matches, the server will substitute any parenthesized matches into the given string and use it as a filename. For example, to redirect all GIF files to like-named JPEG files on another server, one might use: RedirectMatch (.*)\.gif$ http://www.anotherserver.com$1.jpg DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RedirectMatch Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RedirectMatch Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RedirectPermanent DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RedirectPermanent Description Syntax: RedirectPermanent url-path url Context: server config, virtual host, directory, .htaccess Status: Base Module: mod_alias Compatibility: This directive is only available in 1.2 This directive makes the client know that the Redirect is permanent (status 301). Exactly equivalent to Redirect permanent. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RedirectPermanent Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RedirectPermanent Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RedirectTemp DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RedirectTemp Description Syntax: RedirectTemp url-path url Context: server config, virtual host, directory, .htaccess Status: Base Module: mod_alias Compatibility: This directive is only available in 1.2 This directive makes the client know that the Redirect is only temporary (status 302). Exactly equivalent to Redirect temporary. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RedirectTemp Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RedirectTemp Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RefererIgnore DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RefererIgnore Description Syntax: RefererIgnore string string ... Context: server config, virtual host Status: Extension Module: mod_log_referer The RefererIgnore directive adds to the list of strings to ignore in Referer headers. If any of the strings in the list is contained in the Referer header, then no referrer information will be logged for the request. Example: RefererIgnore www.ncsa.uiuc.edu This avoids logging references from www.ncsa.uiuc.edu. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RefererIgnore Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RefererIgnore Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RefererLog DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RefererLog Description Syntax: RefererLog file-pipe Default: RefererLog logs/referer_log Context: server config, virtual host Status: Extension Module: mod_log_referer The RefererLog directive sets the name of the file to which the server will log the Referer header of incoming requests. File-pipe is one of A filename A filename relative to the ServerRoot. `|' followed by a command A program to receive the referrer log information on its standard input. Note the a new program will not be started for a VirtualHost if it inherits the RefererLog from the main server. Security: if a program is used, then it will be run under the user who started httpd. This will be root if the server was started by root; be sure that the program is secure. Security: See the security tips document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server. This directive is provided for compatibility with NCSA 1.4. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RefererLog Default REG_SZ logs/referer_log DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RefererLog Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\require DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\require Description Syntax: require entity-name entity entity... Context: directory, .htaccess Override: AuthConfig Status: core This directive selects which authenticated users can access a directory. The allowed syntaxes are: * require user userid userid ... Only the named users can access the directory. * require group group-name group-name ... Only users in the named groups can access the directory. require valid-user * All valid users can access the directory. If require appears in a <Limit> section, then it restricts access to the named methods, otherwise it restricts access for all methods. Example: AuthType Basic AuthName somedomain AuthUserFile /web/users AuthGroupFile /web/groups <Limit GET POST> require group admin </Limit> Require must be accompanied by AuthName and AuthType directives, and directives such as AuthUserFile and AuthGroupFile (to define users and groups) in order to work correctly. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\require Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\require Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ResourceConfig DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ResourceConfig Description Syntax: ResourceConfig filename Default: ResourceConfig conf/srm.conf Context: server config, virtual host Status: core The server will read this file for more directives after reading the httpd.conf file. Filename is relative to the ServerRoot. This feature can be disabled using: ResourceConfig /dev/null Historically, this file contained most directives except for server configuration directives and <Directory> sections; in fact it can now contain any server directive allowed in the server config context. See also AccessConfig. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ResourceConfig Default REG_SZ conf/srm.conf DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ResourceConfig Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteBase DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteBase Description Syntax: RewriteBase BaseURL Default: default is the physical directory path Context: directory, .htaccess Override: FileInfo Status: Extension Module: mod_rewrite.c Compatibility: Apache 1.2 The RewriteBase directive explicitly sets the base URL for per-directory rewrites. As you will see below, RewriteRule can be used in per-directory config files (.htaccess). There it will act locally, i.e., the local directory prefix is stripped at this stage of processing and your rewriting rules act only on the remainder. At the end it is automatically added. When a substitution occurs for a new URL, this module has to re-inject the URL into the server processing. To be able to do this it needs to know what the corresponding URL-prefix or URL-base is. By default this prefix is the corresponding filepath itself. But at most websites URLs are NOT directly related to physical filename paths, so this assumption will be usually be wrong! There you have to use the RewriteBase directive to specify the correct URL-prefix. Notice: If your webserver's URLs are not directly related to physical file paths, you have to use RewriteBase in every .htaccess files where you want to use RewriteRule directives. Example: Assume the following per-directory config file: # # /abc/def/.htaccess -- per-dir config file for directory /abc/def # Remember: /abc/def is the physical path of /xyz, i.e., the server # has a 'Alias /xyz /abc/def' directive e.g. # RewriteEngine On # let the server know that we are reached via /xyz and not # via the physical path prefix /abc/def RewriteBase /xyz # now the rewriting rules RewriteRule ^oldstuff\.html$ newstuff.html In the above example, a request to /xyz/oldstuff.html gets correctly rewritten to the physical file /abc/def/newstuff.html. Notice - For the Apache hackers: The following list gives detailed information about the internal processing steps: Request: /xyz/oldstuff.html Internal Processing: /xyz/oldstuff.html -> /abc/def/oldstuff.html (per-server Alias) /abc/def/oldstuff.html -> /abc/def/newstuff.html (per-dir RewriteRule) /abc/def/newstuff.html -> /xyz/newstuff.html (per-dir RewriteBase) /xyz/newstuff.html -> /abc/def/newstuff.html (per-server Alias) Result: /abc/def/newstuff.html This seems very complicated but is the correct Apache internal processing, because the per-directory rewriting comes too late in the process. So, when it occurs the (rewritten) request has to be re-injected into the Apache kernel! BUT: While this seems like a serious overhead, it really isn't, because this re-injection happens fully internal to the Apache server and the same procedure is used by many other operations inside Apache. So, you can be sure the design and implementation is correct. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteBase Default REG_SZ is the physical directory path DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteBase Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteCond DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteCond Description Syntax: RewriteCond TestString CondPattern Default: None Context: server config, virtual host, directory, .htaccess Override: FileInfo Status: Extension Module: mod_rewrite.c Compatibility: Apache 1.2 (partially), Apache 1.3 The RewriteCond directive defines a rule condition. Precede a RewriteRule directive with one or more RewriteCond directives. The following rewriting rule is only used if its pattern matches the current state of the URI and if these additional conditions apply too. TestString is a string which can contains the following expanded constructs in addition to plain text: * RewriteRule backreferences: These are backreferences of the form $N (1 <= N <= 9) which provide access to the grouped parts (parenthesis!) of the pattern from the corresponding RewriteRule directive (the one following the current bunch of RewriteCond directives). * RewriteCond backreferences: These are backreferences of the form %N (1 <= N <= 9) which provide access to the grouped parts (parenthesis!) of the pattern from the last matched RewriteCond directive in the current bunch of conditions. * Server-Variables: These are variables of the form %{ NAME_OF_VARIABLE } where NAME_OF_VARIABLE can be a string of the following list: HTTP headers: connection & request: HTTP_USER_AGENT REMOTE_ADDR HTTP_REFERER REMOTE_HOST HTTP_COOKIE REMOTE_USER HTTP_FORWARDED REMOTE_IDENT HTTP_HOST REQUEST_METHOD HTTP_PROXY_CONNECTION SCRIPT_FILENAME HTTP_ACCEPT PATH_INFO QUERY_STRING AUTH_TYPE server internals: system stuff: specials: DOCUMENT_ROOT TIME_YEAR API_VERSION SERVER_ADMIN TIME_MON THE_REQUEST SERVER_NAME TIME_DAY REQUEST_URI SERVER_PORT TIME_HOUR REQUEST_FILENAME SERVER_PROTOCOL TIME_MIN IS_SUBREQ SERVER_SOFTWARE TIME_SEC TIME_WDAY TIME Notice: These variables all correspond to the similar named HTTP MIME-headers, C variables of the Apache server or struct tm fields of the Unix system. pecial Notes: 1. The variables SCRIPT_FILENAME and REQUEST_FILENAME contain the same value, i.e., the value of the filename field of the internal request_rec structure of the Apache server. The first name is just the commonly known CGI variable name while the second is the consistent counterpart to REQUEST_URI (which contains the value of the uri field of request_rec). 2. There is the special format: %{ENV:variable} where variable can be any environment variable. This is looked-up via internal Apache structures and (if not found there) via getenv() from the Apache server process. 3. There is the special format: %{HTTP:header} where header can be any HTTP MIME-header name. This is looked-up from the HTTP request. Example: %{HTTP:Proxy-Connection} is the value of the HTTP header ``Proxy-Connection:''. 4. There is the special format %{LA-U:variable} for look-aheads which perform an internal (URL-based) sub-request to determine the final value of variable. Use this when you want to use a variable for rewriting which actually is set later in an API phase and thus is not available at the current stage. For instance when you want to rewrite according to the REMOTE_USER variable from within the per-server context (httpd.conf file) you have to use %{LA-U:REMOTE_USER} because this variable is set by the authorization phases which come after the URL translation phase where mod_rewrite operates. On the other hand, because mod_rewrite implements its per-directory context (.htaccess file) via the Fixup phase of the API and because the authorization phases come before this phase, you just can use %{REMOTE_USER} there. 5. There is the special format: %{LA-F:variable} which perform an internal (filename-based) sub-request to determine the final value of variable. This is the most of the time the same as LA-U above. CondPattern is the condition pattern, i.e., a regular expression which gets applied to the current instance of the TestString, i.e., TestString gets evaluated and then matched against CondPattern. Remember: CondPattern is a standard Extended Regular Expression with some additions: 1. You can precede the pattern string with a '!' character (exclamation mark) to specify a non-matching pattern. 2. There are some special variants of CondPatterns. Instead of real regular expression strings you can also use one of the following: * '<CondPattern' (is lexicographically lower) Treats the CondPattern as a plain string and compares it lexicographically to TestString and results in a true expression if TestString is lexicographically lower than CondPattern. * '>CondPattern' (is lexicographically greater) Treats the CondPattern as a plain string and compares it lexicographically to TestString and results in a true expression if TestString is lexicographically greater than CondPattern. * '=CondPattern' (is lexicographically equal) Treats the CondPattern as a plain string and compares it lexicographically to TestString and results in a true expression if TestString is lexicographically equal to CondPattern, i.e the two strings are exactly equal (character by character). If CondPattern is just "" (two quotation marks) this compares TestString against the empty string. * '-d' (is directory) Treats the TestString as a pathname and tests if it exists and is a directory. * '-f' (is regular file) Treats the TestString as a pathname and tests if it exists and is a regular file. * '-s' (is regular file with size) Treats the TestString as a pathname and tests if it exists and is a regular file with size greater than zero. * '-l' (is symbolic link) Treats the TestString as a pathname and tests if it exists and is a symbolic link. * '-F' (is existing file via subrequest) Checks if TestString is a valid file and accessible via all the server's currently-configured access controls for that path. This uses an internal subrequest to determine the check, so use it with care because it decreases your servers performance! * '-U' (is existing URL via subrequest) Checks if TestString is a valid URL and accessible via all the server's currently-configured access controls for that path. This uses an internal subrequest to determine the check, so use it with care because it decreases your server's performance! Notice: All of these tests can also be prefixed by a not ('!') character to negate their meaning. Additionally you can set special flags for CondPattern by appending [flags] as the third argument to the RewriteCond directive. Flags is a comma-separated list of the following flags: * 'nocase|NC' (no case) This makes the condition test case-insensitive, i.e., there is no difference between 'A-Z' and 'a-z' both in the expanded TestString and the CondPattern. * 'ornext|OR' (or next condition) Use this to combine rule conditions with a local OR instead of the implicit AND. Typical example: RewriteCond %{REMOTE_HOST} ^host1.* [OR] RewriteCond %{REMOTE_HOST} ^host2.* [OR] RewriteCond %{REMOTE_HOST} ^host3.* RewriteRule ...some special stuff for any of these hosts... Without this flag you had to write down the cond/rule three times. Example: To rewrite the Homepage of a site according to the ``User-Agent:'' header of the request, you can use the following: RewriteCond %{HTTP_USER_AGENT} ^Mozilla.* RewriteRule ^/$ /homepage.max.html [L] RewriteCond %{HTTP_USER_AGENT} ^Lynx.* RewriteRule ^/$ /homepage.min.html [L] RewriteRule ^/$ /homepage.std.html [L] Interpretation: If you use Netscape Navigator as your browser (which identifies itself as 'Mozilla'), then you get the max homepage, which includes Frames, etc. If you use the Lynx browser (which is Terminal-based), then you get the min homepage, which contains no images, no tables, etc. If you use any other browser you get the standard homepage. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteCond Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteCond Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteEngine DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteEngine Description Syntax: RewriteEngine {on,off} Default: RewriteEngine off Context: server config, virtual host, directory, .htaccess Override: FileInfo Status: Extension Module: mod_rewrite.c Compatibility: Apache 1.2 The RewriteEngine directive enables or disables the runtime rewriting engine. If it is set to off this module does no runtime processing at all. It does not even update the SCRIPT_URx environment variables. Use this directive to disable the module instead of commenting out all RewriteRule directives! Note that, by default, rewrite configurations are not inherited. This means that you need to have a RewriteEngine on directive for each virtual host you wish to use it in. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteEngine Default REG_SZ off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteEngine Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteLock DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteLock Description Syntax: RewriteLock Filename Default: None Context: server config, virtual host Override: Not applicable Status: Extension Module: mod_rewrite.c Compatibility: Apache 1.3 This directive sets the filename for a synchronization lockfile which mod_rewrite needs to communicate with RewriteMap programs. Set this lockfile to a local path (not on a NFS-mounted device) when you want to use a rewriting map-program. It is not required for SAMP using all other types of rewriting maps. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteLock Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteLock Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteLog DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteLog Description Syntax: RewriteLog Filename Default: None Context: server config, virtual host Override: Not applicable Status: Extension Module: mod_rewrite.c Compatibility: Apache 1.2 The RewriteLog directive sets the name of the file to which the server logs any rewriting actions it performs. If the name does not begin with a slash ('/') then it is assumed to be relative to the Server Root. The directive should occur only once per server config. Notice: To disable the logging of rewriting actions it is not recommended to set Filename to /dev/null, because although the rewriting engine does not create output to a logfile it still creates the logfile output internally. This will slow down the server with no advantage to the administrator! To disable logging either remove or comment out the RewriteLog directive or use RewriteLogLevel 0! Security: See the Apache Security Tips document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server. Example: RewriteLog "/usr/local/var/apache/logs/rewrite.log" DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteLog Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteLog Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteLogLevel DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteLogLevel Description Syntax: RewriteLogLevel Level Default: RewriteLogLevel 0 Context: server config, virtual host Override: Not applicable Status: Extension Module: mod_rewrite.c Compatibility: Apache 1.2 The RewriteLogLevel directive set the verbosity level of the rewriting logfile. The default level 0 means no logging, while 9 or more means that practically all actions are logged. To disable the logging of rewriting actions simply set Level to 0. This disables all rewrite action logs. Notice: Using a high value for Level will slow down your Apache server dramatically! Use the rewriting logfile only for debugging or at least at Level not greater than 2! Example: RewriteLogLevel 3 DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteLogLevel Default REG_SZ 0 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteLogLevel Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteMap DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteMap Description Syntax: RewriteMap MapName MapType:MapSource Default: not used per default Context: server config, virtual host Override: Not applicable Status: Extension Module: mod_rewrite.c Compatibility: Apache 1.2 (partially), Apache 1.3 The RewriteMap directive defines a Rewriting Map which can be used inside rule substitution strings by the mapping-functions to insert/substitute fields through a key lookup. The source of this lookup can be of various types. The MapName is the name of the map and will be used to specify a mapping-function for the substitution strings of a rewriting rule via one of the following constructs: ${ MapName : LookupKey } ${ MapName : LookupKey | DefaultValue } When such a construct occurs the map MapName is consulted and the key LookupKey is looked-up. If the key is found, the map-function construct is substituted by SubstValue. If the key is not found then it is substituted by DefaultValue or the empty string if no DefaultValue was specified. The following combinations for MapType and MapSource can be used: * Standard Plain Text MapType: txt, MapSource: Unix filesystem path to valid regular file This is the standard rewriting map feature where the MapSource is a plain ASCII file containing either blank lines, comment lines (starting with a '#' character) or pairs like the following - one per line. MatchingKey SubstValue Example: ## ## map.txt -- rewriting map ## Ralf.S.Engelschall rse # Bastard Operator From Hell Mr.Joe.Average joe # Mr. Average RewriteMap real-to-user txt:/path/to/file/map.txt * Randomized Plain Text MapType: rnd, MapSource: Unix filesystem path to valid regular file This is identical to the Standard Plain Text variant above but with a special post-processing feature: After looking up a value it is parsed according to contained ``|'' characters which have the meaning of ``or''. Or in other words: they indicate a set of alternatives from which the actual returned value is chosen randomly. Although this sounds crazy and useless, it was actually designed for load balancing in a reverse proxy situation where the looked up values are server names. Example: ## ## map.txt -- rewriting map ## static www1|www2|www3|www4 dynamic www5|www6 RewriteMap servers rnd:/path/to/file/map.txt * Hash File MapType: dbm, MapSource: Unix filesystem path to valid regular file Here the source is a binary NDBM format file containing the same contents as a Plain Text format file, but in a special representation which is optimized for really fast lookups. You can create such a file with any NDBM tool or with the following Perl script: #!/path/to/bin/perl ## ## txt2dbm -- convert txt map to dbm format ## ($txtmap, $dbmmap) = @ARGV; open(TXT, "<$txtmap"); dbmopen(%DB, $dbmmap, 0644); while (<TXT>) { next if (m|^s*#.*| or m|^s*$|); $DB{$1} = $2 if (m|^\s*(\S+)\s+(\S+)$|); } dbmclose(%DB); close(TXT) $ txt2dbm map.txt map.db Internal Function * MapType: int, MapSource: Internal Apache function Here the source is an internal Apache function. Currently you cannot create your own, but the following functions already exists: * toupper: Converts the looked up key to all upper case. * tolower: Converts the looked up key to all lower case. * External Rewriting Program MapType: prg, MapSource: Unix filesystem path to valid regular file Here the source is a Unix program, not a map file. To create it you can use the language of your choice, but the result has to be a run-able Unix executable (i.e., either object-code or a script with the magic cookie trick '#!/path/to/interpreter' as the first line). This program gets started once at startup of the Apache servers and then communicates with the rewriting engine over its stdin and stdout file-handles. For each map-function lookup it will receive the key to lookup as a newline-terminated string on stdin. It then has to give back the looked-up value as a newline-terminated string on stdout or the four-character string ``NULL'' if it fails (i.e., there is no corresponding value for the given key). A trivial program which will implement a 1:1 map (i.e., key == value) could be: #!/usr/bin/perl $| = 1; while (<STDIN>) { # ...here any transformations # or lookups should occur... print $_; } But be very careful: 1. ``Keep the program simple, stupid'' (KISS), because if this program hangs it will lead to a hang of the Apache server when the rule occurs. 2. Avoid one common mistake: never do buffered I/O on stdout! This will cause a deadloop! Hence the ``$|=1'' in the above example... 3. Use the RewriteLock directive to define a lockfile mod_rewrite can use to synchronize the communication to the program. Per default no such synchronization takes place. The RewriteMap directive can occur more than once. For each mapping-function use one RewriteMap directive to declare its rewriting mapfile. While you cannot declare a map in per-directory context it is of course possible to use this map in per-directory context. Notice: For plain text and DBM format files the looked-up keys are cached in-core until the mtime of the mapfile changes or the server does a restart. This way you can have map-functions in rules which are used for every request. This is no problem, because the external lookup only happens once! DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteMap Default REG_SZ used per default DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteMap Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteOptions DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteOptions Description Syntax: RewriteOptions Option Default: None Context: server config, virtual host, directory, .htaccess Override: FileInfo Status: Extension Module: mod_rewrite.c Compatibility: Apache 1.2 The RewriteOptions directive sets some special options for the current per-server or per-directory configuration. The Option strings can be one of the following: * 'inherit' This forces the current configuration to inherit the configuration of the parent. In per-virtual-server context this means that the maps, conditions and rules of the main server gets inherited. In per-directory context this means that conditions and rules of the parent directory's .htaccess configuration gets inherited. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteOptions Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteOptions Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RLimitCPU DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RLimitCPU Description Syntax: RLimitCPU # or 'max' [# or 'max'] Default: Unset; uses operating system defaults Context: server config, virtual host Status: core Compatibility: RLimitCPU is only available in Apache 1.2 and later Takes 1 or 2 parameters. The first parameter sets the soft resource limit for all processes and the second parameter sets the maximum resource limit. Either parameter can be a number, or max to indicate to the server that the limit should be set to the maximum allowed by the operating system configuration. Raising the maximum resource limit requires that the server is running as root, or in the initial startup phase. CPU resource limits are expressed in seconds per process. See also RLimitMEM or RLimitNPROC. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RLimitCPU Default REG_SZ uses operating system defaults DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RLimitCPU Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RLimitMEM DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RLimitMEM Description Syntax: RLimitMEM # or 'max' [# or 'max'] Default: Unset; uses operating system defaults Context: server config, virtual host Status: core Compatibility: RLimitMEM is only available in Apache 1.2 and later Takes 1 or 2 parameters. The first parameter sets the soft resource limit for all processes and the second parameter sets the maximum resource limit. Either parameter can be a number, or max to indicate to the server that the limit should be set to the maximum allowed by the operating system configuration. Raising the maximum resource limit requires that the server is running as root, or in the initial startup phase. Memory resource limits are expressed in bytes per process. See also RLimitCPU or RLimitNPROC. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RLimitMEM Default REG_SZ uses operating system defaults DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RLimitMEM Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RLimitNPROC DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RLimitNPROC Description Syntax: RLimitNPROC # or 'max' [# or 'max'] Default: Unset; uses operating system defaults Context: server config, virtual host Status: core Compatibility: RLimitNPROC is only available in Apache 1.2 and later Takes 1 or 2 parameters. The first parameter sets the soft resource limit for all processes and the second parameter sets the maximum resource limit. Either parameter can be a number, or max to indicate to the server that the limit should be set to the maximum allowed by the operating system configuration. Raising the maximum resource limit requires that the server is running as root, or in the initial startup phase. Process limits control the number of processes per user. Note: If CGI processes are not running under userids other than the web server userid, this directive will limit the number of processes that the server itself can create. Evidence of this situation will be indicated by cannot fork messages in the error_log. See also RLimitMEM or RLimitCPU. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RLimitNPROC Default REG_SZ uses operating system defaults DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RLimitNPROC Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Satisfy DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Satisfy Description Syntax: Satisfy 'any' or 'all' Default: Satisfy all Context: directory, .htaccess Status: core Compatibility: Satisfy is only available in Apache 1.2 and later Access policy if both allow and require used. The parameter can be either 'all' or 'any'. This directive is only useful if access to a particular area is being restricted by both username/password and client host address. In this case the default behavior ("all") is to require that the client passes the address access restriction and enters a valid username and password. With the "any" option the client will be granted access if they either pass the host restriction or enter a valid username and password. This can be used to password restrict an area, but to let clients from particular addresses in without prompting for a password. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Satisfy Default REG_SZ all DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Satisfy Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScoreBoardFile DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScoreBoardFile Description Syntax: ScoreBoardFile filename Default: ScoreBoardFile logs/apache_status Context: server config Status: core The ScoreBoardFile directive is required on some architectures to place a file that the server will use to communicate between its children and the parent. The easiest way to find out if your architecture requires a scoreboard file is to run Apache and see if it creates the file named by the directive. If your architecture requires it then you must ensure that this file is not used at the same time by more than one invocation of Apache. If you have to use a ScoreBoardFile then you may see improved speed by placing it on a RAM disk. But be careful that you heed the same warnings about log file placement and security. Apache 1.2 and above: Linux 1.x users might be able to add -DHAVE_SHMGET -DUSE_SHMGET_SCOREBOARD to the EXTRA_CFLAGS in your Configuration. This might work with some 1.x installations, but won't work with all of them. (Prior to 1.3b4, HAVE_SHMGET would have sufficed.) SVR4 users should consider adding -DHAVE_SHMGET -DUSE_SHMGET_SCOREBOARD to the EXTRA_CFLAGS in your Configuration. This is believed to work, but we were unable to test it in time for 1.2 release. (Prior to 1.3b4, HAVE_SHMGET would have sufficed.) See Also: Stopping and Restarting Apache DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScoreBoardFile Default REG_SZ logs/apache_status DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScoreBoardFile Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Script DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Script Description Syntax: Script method cgi-script Context: server config, virtual host, directory Status: Base Module: mod_actions Compatibility: Script is only available in Apache 1.1 and later This directive adds an action, which will activate cgi-script when a file is requested using the method of method, which can be one of GET, POST, PUT or DELETE. It sends the URL and file path of the requested document using the standard CGI PATH_INFO and PATH_TRANSLATED environment variables. Note that the Script command defines default actions only. If a CGI script is called, or some other resource that is capable of handling the requested method internally, it will do so. Also note that Script with a method of GET will only be called if there are query arguments present (e.g., foo.html?hi). Otherwise, the request will proceed normally. Examples: Script GET /cgi-bin/search #e.g. for <ISINDEX>-style searching Script PUT /~bob/put.cgi DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Script Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Script Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptAlias DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptAlias Description Syntax: ScriptAlias url-path directory-filename Context: server config, virtual host Status: Base Module: mod_alias The ScriptAlias directive has the same behavior as the Alias directive, except that in addition it marks the target directory as containing CGI scripts. URLs with a (%-decoded) path beginning with url-path will be mapped to scripts beginning with directory-filename. Example: ScriptAlias /cgi-bin/ /web/cgi-bin/ A request for http://myserver/cgi-bin/foo would cause the server to run the script /web/cgi-bin/foo. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptAlias Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptAlias Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptAliasMatch DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptAliasMatch Description Syntax: ScriptAliasMatch regex directory-filename Context: server config, virtual host Status: Base Module: mod_alias Compatibility: Available in Apache 1.3 and later This directive is equivalent to ScriptAlias, but makes use of standard regular expressions, instead of simple prefix matching. The supplied regular expression is matched against the URL, and if it matches, the server will substitute any parenthesized matches into the given string and use it as a filename. For example, to activate the standard /cgi-bin, one might use: ScriptAliasMatch ^/cgi-bin(.*) /usr/local/apache/cgi-bin$1 DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptAliasMatch Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptAliasMatch Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptLog DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptLog Description Syntax: ScriptLog filename Default: none Context: server config Status: mod_cgi The ScriptLog directive sets the CGI script error logfile. If no ScriptLog is given, no error log is created. If given, any CGI errors are logged into the filename given as argument. If this is a relative file or path it is taken relative to the server root. This log will be opened as the user the child processes run as, ie. the user specified in the main User directive. This means that either the directory the script log is in needs to be writable by that user or the file needs to be manually created and set to be writable by that user. If you place the script log in your main logs directory, do NOT change the directory permissions to make it writable by the user the child processes run as. Note that script logging is meant to be a debugging feature when writing CGI scripts, and is not meant to be activated continuously on running servers. It is not optimized for speed or efficiency, and may have security problems if used in a manner other than that for which it was designed. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptLog Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptLog Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptLogBuffer DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptLogBuffer Description Syntax: ScriptLogBuffer size Default: 1024 Context: server config Status: mod_cgi The size of any PUT or POST entity body that is logged to the file is limited, to prevent the log file growing too big too quickly if large bodies are being received. By default, up to 1024 bytes are logged, but this can be changed with this directive. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptLogBuffer Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptLogBuffer Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptLogLength DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptLogLength Description Syntax: ScriptLogLength size Default: 10385760 Context: server config Status: mod_cgi ScriptLogLength can be used to limit the size of the CGI script logfile. Since the logfile logs a lot of information per CGI error (all request headers, all script output) it can grow to be a big file. To prevent problems due to unbounded growth, this directive can be used to set an maximum file-size for the CGI logfile. If the file exceeds this size, no more information will be written to it. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptLogLength Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptLogLength Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SendBufferSize DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SendBufferSize Description Syntax: SendBufferSize bytes Context: server config Status: core The server will set the TCP buffer size to the number of bytes specified. Very useful to increase past standard OS defaults on high speed high latency (i.e., 100ms or so, such as transcontinental fast pipes) DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SendBufferSize Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SendBufferSize Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerAdmin DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerAdmin Description Syntax: ServerAdmin email-address Context: server config, virtual host Status: core The ServerAdmin sets the e-mail address that the server includes in any error messages it returns to the client. It may be worth setting up a dedicated address for this, e.g. ServerAdmin www-admin@foo.bar.com as users do not always mention that they are talking about the server! DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerAdmin Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerAdmin Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerAlias DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerAlias Description Syntax: ServerAlias host1 host2 ... Context: virtual host Status: core Compatibility: ServerAlias is only available in Apache 1.1 and later. The ServerAlias directive sets the alternate names for a host, for use with name-based virtual hosts. See also: Apache Virtual Host documentation DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerAlias Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerAlias Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerName DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerName Description Syntax: ServerName fully-qualified domain name Context: server config, virtual host Status: core The ServerName directive sets the hostname of the server; this is only used when creating redirection URLs. If it is not specified, then the server attempts to deduce it from its own IP address; however this may not work reliably, or may not return the preferred hostname. For example: ServerName www.wibble.com would be used if the canonical (main) name of the actual machine were monster.wibble.com. See Also: DNS Issues UseCanonicalName DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerName Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerName Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerPath DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerPath Description Syntax: ServerPath pathname Context: virtual host Status: core Compatibility: ServerPath is only available in Apache 1.1 and later. The ServerPath directive sets the legacy URL pathname for a host, for use with name-based virtual hosts. See also: Apache Virtual Host documentation DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerPath Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerPath Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerRoot DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerRoot Description Syntax: ServerRoot directory-filename Default: ServerRoot /usr/local/apache Context: server config Status: core The ServerRoot directive sets the directory in which the server lives. Typically it will contain the subdirectories conf/ and logs/. Relative paths for other configuration files are taken as relative to this directory. See also the -d option to httpd. See also the security tips for information on how to properly set permissions on the ServerRoot. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerRoot Default REG_SZ /usr/local/apache DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerRoot Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerSignature DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerSignature Description Syntax: ServerSignature Off | On | EMail Default: ServerSignature Off Context: server config, virtual host, directory, .htaccess Status: core Compatibility: ServerSignature is only available in Apache 1.3 and later. The ServerSignature directive allows the configuration of a trailing footer line under server-generated documents (error messages, mod_proxy ftp directory listings, mod_info output, ...). The reason why you would want to enable such a footer line is that in a chain of proxies, the user often has no possibility to tell which of the chained servers actually produced a returned error message. The Off setting, which is the default, suppresses the error line (and is therefore compatible with the behavior of Apache-1.2 and below). The On setting simply adds a line with the server version number and ServerName of the serving virtual host, and the EMail setting additionally creates a "mailto:" reference to the ServerAdmin of the referenced document. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerSignature Default REG_SZ Off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerSignature Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerTokens DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerTokens Description Syntax: ServerTokens Minimal|OS|Full Default: ServerTokens Full Context: server config Status: core Compatibility: ServerTokens is only available in Apache 1.3 and later This directive controls whether Server response header field which is sent back to clients includes a description of the generic OS-type of the server as well as information about compiled-in modules. ServerTokens Min[imal] Server sends (e.g.): Server: Apache/1.3.0 ServerTokens OS Server sends (e.g.): Server: Apache/1.3.0 (Unix) ServerTokens Full (or not specified) Server sends (e.g.): Server: Apache/1.3.0 (Unix) PHP/3.0 MyMod/1.2 This setting applies to the entire server, and cannot be enabled or disabled on a virtualhost-by-virtualhost basis. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerTokens Default REG_SZ Full DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerTokens Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerType DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerType Description Syntax: ServerType type Default: ServerType standalone Context: server config Status: core The ServerType directive sets how the server is executed by the system. Type is one of inetd The server will be run from the system process inetd; the command to start the server is added to /etc/inetd.conf standalone The server will run as a daemon process; the command to start the server is added to the system startup scripts. (/etc/rc.local or /etc/rc3.d/....) Inetd is the lesser used of the two options. For each http connection received, a new copy of the server is started from scratch; after the connection is complete, this program exits. There is a high price to pay per connection, but for security reasons, some admins prefer this option. Inetd mode is no longer recommended and does not always work properly. Avoid it if at all possible. Standalone is the most common setting for ServerType since it is far more efficient. The server is started once, and services all subsequent connections. If you intend running Apache to serve a busy site, standalone will probably be your only option. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerType Default REG_SZ standalone DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerType Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetEnv DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetEnv Description Syntax: SetEnv variable value Context: server config, virtual host Status: Base Module: mod_env Compatibility: SetEnv is only available in Apache 1.1 and later. Sets an environment variable, which is then passed on to CGI scripts. Example: SetEnv SPECIAL_PATH /foo/bin DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetEnv Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetEnv Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetEnvIf DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetEnvIf Description Syntax: SetEnvIf attribute regex envar[=value] [...] Default: none Context: server config Override: none Status: Base Module: mod_setenvif Compatibility: Apache 1.3 and above The SetEnvIf directive defines environment variables based on attributes of the request. These attributes can be the values of various HTTP request header fields (see RFC2068 for more information about these), or of other aspects of the request, including the following: * Remote_Host - the hostname (if available) of the client making the request * Remote_Addr - the IP address of the client making the request * Remote_User - the authenticated username (if available) * Request_Method - the name of the method being used (GET, POST, et cetera) * Request_URI - the portion of the URL following the scheme and host portion Some of the more commonly used request header field names include Host, User-Agent, and Referer. Example: SetEnvIf Request_URI "\.(gif)|(jpg)|(xbm)$" object_is_image SetEnvIf Referer www\.mydomain\.com intra_site_referral The first will set the envariable object_is_image if the request was for an image file, and the second sets intra_site_referral if the referring page was somewhere on the www.mydomain.com Web site. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetEnvIf Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetEnvIf Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetEnvIfNoCase DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetEnvIfNoCase Description Syntax: SetEnvIfNoCase attribute regex envar[=value] [...] Default: none Context: server config Override: none Status: Base Module: mod_setenvif Compatibility: Apache 1.3 and above The SetEnvIfNoCase is semantically identical to the SetEnvIf directive, and differs only in that the regular expression matching is performed in a case-insensitive manner. For example: SetEnvIfNoCase Host Apache\.Org site=apache This will cause the site envariable to be set to "apache" if the HTTP request header field Host: was included and contained Apache.Org, apache.org, or any other combination. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetEnvIfNoCase Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetEnvIfNoCase Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetHandler DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetHandler Description Syntax: SetHandler handler-name Context: directory, .htaccess Status: Base Module: mod_mime Compatibility: SetHandler is only available in Apache 1.1 and later. When placed into an .htaccess file or a <Directory> or <Location> section, this directive forces all matching files to be parsed through the handler given by handler-name. For example, if you had a directory you wanted to be parsed entirely as imagemap rule files, regardless of extension, you might put the following into an .htaccess file in that directory: SetHandler imap-file Another example: if you wanted to have the server display a status report whenever a URL of http://servername/status was called, you might put the following into access.conf: <Location /status> SetHandler server-status </Location> DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetHandler Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SetHandler Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\srm.conf DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\srm.conf Description REG_SZ With this document, you define the name space that users see of your http server. This file also defines server settings which affect how requests are serviced, and how results should be formatted.d. DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\srm.conf Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\srm.conf Parent REG_DWORD 2 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\StartServers DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\StartServers Description Syntax: StartServers number Default: StartServers 5 Context: server config Status: core The StartServers directive sets the number of child server processes created on startup. As the number of processes is dynamically controlled depending on the load, there is usually little reason to adjust this parameter. When running under Microsoft Windows, this directive has no effect. There is always one child which handles all requests. Within the child requests are handled by separate threads. The ThreadsPerChild directive controls the maximum number of child threads handling requests, which will have a similar effect to the setting of StartServers on Unix. See also MinSpareServers and MaxSpareServers. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\StartServers Default REG_SZ 5 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\StartServers Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ThreadsPerChild DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ThreadsPerChild Description Syntax: ThreadsPerChild number Default: ThreadsPerChild 50 Context: server config Status: core (Windows) Compatibility: Available only with Apache 1.3 and later with Windows This directive tells the server how many threads it should use. This is the maximum number of connections the server can handle at once; be sure and set this number high enough for your site if you get a lot of hits. This directive has no effect on Unix systems. Unix users should look at StartServers and MaxRequestsPerChild. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ThreadsPerChild Default REG_SZ 50 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ThreadsPerChild Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\TimeOut DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\TimeOut Description Syntax: TimeOut number Default: TimeOut 300 Context: server config Status: core The TimeOut directive currently defines the amount of time Apache will wait for three things: 1. The total amount of time it takes to receive a GET request. 2. The amount of time between receipt of TCP packets on a POST or PUT request. 3. The amount of time between ACKs on transmissions of TCP packets in responses. We plan on making these separately configurable at some point down the road. The timer used to default to 1200 before 1.2, but has been lowered to 300 which is still far more than necessary in most situations. It is not set any lower by default because there may still be odd places in the code where the timer is not reset when a packet is sent. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\TimeOut Default REG_SZ 300 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\TimeOut Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\TransferLog DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\TransferLog Description Syntax: TransferLog file-pipe Default: none Context: server config, virtual host Status: Base Module: mod_log_config The TransferLog directive adds a log file in the format defined by the most recent LogFormat directive, or Common Log Format if no other default format has been specified. File-pipe is one of A filename A filename relative to the ServerRoot. `|' followed by a command A program to receive the agent log information on its standard input. Note the a new program will not be started for a VirtualHost if it inherits the TransferLog from the main server. Security: if a program is used, then it will be run under the user who started httpd. This will be root if the server was started by root; be sure that the program is secure. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\TransferLog Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\TransferLog Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\TypesConfig DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\TypesConfig Description Syntax: TypesConfig filename Default: TypesConfig conf/mime.types Context: server config Status: Base Module: mod_mime The TypesConfig directive sets the location of the mime types configuration file. Filename is relative to the ServerRoot. This file sets the default list of mappings from filename extensions to content types; changing this file is not recommended. Use the AddType directive instead. The file contains lines in the format of the arguments to an AddType command: MIME-type extension extension ... The extensions are lower-cased. Blank lines, and lines beginning with a hash character (`#') are ignored. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\TypesConfig Default REG_SZ conf/mime.types DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\TypesConfig Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\UnsetEnv DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\UnsetEnv Description Syntax: UnsetEnv variable variable ... Context: server config, virtual host Status: Base Module: mod_env Compatibility: UnsetEnv is only available in Apache 1.1 and later. Removes one or more environment variables from those passed on to CGI scripts. Example: UnsetEnv LD_LIBRARY_PATH DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\UnsetEnv Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\UnsetEnv Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\UseCanonicalName DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\UseCanonicalName Description Syntax: UseCanonicalName on|off Default: UseCanonicalName on Context: server config, virtual host, directory, .htaccess Override: AuthConfig Compatibility: UseCanonicalName is only available in Apache 1.3 and later In many situations Apache has to construct a self-referential URL. That is, a URL which refers back to the same server. With UseCanonicalName on (and in all versions prior to 1.3) Apache will use the ServerName and Port directives to construct a canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name). These values are the same that are used to implement name based virtual hosts, and are available with the same clients. The CGI variables SERVER_NAME and SERVER_PORT will be constructed from the client supplied values as well. An example where this may be useful is on an intranet server where you have users connecting to the machine using short names such as www. You'll notice that if the users type a shortname, and a URL which is a directory, such as http://www/splat, without the trailing slash then Apache will redirect them to http://www.domain.com/splat/. If you have authentication enabled, this will cause the user to have to reauthenticate twice (once for www and once again for www.domain.com). But if UseCanonicalName is set off, then Apache will redirect to http://www/splat/. Warning: if CGIs make assumptions about the values of SERVER_NAME they may be broken by this option. The client is essentially free to give whatever value they want as a hostname. But if the CGI is only using SERVER_NAME to construct self-referential URLs then it should be just fine. See also: ServerName, Port DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\UseCanonicalName Default REG_SZ on DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\UseCanonicalName Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\User DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\User Description Syntax: User unix-userid Default: User #-1 Context: server config, virtual host Status: core The User directive sets the userid as which the server will answer requests. In order to use this directive, the standalone server must be run initially as root. Unix-userid is one of: A username Refers to the given user by name. # followed by a user number. Refers to a user by their number. The user should have no privileges which result in it being able to access files which are not intended to be visible to the outside world, and similarly, the user should not be able to execute code which is not meant for httpd requests. It is recommended that you set up a new user and group specifically for running the server. Some admins use user nobody, but this is not always possible or desirable. For example mod_proxy's cache, when enabled, must be accessible to this user (see the CacheRoot directive). Notes: If you start the server as a non-root user, it will fail to change to the lesser privileged user, and will instead continue to run as that original user. If you do start the server as root, then it is normal for the parent process to remain running as root. Special note: Use of this directive in <VirtualHost> requires a properly configured suEXEC wrapper. When used inside a <VirtualHost> in this manner, only the user that CGIs are run as is affected. Non-CGI requests are still processed with the user specified in the main User directive. SECURITY: Don't set User (or Group) to root unless you know exactly what you are doing, and what the dangers are. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\User Default REG_SZ #-1 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\User Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\UserDir DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\UserDir Description Syntax: UserDir directory/filename Default: UserDir public_html Context: server config, virtual host Status: Base Module: mod_userdir Compatibility: All forms except the UserDir public_html form are only available in Apache 1.1 or above. Use of the enabled keyword, or disabled with a list of usernames, is only available in Apache 1.3 and above. The UserDir directive sets the real directory in a user's home directory to use when a request for a document for a user is received. Directory/filename is one of the following: * The name of a directory or a pattern such as those shown below. * The keyword disabled. This turns off all username-to-directory translations except those explicitly named with the enabled keyword (see below). * The keyword disabled followed by a space-delimited list of usernames. Usernames that appear in such a list will never have directory translation performed, even if they appear in an enabled clause. * The keyword enabled followed by a space-delimited list of usernames. These usernames will have directory translation performed even if a global disable is in effect, but not if they also appear in a disabled clause. If neither the enabled nor the disabled keywords appear in the Userdir directive, the argument is treated as a filename pattern, and is used to turn the name into a directory specification. A request for http://www.foo.com/~bob/one/two.html will be translated to: UserDir public_html -> ~bob/public_html/one/two.html UserDir /usr/web -> /usr/web/bob/one/two.html UserDir /home/*/www -> /home/bob/www/one/two.html The following directives will send redirects to the client: UserDir http://www.foo.com/users -> http://www.foo.com/users/bob/one/two.html UserDir http://www.foo.com/*/usr -> http://www.foo.com/bob/usr/one/two.html UserDir http://www.foo.com/~*/ -> http://www.foo.com/~bob/one/two.html Be careful when using this directive; for instance, "UserDir ./" would map "/~root" to "/" - which is probably undesirable. If you are running Apache 1.3 or above, it is strongly recommended that your configuration include a "UserDir disabled root" declaration. See also the <Directory> directive and the Security Tips page for more information. DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\UserDir Default REG_SZ public_html DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\UserDir Parent REG_DWORD 0 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\VirtualHost DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\VirtualHost Description Syntax: <VirtualHost addr[:port] ...> ... </VirtualHost> Context: server config Status: Core. Compatibility: Non-IP address-based Virtual Hosting only available in Apache 1.1 and later. Compatibility: Multiple address support only available in Apache 1.2 and later. <VirtualHost> and </VirtualHost> are used to enclose a group of directives which will apply only to a particular virtual host. Any directive which is allowed in a virtual host context may be used. When the server receives a request for a document on a particular virtual host, it uses the configuration directives enclosed in the <VirtualHost> section. Addr can be * The IP address of the virtual host * A fully qualified domain name for the IP address of the virtual host. Example: <VirtualHost 10.1.2.3> ServerAdmin webmaster@host.foo.com DocumentRoot /www/docs/host.foo.com ServerName host.foo.com ErrorLog logs/host.foo.com-error_log TransferLog logs/host.foo.com-access_log </VirtualHost> Each VirtualHost must correspond to a different IP address, different port number or a different host name for the server, in the latter case the server machine must be configured to accept IP packets for multiple addresses. (If the machine does not have multiple network interfaces, then this can be accomplished with the ifconfig alias command (if your OS supports it), or with kernel patches like VIF (for SunOS(TM) 4.1.x)). The special name _default_ can be specified in which case this virtual host will match any IP address that is not explicitly listed in another virtual host. In the absence of any _default_ virtual host the "main" server config, consisting of all those definitions outside any VirtualHost section, is used when no match occurs. You can specify a :port to change the port that is matched. If unspecified then it defaults to the same port as the most recent Port statement of the main server. You may also specify :* to match all ports on that address. (This is recommended when used with _default_.) SECURITY: See the security tips document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server. NOTE: The use of <VirtualHost> does not affect what addresses Apache listens on. You may need to ensure that Apache is listening on the correct addresses using either BindAddress or Listen. See also: Apache Virtual Host documentation See also: Warnings about DNS and Apache See also: Setting which addresses and ports Apache uses See also: How Directory, Location and Files sections work for an explanation of how these different sections are combined when a request is received DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\VirtualHost Default REG_SZ DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\VirtualHost Parent REG_DWORD 1 DSTSetup:RegistryKey HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\XBitHack DSTSetup:RegistryStringStart HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\XBitHack Description Syntax: XBitHack status Default: XBitHack off Context: server config, virtual host, directory, .htaccess Override: Options Status: Base Module: mod_include The XBitHack directives controls the parsing of ordinary html documents. This directive only affects files associated with the MIME type text/html. Status can have the following values: off No special treatment of executable files. on Any file that has the user-execute bit set will be treated as a server-parsed html document. full As for on but also test the group-execute bit. If it is set, then set the Last-modified date of the returned file to be the last modified time of the file. If it is not set, then no last-modified date is sent. Setting this bit allows clients and proxies to cache the result of the request. Note: you would not want to use this, for example, when you #include a CGI that produces different output on each hit (or potentially depends on the hit). DSTSetup:RegistryStringEnd DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\XBitHack Default REG_SZ off DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\XBitHack Parent REG_DWORD 0 // // Add the template values // DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AccessConfig Template REG_DWORD 123 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AgentLog Template REG_DWORD 123 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_Authoritative Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_LogEmail Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_MustGiveEmail Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_NoUserID Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Anonymous_VerifyEmail Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthAuthoritative Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBAuthoritative Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\AuthDBMAuthoritative Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheDefaultExpire Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheGcInterval Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheMaxExpire Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheRoot Template REG_DWORD 123 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CacheSize Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CheckSpelling Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ContentDigest Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CookieTracking Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\CoreDumpDirectory Template REG_DWORD 123 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Directory Template REG_DWORD 123 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\DocumentRoot Template REG_DWORD 123 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ExpiresActive Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\FancyIndexing Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\httpd.conf Template REG_DWORD 124 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\IdentityCheck Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\KeepAlive Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\KeepAliveTimeout Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxClients Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxKeepAliveRequests Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxRequestsPerChild Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MaxSpareServers Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MetaFiles Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\MinSpareServers Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Port Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ProxyRequests Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteEngine Template REG_DWORD 119 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\RewriteLogLevel Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ScriptLogBuffer Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\SendBufferSize Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerPath Template REG_DWORD 123 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ServerRoot Template REG_DWORD 123 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\srm.conf Template REG_DWORD 124 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\StartServers Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\ThreadsPerChild Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\Timeout Template REG_DWORD 120 DSTSetup:RegistryValue HKEY_LOCAL_MACHINE\SOFTWARE\DarkStar\ApacheConfig\Templates\UseCanonicalName Template REG_DWORD 119